REST API Resources

Ross Power edited this page Sep 22, 2015 · 9 revisions

#KeywordMeme™ REST API v1.1 Resources

Returns a structured collection of correlated, weighted and clustered terms from a specified information stream segmented in intervals

(Note that when selecting Twitter as source, Twitter’s search service and, by extension, the Search API is not meant to be an exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search interface.)

Sign in with your KeywordMeme.com service account in order to use the OAuth tool to retrieve your token.

 

Resource Information

Rate Limited?

Yes

Requests per hours (for twitter source class)

based on source provider

Authentication

Required

Response Formats

JSON

HTTP Methods

GET

Resource family

Create KeywordMeme

Response Object

KeywordMeme Collection

API Version

v1.01b

Resource URL

http://api.KeywordMeme.com/v1/fetch?

Create a KeywordMeme™ collection based on sources and queries performed by the user.


Parameters

Description

api_token

required

Required to access the API

source 

optional

default=twitter

Specify the information source class used by Darwin Ecosystem’s Streams Collector, CSV file location, or upload. In V1.1 the default is Twitter and the upload is available through www.KeywordMeme.com’s user interface.

options:

twitter
news
blogs

File=[system provided path by API]
Example: source=twitter

q

optional

A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity.
Example Values: big AND data

geocode

optional

Returns records located within a given radius of the given latitude/longitude. For Twitter as a source, the location is preferentially taken from the Geotagging API, but will fall back to the user 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 Values: 42.415278,-71.156944,1mi

lang

optional

Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is best-effort.
Example Values: en

interval_window

optional

default=10 minutes

Sets the stream of records within a window delimited in minutes for each Keyword Meme Interval according to the record’s date of creation. Default is 10 minutes.
Example Values: 30 Default:10

interval_records

optional

Sets the window to a specific number of records.

Example Values: 1000

start_date

optional

Returns KeywordMeme collection generated in a given start date and time frame set with the end_date.
Example Values: 2014-08-26 20:00:00 UTC

end_date

optional

Returns KeywordMeme collection generated in a given start date and time frame set with the end_date.
Example Values: 2014-08-28 10:30:00 UTC

include_keywordmeme

optional

default=0

If present & =1, returns the Master KeywordMeme section of the output.  For the default value = 0, only the clustered KeywordMemes will be returned in the output. include_keywordmeme=1 MUST be present at first fetch call to be available later. Example: include_keywordmeme=1

output

JSON

JSON only in this release.
Example Values: JSON

details

optional

Returns a list of all source records and information.

Example:  Details=1

detail_record[]

optional

requires details=1

Returns details JSON containing only records specified by source_id.  
For each record requested, you must specify a new detail_record[] parameter.  
Must also include the details=1 parameter.

Example:  details=1&details_record[]=567331681502519297&details_record[]=567331917272326144

Additional Resources

Parameters

Description

http://api.KeywordMeme.com/v1/queries?

Return a  info/status collection of all or a single query of a user.

api_token

required

Required to access the API

query_token

optional

If present, returns an info/status JSON of only the  query specified by query_token.  If no query_token is specified, the info/status JSON will contain all queries by the user.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.