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

Sentiment Data

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

Parameters

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

  • 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.

Example

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

Response

{
  "sentiment": {
    "2024-03-01": {
      "score": 12.151003275747,
      "event": null
    },
    "2024-03-02": {
      "score": 12.162690010929,
      "event": null
    },
    "2024-03-03": {
      "score": 13.172113924427,
      "event": null
    },
    "2024-03-04": {
      "score": 14.447155302628001,
      "event": "The approval of spot Bitcoin ETFs and the approaching Bitcoin halving event are the primary drivers of the positive sentiment towards BTC, leading to a surge in its price and nearing all-time highs."
    }
  }
}

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

Return Fields Explanation

  • Sentiment score: Sentiment analytics evaluate the bullishness or bearishness reflected in the overall sentiment on Crypto Twitter regarding a specific token over a specified period. This assessment is derived from a comprehensive analysis of all pertinent tweets using the Kaito platform. We utilize sophisticated Al to assign and analyze a sentiment score for each tweet. These scores are then aggregated to formulate an overall sentiment score at the ticker level. Being a cumulative metric, the overall sentiment score essentially represents a volume-weighted sentiment score.

  • event: The event corresponding to the sentiment change of the date, generated by Kaito AI.

Last updated

© 2024 Kaito All Rights Reserved.