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

Mindshare Data

The Mindshare Data endpoint returns time series data for mindshare 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/mindshare?token=BTC&start_date=2024-03-01&end_date=2024-03-05' \
  -H 'x-api-key: $YOUR_API_KEY'

Response

{
  "mindshare": {
    "2024-03-01": 0.13493861636545657,
    "2024-03-02": 0.14218089602704986,
    "2024-03-03": 0.1524866420057542,
    "2024-03-04": 0.21724408676023163
  }
}

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

Return Fields Explanation

• Mindshare: Token mindshare is measured by the number of tweets where a specific token is referenced or mentioned, relative to the overall cryptocurrency market