content/docs/spark/2.1.1/spark-streaming-twitter/index.html - bahir-website - Git at Google



 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <title>Spark Streaming Twitter</title>
     <meta name="description" content="Spark Streaming Twitter">
     <meta name="author" content="">

     <!-- Enable responsive viewport -->
     <meta name="viewport" content="width=device-width, initial-scale=1.0">

     <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
     <!--[if lt IE 9]>
       <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->

     <!-- Le styles -->
     <link href="/assets/themes/apache-clean/bootstrap/css/bootstrap.css" rel="stylesheet">
     <link href="/assets/themes/apache-clean/css/style.css?body=1" rel="stylesheet" type="text/css">
     <link href="/assets/themes/apache-clean/css/syntax.css" rel="stylesheet"  type="text/css" media="screen" />
     <!-- Le fav and touch icons -->
     <!-- Update these with your own images
     <link rel="shortcut icon" href="images/favicon.ico">
     <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
     <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
     <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
   -->

     <!-- make tables sortable by adding class tag "sortable" to table elements -->
     <script src="/js/sorttable.js"></script>


   </head>

   <body>


 <!-- Navigation -->
 <div id="nav-bar">
   <nav id="nav-container" class="navbar navbar-inverse " role="navigation">
     <div class="container">
       <!-- Brand and toggle get grouped for better mobile display -->

       <div class="navbar-header page-scroll">
         <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
           <span class="sr-only">Toggle navigation</span>
           <span class="icon-bar"></span>
           <span class="icon-bar"></span>
           <span class="icon-bar"></span>
         </button>
         <a class="navbar-brand page-scroll" href="/#home">Home</a>
       </div>
       <!-- Collect the nav links, forms, and other content for toggling -->
       <nav class="navbar-collapse collapse" role="navigation">
         <ul class="nav navbar-nav">


           <li id="download">

             <a href="#" data-toggle="dropdown" class="dropdown-toggle">Download<b class="caret"></b></a>
             <ul class="dropdown-menu dropdown-left">


               <li><a href="/downloads/spark" target="_self">Bahir Spark Extensions</a></li>


               <li><a href="/downloads/flink" target="_self">Bahir Flink Extensions</a></li>

             </ul>

           </li>


           <li id="community">

             <a href="#" data-toggle="dropdown" class="dropdown-toggle">Community<b class="caret"></b></a>
             <ul class="dropdown-menu dropdown-left">


               <li><a href="/community" target="_self">Get Involved</a></li>


               <li><a href="/contributing" target="_self">Contributing</a></li>


               <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li>


               <li><a href="https://issues.apache.org/jira/browse/BAHIR" target="_blank">Issue Tracker</a></li>


               <li><a href="/community#source-code" target="_self">Source Code</a></li>


               <li><a href="/community-members" target="_self">Project Committers</a></li>

             </ul>

           </li>


           <li id="documentation">

             <a href="#" data-toggle="dropdown" class="dropdown-toggle">Documentation<b class="caret"></b></a>
             <ul class="dropdown-menu dropdown-left">


               <li><a href="/docs/spark/overview" target="_self">Bahir Spark Extensions</a></li>


               <li><a href="/docs/flink/overview" target="_self">Bahir Flink Extensions</a></li>

             </ul>

           </li>


           <li id="github">

             <a href="#" data-toggle="dropdown" class="dropdown-toggle">GitHub<b class="caret"></b></a>
             <ul class="dropdown-menu dropdown-left">


               <li><a href="https://github.com/apache/bahir" target="_blank">Bahir Spark Extensions</a></li>


               <li><a href="https://github.com/apache/bahir-flink" target="_blank">Bahir Flink Extensions</a></li>


               <li><a href="https://github.com/apache/bahir-website" target="_blank">Bahir Website</a></li>

             </ul>

           </li>


           <li id="apache">

             <a href="#" data-toggle="dropdown" class="dropdown-toggle">Apache<b class="caret"></b></a>
             <ul class="dropdown-menu dropdown-left">


               <li><a href="http://www.apache.org/foundation/how-it-works.html" target="_blank">Apache Software Foundation</a></li>


               <li><a href="http://www.apache.org/licenses/" target="_blank">Apache License</a></li>


               <li><a href="http://www.apache.org/foundation/sponsorship" target="_blank">Sponsorship</a></li>


               <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>


               <li><a href="/privacy-policy" target="_self">Privacy Policy</a></li>

             </ul>

           </li>


         </ul>
       </nav><!--/.navbar-collapse -->
       <!-- /.navbar-collapse -->
     </div>
     <!-- /.container -->
   </nav>
 </div>


     <div class="container">


 <!--<div class="hero-unit Spark Streaming Twitter">
   <h1></h1>
 </div>
 -->

 <div class="row">
   <div class="col-md-12">
     <!--

 -->

 <p>A library for reading social data from <a href="http://twitter.com/">twitter</a> using Spark Streaming.</p>

 <h2 id="linking">Linking</h2>

 <p>Using SBT:</p>

 <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>libraryDependencies += "org.apache.bahir" %% "spark-streaming-twitter" % "2.1.1"
 </code></pre></div></div>

 <p>Using Maven:</p>

 <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>&lt;dependency&gt;
     &lt;groupId&gt;org.apache.bahir&lt;/groupId&gt;
     &lt;artifactId&gt;spark-streaming-twitter_2.11&lt;/artifactId&gt;
     &lt;version&gt;2.1.1&lt;/version&gt;
 &lt;/dependency&gt;
 </code></pre></div></div>

 <p>This library can also be added to Spark jobs launched through <code class="language-plaintext highlighter-rouge">spark-shell</code> or <code class="language-plaintext highlighter-rouge">spark-submit</code> by using the <code class="language-plaintext highlighter-rouge">--packages</code> command line option.
 For example, to include it when starting the spark shell:</p>

 <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ bin/spark-shell --packages org.apache.bahir:spark-streaming-twitter_2.11:2.1.1
 </code></pre></div></div>

 <p>Unlike using <code class="language-plaintext highlighter-rouge">--jars</code>, using <code class="language-plaintext highlighter-rouge">--packages</code> ensures that this library and its dependencies will be added to the classpath.
 The <code class="language-plaintext highlighter-rouge">--packages</code> argument can also be used with <code class="language-plaintext highlighter-rouge">bin/spark-submit</code>.</p>

 <p>This library is cross-published for Scala 2.10 and Scala 2.11, so users should replace the proper Scala version (2.10 or 2.11) in the commands listed above.</p>

 <h2 id="examples">Examples</h2>

 <p><code class="language-plaintext highlighter-rouge">TwitterUtils</code> uses Twitter4j to get the public stream of tweets using <a href="https://dev.twitter.com/docs/streaming-apis">Twitter’s Streaming API</a>. Authentication information
 can be provided by any of the <a href="http://twitter4j.org/en/configuration.html">methods</a> supported by Twitter4J library. You can import the <code class="language-plaintext highlighter-rouge">TwitterUtils</code> class and create a DStream with <code class="language-plaintext highlighter-rouge">TwitterUtils.createStream</code> as shown below.</p>

 <h3 id="scala-api">Scala API</h3>

 <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>import org.apache.spark.streaming.twitter._

 TwitterUtils.createStream(ssc, None)
 </code></pre></div></div>

 <h3 id="java-api">Java API</h3>

 <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>import org.apache.spark.streaming.twitter.*;

 TwitterUtils.createStream(jssc);
 </code></pre></div></div>

 <p>You can also either get the public stream, or get the filtered stream based on keywords.
 See end-to-end examples at <a href="https://github.com/apache/bahir/tree/master/streaming-twitter/examples">Twitter Examples</a></p>

   </div>
 </div>


       <hr>

       <!-- <p>&copy; 2021 </p>-->
       <footer class="site-footer">
     <div class="wrapper">
         <div class="footer-col-wrapper">

             <div style="text-align:center;">

                 <div>
                     Copyright &copy; 2016-<script>document.write(new Date().getFullYear());</script> <a href="http://www.apache.org">The Apache Software Foundation</a>.
                     Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
                     <br>

                     Apache and the Apache Feather logo are trademarks of The Apache Software Foundation.

                 </div>
             </div>
         </div>
     </div>
 </footer>

     </div>


     <script src="/assets/themes/apache-clean/jquery/jquery-2.1.1.min.js"></script>

     <script src="/assets/themes/apache-clean/bootstrap/js/bootstrap.min.js"></script>


   </body>
 </html>


	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>Spark Streaming Twitter</title>
	<meta name="description" content="Spark Streaming Twitter">
	<meta name="author" content="">

	<!-- Enable responsive viewport -->
	<meta name="viewport" content="width=device-width, initial-scale=1.0">

	<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
	<!--[if lt IE 9]>
	<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->

	<!-- Le styles -->
	<link href="/assets/themes/apache-clean/bootstrap/css/bootstrap.css" rel="stylesheet">
	<link href="/assets/themes/apache-clean/css/style.css?body=1" rel="stylesheet" type="text/css">
	<link href="/assets/themes/apache-clean/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
	<!-- Le fav and touch icons -->
	<!-- Update these with your own images
	<link rel="shortcut icon" href="images/favicon.ico">
	<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
	<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
	<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
	-->

	<!-- make tables sortable by adding class tag "sortable" to table elements -->
	<script src="/js/sorttable.js"></script>


	</head>

	<body>



	<!-- Navigation -->
	<div id="nav-bar">
	<nav id="nav-container" class="navbar navbar-inverse " role="navigation">
	<div class="container">
	<!-- Brand and toggle get grouped for better mobile display -->

	<div class="navbar-header page-scroll">
	<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a class="navbar-brand page-scroll" href="/#home">Home</a>
	</div>
	<!-- Collect the nav links, forms, and other content for toggling -->
	<nav class="navbar-collapse collapse" role="navigation">
	<ul class="nav navbar-nav">



	<li id="download">

	<a href="#" data-toggle="dropdown" class="dropdown-toggle">Download<b class="caret"></b></a>
	<ul class="dropdown-menu dropdown-left">


	<li><a href="/downloads/spark" target="_self">Bahir Spark Extensions</a></li>


	<li><a href="/downloads/flink" target="_self">Bahir Flink Extensions</a></li>

	</ul>

	</li>




	<li id="community">

	<a href="#" data-toggle="dropdown" class="dropdown-toggle">Community<b class="caret"></b></a>
	<ul class="dropdown-menu dropdown-left">


	<li><a href="/community" target="_self">Get Involved</a></li>


	<li><a href="/contributing" target="_self">Contributing</a></li>


	<li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li>


	<li><a href="https://issues.apache.org/jira/browse/BAHIR" target="_blank">Issue Tracker</a></li>


	<li><a href="/community#source-code" target="_self">Source Code</a></li>


	<li><a href="/community-members" target="_self">Project Committers</a></li>

	</ul>

	</li>




	<li id="documentation">

	<a href="#" data-toggle="dropdown" class="dropdown-toggle">Documentation<b class="caret"></b></a>
	<ul class="dropdown-menu dropdown-left">


	<li><a href="/docs/spark/overview" target="_self">Bahir Spark Extensions</a></li>


	<li><a href="/docs/flink/overview" target="_self">Bahir Flink Extensions</a></li>

	</ul>

	</li>




	<li id="github">

	<a href="#" data-toggle="dropdown" class="dropdown-toggle">GitHub<b class="caret"></b></a>
	<ul class="dropdown-menu dropdown-left">


	<li><a href="https://github.com/apache/bahir" target="_blank">Bahir Spark Extensions</a></li>


	<li><a href="https://github.com/apache/bahir-flink" target="_blank">Bahir Flink Extensions</a></li>


	<li><a href="https://github.com/apache/bahir-website" target="_blank">Bahir Website</a></li>

	</ul>

	</li>




	<li id="apache">

	<a href="#" data-toggle="dropdown" class="dropdown-toggle">Apache<b class="caret"></b></a>
	<ul class="dropdown-menu dropdown-left">


	<li><a href="http://www.apache.org/foundation/how-it-works.html" target="_blank">Apache Software Foundation</a></li>


	<li><a href="http://www.apache.org/licenses/" target="_blank">Apache License</a></li>


	<li><a href="http://www.apache.org/foundation/sponsorship" target="_blank">Sponsorship</a></li>


	<li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>


	<li><a href="/privacy-policy" target="_self">Privacy Policy</a></li>

	</ul>

	</li>


	</ul>
	</nav><!--/.navbar-collapse -->
	<!-- /.navbar-collapse -->
	</div>
	<!-- /.container -->
	</nav>
	</div>


	<div class="container">



	<!--<div class="hero-unit Spark Streaming Twitter">
	<h1></h1>
	</div>
	-->

	<div class="row">
	<div class="col-md-12">
	<!--

	-->

	<p>A library for reading social data from <a href="http://twitter.com/">twitter</a> using Spark Streaming.</p>

	<h2 id="linking">Linking</h2>

	<p>Using SBT:</p>

	<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>libraryDependencies += "org.apache.bahir" %% "spark-streaming-twitter" % "2.1.1"
	</code></pre></div></div>

	<p>Using Maven:</p>

	<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><dependency>
	<groupId>org.apache.bahir</groupId>
	<artifactId>spark-streaming-twitter_2.11</artifactId>
	<version>2.1.1</version>
	</dependency>
	</code></pre></div></div>

	<p>This library can also be added to Spark jobs launched through <code class="language-plaintext highlighter-rouge">spark-shell</code> or <code class="language-plaintext highlighter-rouge">spark-submit</code> by using the <code class="language-plaintext highlighter-rouge">--packages</code> command line option.
	For example, to include it when starting the spark shell:</p>

	<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ bin/spark-shell --packages org.apache.bahir:spark-streaming-twitter_2.11:2.1.1
	</code></pre></div></div>

	<p>Unlike using <code class="language-plaintext highlighter-rouge">--jars</code>, using <code class="language-plaintext highlighter-rouge">--packages</code> ensures that this library and its dependencies will be added to the classpath.
	The <code class="language-plaintext highlighter-rouge">--packages</code> argument can also be used with <code class="language-plaintext highlighter-rouge">bin/spark-submit</code>.</p>

	<p>This library is cross-published for Scala 2.10 and Scala 2.11, so users should replace the proper Scala version (2.10 or 2.11) in the commands listed above.</p>

	<h2 id="examples">Examples</h2>

	<p><code class="language-plaintext highlighter-rouge">TwitterUtils</code> uses Twitter4j to get the public stream of tweets using <a href="https://dev.twitter.com/docs/streaming-apis">Twitter’s Streaming API</a>. Authentication information
	can be provided by any of the <a href="http://twitter4j.org/en/configuration.html">methods</a> supported by Twitter4J library. You can import the <code class="language-plaintext highlighter-rouge">TwitterUtils</code> class and create a DStream with <code class="language-plaintext highlighter-rouge">TwitterUtils.createStream</code> as shown below.</p>

	<h3 id="scala-api">Scala API</h3>

	<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>import org.apache.spark.streaming.twitter._

	TwitterUtils.createStream(ssc, None)
	</code></pre></div></div>

	<h3 id="java-api">Java API</h3>

	<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>import org.apache.spark.streaming.twitter.*;

	TwitterUtils.createStream(jssc);
	</code></pre></div></div>

	<p>You can also either get the public stream, or get the filtered stream based on keywords.
	See end-to-end examples at <a href="https://github.com/apache/bahir/tree/master/streaming-twitter/examples">Twitter Examples</a></p>

	</div>
	</div>



	<hr>

	<!-- <p>© 2021 </p>-->
	<footer class="site-footer">
	<div class="wrapper">
	<div class="footer-col-wrapper">

	<div style="text-align:center;">

	<div>
	Copyright © 2016-<script>document.write(new Date().getFullYear());</script> <a href="http://www.apache.org">The Apache Software Foundation</a>.
	Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
	<br>

	Apache and the Apache Feather logo are trademarks of The Apache Software Foundation.

	</div>
	</div>
	</div>
	</div>
	</footer>

	</div>







	<script src="/assets/themes/apache-clean/jquery/jquery-2.1.1.min.js"></script>

	<script src="/assets/themes/apache-clean/bootstrap/js/bootstrap.min.js"></script>


	</body>
	</html>