|GET /track/:stream||Connect to the data stream|
All requests to the PowerTrack API must use HTTP Basic Authentication, constructed from a valid email address and password combination used to log into your account at console.gnip.com. Credentials must be passed as the Authorization header for each request. Make sure your client is adding the "Authentication: Basic" HTTP header (with encoded credentials over HTTPS) to all API requests.
GET /track/:stream ¶
Establishes a persistent connection to the PowerTrack data stream, through which the social data will be delivered.
IMPORTANT: After you establish the connection see here for details on consuming streaming data.
|Request Method||HTTP GET|
This should be specified in the header of the request.
|URL||Found on the stream's API Help page of your console dashboard, and resembles the following structure:
|Compression||Gzip. To connect to the stream using Gzip compression, simply send an Accept-Encoding header in the connection request. The header should look like the following:
|Response Format||JSON. The header of your request should specify JSON format for the response.|
|Rate Limit||60 requests per minute.|
|Read Timeout||Set a read timeout on your client, and ensure that it is set to a value beyond 30 seconds.|
The following responses may be returned by the API for these requests. Most error codes are returned with a string with additional details in the body. For non-200 responses, clients should attempt to reconnect.
|200||Success||The connection was successfully opened, and new activities will be sent through as they arrive.|
|401||Unauthorized||HTTP authentication failed due to invalid credentials. Log in to console.gnip.com with your credentials to ensure you are using them correctly with your request.|
|406||Not Acceptable||Generally, this occurs where your client fails to properly include the headers to accept gzip encoding from the stream, but can occur in other circumstances as well.
Will contain a JSON message similar to "This connection requires compression. To enable compression, send an 'Accept-Encoding: gzip' header in your request and be ready to uncompress the stream as it is read on the client end."
|429||Rate Limited||Your app has exceeded the limit on connection requests.|
|503||Service Unavailable||Gnip server issue. Reconnect using an exponential backoff pattern. If no notice about this issue has been posted on status.gnip.com, email email@example.com.|
Example curl Request
The following example request is accomplished using cURL on the command line. However, note that these requests may also be sent with the programming language of your choice.
curl --compressed -v -firstname.lastname@example.org "https://gnip-stream.twitter.com/stream/powertrack/accounts/:account_name/publishers/twitter/:stream_label.json"
POST /rules ¶
Adds one or many rules to your PowerTrack stream's ruleset.
|Request Method||HTTP POST|
|Content Type||"application/json". The request should specify this as the "Content-type".|
|URL||Found on the API Help page, and uses the following structure:
|Request Body Format||JSON|
|Request Body Size Limit||5 MB|
|Rate Limit||60 requests per minute, aggregated across all requests to /rules endpoint for the specific stream's API (POST and GET). Rule addition requests will be processed serially and will be rejected if you have more than one rule request happening at the same time.|