GET Parameters

In order to use the API you need to call an endpoint URL with your private access token.[QUERY]

HTTP GET Parameters



A string query containing the filters that define which posts will be returned.

Find any posts containing either bitcoin or Zcash:

(bitcoin OR Zcash)


Your private access token. You get a unique access token when you sign up.


By default (when the sort parameter isn't specified) the results are sorted by the recommended order of crawl date.
You can however change the sort order to relevancy or published.
The sort parameter is relevant respectively with order parameter.

For sort by published advanced options see details here : advanced-reference



Ordering of the data set received either :
desc - descending order from latest to the oldest
asc - ascending order from oldest to the latest

**This parameter only relevant for sort=published



A paging parameter that works only for relevancy sort order.



The "ts" (timestamp) parameter is telling the system to return results that were crawled after this timestamp (Unix Timestamp in milliseconds).



The output format of the results set. It can be either:

  • json
  • xml

The default is json



The total number of results returned per request, ranges between 1 to 10 (default is 10)

Will return 2 results


Search only on the structured content (i.e content our system parsed and extracted fields such as post text, publication date, author, sections etc.)



This will return the latest 10 crawled posts matching your query.
It's NOT recommended to use this feature as it may result in you missing important posts



Return the fragments in the post that matched the textual Boolean query. The matched keywords will be surrounded by <em/> tags.



In case true : Embed in the response under warning tag the relevant details of the warning : Message , Type, Level.
By default warning is disabled.
For warning advanced options see details here : advanced-reference


Updated 27 days ago

GET Parameters

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.