📈Engagement 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

Engagement Data

The Engagement Data endpoint returns time series data for engagement 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_engagement only, without smart_engagement

Example

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

Response

{
  "total_engagement": {
    "2024-03-01": 644772,
    "2024-03-02": 415677,
    "2024-03-03": 442492,
    "2024-03-04": 1454606
  },
  "smart_engagement": {
    "2024-03-01": 2614,
    "2024-03-02": 2113,
    "2024-03-03": 2321,
    "2024-03-04": 4336
  }
}

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

Return Fields Explanation

  • total_engagement: The cumulative number of likes the specified token receives across all tweets in Kaito's dataset. Each individual occurrence of such engagement, regardless of the tweet it appears in, contributes to the count of engagement.

  • smart_engagement: Smart Engagement is defined as quote tweets, retweets and replies generated by a set of Twitter users which Kaito deems as core to the crypto community, discovered and maintained through Kaito's proprietary machine learning algorithm. They typically include official projects, builders, researchers, investors and KOLs.

Last updated

© 2024 Kaito All Rights Reserved.