Alpha Alerts API

Get crypto market insights in real-time.

Most of our API endpoints are still private but will be released soon.


Fetch the most recent crypto market news and discussions.

Parameters:

  • query: what you want to search for; the more specific, the better.

  • count: how many documents to return. Allowed range: 1-20, default: 10.

  • offset: how many documents to skip.

  • sort_by: whether to sort documents by date or by their relevance score. We recommend using date for most cases, but relevance could work better for very niche queries.

  • sources: categories of documents to search. Should include at least one of those: news, 4chan.

Note that at the moment, the summary field of each document returned by this endpoint will be equal to null.

Search Knowledge Documents

Search knowledge documents

POST/knowledge/search
Authorization
Header parameters
Body
query*Query
countCount
offsetOffset
sort_bySort By
relevancedate
sourcesSources
Response

Successful Response

Body
documents*Documents
countCount
offsetOffset
total_found*Total Found
Request
const response = await fetch('/knowledge/search', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "text"
    }),
});
const data = await response.json();
Response
{
  "documents": [
    {
      "summary": "text",
      "title": "text",
      "tldr": "text",
      "source": "text",
      "last_time_updated": "2024-09-16T19:07:46.829Z",
      "bullishness": 0,
      "legitimacy": 0
    }
  ]
}

Coming in the next update

  • More structured data fields (hashtags, impact, assets mentioned, market sectors, etc.)

  • Custom threshold for the similarity score

  • Return the contents of the summary field

API Costs


The pricing for the API is per request and depends on the model used. Learn more about API Credits at API Credits.

EndpointAPI Credits per request

Search

1

Last updated