... | ... | @@ -31,10 +31,65 @@ tap |
|
|
tap -h
|
|
|
```
|
|
|
|
|
|
### Executing a query ###
|
|
|
```bash
|
|
|
tap search -h
|
|
|
```
|
|
|
|
|
|
```bash
|
|
|
tap stream -h
|
|
|
```
|
|
|
|
|
|
### Executing a query with the search API ###
|
|
|
|
|
|
To execute a query you must provide a **query**, the **consumer secret** and either the **consumer key** or the access token. Consumer key and secret can be obtained at the http://apps.twitter.com/ website, while the access token will be obtained when first connecting with the key and secret.
|
|
|
|
|
|
```bash
|
|
|
tap --consumer-key CONSUMERKEY --consumer-secret CONSUMERSECRET -q "miley cyrus" -v DEBUG
|
|
|
tap search --consumer-key CONSUMERKEY --consumer-secret CONSUMERSECRET -q "miley cyrus" -v DEBUG
|
|
|
```
|
|
|
|
|
|
Search options:
|
|
|
|
|
|
| Option | Description |
|
|
|
|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
| --query | A UTF-8 search query of 1,000 characters maximum, including operators. Queries may additionally be limited by complexity. Information on how to construct a query is available at https://dev.twitter.com/docs/using-search |
|
|
|
| --geocode | Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by "latitude,longitude,radius", where radius units must be specified as either "mi" (miles) or "km" (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct "sub-regions" will be considered when using the radius modifier. Example value: 37.781157,-122.398720,1mi |
|
|
|
| --lang | Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is best-effort. Example value: eu |
|
|
|
| --result-type | Specifies what type of search results you would prefer to receive. The current default is "mixed". Valid values include: "mixed" - Include both popular and real time results in the response. "recent" - return only the most recent results in the response. "popular" - return only the most popular results in the response. |
|
|
|
| --wait | Mandatory sleep time before executing a query. The default value is 2, which should ensure that the rate limit of 450 per 15 minutes is never reached. |
|
|
|
| --clean | Set this switch to use a clean since_id. |
|
|
|
| --consumer-key | The consumer key that you obtain when you create an app at https://apps.twitter.com/ |
|
|
|
| --consumer-secret | The consumer secret that you obtain when you create an app at https://apps.twitter.com/ |
|
|
|
| --access-token | You can use consumer_key and access_token instead of consumer_key and consumer_secret. This will make authentication faster, as the token will not be fetched. The access token will be printed to the standard output when connecting with the consumer_key and consumer_secret. |
|
|
|
| --db | MongoDB URI, example: mongodb://dbuser:dbpassword@localhost:27017/dbname Defaults to mongodb://localhost:27017/twitter |
|
|
|
| --queries-collection | The name of the collection for storing the highest since_id for each query. Default is queries. |
|
|
|
| --tweets-collection | The name of the collection for storing tweets. Default is tweets. |
|
|
|
| --verbosity | The level of verbosity. (DEBUG, INFO, WARN, ERROR, CRITICAL, FATAL) |
|
|
|
|
|
|
|
|
|
### Executing a query with the streaming API ###
|
|
|
|
|
|
To execute a query you must provide a **query**, the **consumer secret** and either the **consumer key** or the access token. Consumer key and secret can be obtained at the http://apps.twitter.com/ website, while the access token will be obtained when first connecting with the key and secret.
|
|
|
|
|
|
```bash
|
|
|
tap stream --consumer-key CONSUMERKEY --consumer-secret CONSUMERSECRET --access-token ACCESSTOKEN --access-token-secret ACCESSTOKENSECRET --track "miley cyrus" -v DEBUG
|
|
|
```
|
|
|
|
|
|
Streaming options:
|
|
|
|
|
|
| Option | Description
|
|
|
|--------|--------------------|
|
|
|
| --db | MongoDB URI, example: mongodb://dbuser:dbpassword@localhost:27017/dbname Defaults to mongodb://localhost:27017/twitter |
|
|
|
| --tweets-collection | The name of the collection for storing tweets. Default is tweets. |
|
|
|
| --follow | A comma separated list of user IDs, indicating the users to return statuses for in the stream. More information at https://dev.twitter.com/docs/streaming-apis/parameters#follow |
|
|
|
| --track | A comma separated list of keywords or phrases to track. Phrases of keywords are specified by a comma-separated list. More information at https://dev.twitter.com/docs/streaming-apis/parameters#track |
|
|
|
| --locations | A comma-separated list of longitude,latitude pairs specifying a set of bounding boxes to filter Tweets by. On geolocated Tweets falling within the requested bounding boxes will be included—unlike the Search API, the user\'s location field is not used to filter tweets. Each bounding box should be specified as a pair of longitude and latitude pairs, with the southwest corner of the bounding box coming first. For example: "-122.75,36.8,-121.75,37.8" will track all tweets from San Francisco. NOTE: Bounding boxes do not act as filters for other filter parameters. More information at https://dev.twitter.com/docs/streaming-apis/parameters#locations |
|
|
|
| --firehose | Use this option to receive all public tweets if there are no keywords, users or locations to track. This requires special permission from Twitter. Otherwise a sample of 1% of tweets will be returned. |
|
|
|
| --consumer-key | The consumer key that you obtain when you create an app at https://apps.twitter.com/ |
|
|
|
| --consumer-secret | The consumer secret that you obtain when you create an app at https://apps.twitter.com/ |
|
|
|
| --access-token | You can generate your user access token at http://apps.twitter.com by clicking 'Create my access token'. |
|
|
|
| --access-token-secret | You can generate your user access token secret at http://apps.twitter.com by clicking 'Create my access token'. |
|
|
|
| --verbosity | The level of verbosity. (DEBUG, INFO, WARN, ERROR, CRITICAL, FATAL) |
|
|
|
|
|
|
### Where are the tweets stored ###
|
|
|
|
|
|
The tweets are stored in the mongoDB in a collection called **tweets**. This can be changed using the --tweets-collection option. There is also a collection for saving the highest since_id for queries, which is **queries** by default (can be changed using the --queries-collection option). |