📈Mentions API

Overview

This guide provides information on Kaito AI's API, offering access to comprehensive time series data for a given cryptocurrency ticker. To trial our API, please contact us at Kaito Official Telegram or via Email.

Base URL

https://api.kaito.ai/api/v1/

NOTE: This is a preview environment; availability is not guaranteed and the key is temporary. Kaito reserves the right to revoke it without notice.

Authentication

Include your API key in the request header for authentication:

GET https://api.kaito.ai/api/v1/<method>?token=BTC&start_date=2023-01-01&end_date=2024-01-01
HEADER: x-api-key: <YOUR_API_KEY>

Currently, we provide method of mindshare, sentiment, mentions, and engagement.

You need to provide your API key in the x-api-key header.

Endpoints

Mentions Data

The Mentions Data endpoint returns time series data for mentioning metrics related to the specified cryptocurrency ticker.

Parameters

  • token (optional): The symbol of the cryptocurrency for which you want to retrieve time series data.

  • keyword(optional): (the keyword needs to be urlencoded if it contains characters like space etc.)

  • start_date (optional): The start date for time filtering in the format YYYY-MM-DD. Defaults to the earliest available date (2023-01-01).

  • end_date (optional): The end date for time filtering in the format YYYY-MM-DD. Defaults to the current date.

Note:

  1. at least one of token or keyword needs to be specified.

  2. if keyword is given, the results will contain total_document_mentions and document_mentsion only, without total_term_mentions and term_mentions

Example

curl -X 'GET' \
  'https://api.kaito.ai/api/v1/mentions?token=BTC&start_date=2024-05-01&end_date=2024-05-05' \
  -H 'x-api-key: $YOUR_API_KEY'

Response

{
  "total_document_mentions": {
    "2024-05-01": 2873,
    "2024-05-02": 2618,
    "2024-05-03": 2480,
    "2024-05-04": 1578
  },
  "total_term_mentions": {
    "2024-05-01": 5164,
    "2024-05-02": 4712,
    "2024-05-03": 4667,
    "2024-05-04": 2707
  },
  "document_mentions": {
    "2024-05-01": {
      "Twitter": 2127,
      "Discord": 606,
      "Medium": 6,
      "Mirror": 49,
      "Governance": 11,
      "Twitter Space": 22,
      "News": 39,
      "Research": 4,
      "Podcast": 9,
      "Conference": 0,
      "Dashboard": 0
    },
    "2024-05-02": {
      "Twitter": 1976,
      "Discord": 508,
      "Medium": 8,
      "Mirror": 36,
      "Governance": 30,
      "Twitter Space": 6,
      "News": 42,
      "Research": 2,
      "Podcast": 10,
      "Conference": 0,
      "Dashboard": 0
    },
    "2024-05-03": {
      "Twitter": 1867,
      "Discord": 504,
      "Medium": 4,
      "Mirror": 20,
      "Governance": 12,
      "Twitter Space": 12,
      "News": 46,
      "Research": 2,
      "Podcast": 12,
      "Conference": 1,
      "Dashboard": 0
    },
    "2024-05-04": {
      "Twitter": 1121,
      "Discord": 357,
      "Medium": 2,
      "Mirror": 64,
      "Governance": 7,
      "Twitter Space": 5,
      "News": 17,
      "Research": 3,
      "Podcast": 2,
      "Conference": 0,
      "Dashboard": 0
    }
  },
  "term_mentions": {
    "2024-05-01": {
      "Twitter": 3289,
      "Discord": 753,
      "Medium": 24,
      "Mirror": 182,
      "Governance": 22,
      "Twitter Space": 397,
      "News": 380,
      "Research": 76,
      "Podcast": 41,
      "Conference": 0,
      "Dashboard": 0
    },
    "2024-05-02": {
      "Twitter": 3057,
      "Discord": 650,
      "Medium": 43,
      "Mirror": 130,
      "Governance": 43,
      "Twitter Space": 121,
      "News": 480,
      "Research": 13,
      "Podcast": 175,
      "Conference": 0,
      "Dashboard": 0
    },
    "2024-05-03": {
      "Twitter": 3035,
      "Discord": 644,
      "Medium": 19,
      "Mirror": 126,
      "Governance": 26,
      "Twitter Space": 49,
      "News": 422,
      "Research": 84,
      "Podcast": 256,
      "Conference": 6,
      "Dashboard": 0
    },
    "2024-05-04": {
      "Twitter": 1725,
      "Discord": 460,
      "Medium": 29,
      "Mirror": 335,
      "Governance": 24,
      "Twitter Space": 15,
      "News": 96,
      "Research": 8,
      "Podcast": 15,
      "Conference": 0,
      "Dashboard": 0
    }
  }
}

The response includes time series data with the date (in UTC timezone), with granularity at the level of days.

Return Fields Explanation

  • total_document_mentions: The count of documents where the specified token is referenced or mentioned in any context. Each unique occurrence of the query in a document is considered as one mention, regardless of how many times it appears within that document.

  • total_term_mentions: The cumulative number of times the specified token appears across all documents. Each individual occurrence of the query, regardless of the document it appears in, contributes to the count of term mentions.

  • document_mentions: breakdown total_document_mentions into different sources

  • term_mentions: breakdown total_term_mentions into different sources

Last updated

© 2024 Kaito All Rights Reserved.