Get Token Rates

Retrieve rate change information for a specific token.

Endpoint

GET /v2/users/tokens/{token_id}/rates

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer {token}

Path Parameters

Parameter	Type	Required	Description
token_id	string	Yes	The unique identifier of the token

Response

Returns rate change information for the specified token.

Success Response (200 OK)

{
    "daily_rate_change": null,
    "weekly_rate_change": null,
    "monthly_rate_change": {
        "start_date": "2025-08-31T21:35:57.695Z",
        "end_date": "2025-09-01T19:26:14.776Z",
        "start_value": 1.4,
        "end_value": 0.9,
        "rate": -35.71,
        "change_type": -1
    }
}

Response Fields

Field	Type	Description
daily_rate_change	object|null	Daily rate change information
weekly_rate_change	object|null	Weekly rate change information
monthly_rate_change	object|null	Monthly rate change information

Rate Change Object Structure

Field	Type	Description
start_date	string	Start date of the rate change period (ISO 8601)
end_date	string	End date of the rate change period (ISO 8601)
start_value	number	Starting value of the token
end_value	number	Ending value of the token
rate	number	Rate change percentage
change_type	integer	Type of change (TokenRateChangeType)

TokenRateChangeType (change_type)

Value	Description
1	TokenRateChangeTypeIncrease - Increase
-1	TokenRateChangeTypeDecrease - Decrease

Example

Request

curl -X GET "{{baseUrl}}/v2/users/tokens/68ae06cfcccf4e8fc19362d1/rates" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer \{\{token\}\}"

Response

{
    "daily_rate_change": null,
    "weekly_rate_change": null,
    "monthly_rate_change": {
        "start_date": "2025-08-31T21:35:57.695Z",
        "end_date": "2025-09-01T19:26:14.776Z",
        "start_value": 1.4,
        "end_value": 0.9,
        "rate": -35.71,
        "change_type": -1
    }
}

Error Responses

400 Bad Request

{
    "error": "Invalid token ID format"
}

401 Unauthorized

{
    "error": "Authentication required"
}

403 Forbidden

{
    "error": "Access denied"
}

404 Not Found

{
    "error": "Token not found"
}

500 Internal Server Error

{
    "error": "Internal server error"
}