Skip to main content

Get Token Rates

Returns the token's price movement in five calendar windows: the current hour, day, week, month and quarter. Each window compares the first price recorded in the window with the last one. A window with no recorded price is null. The token itself is not looked up, so an ID without price history answers every window as null.

Required permission: token:view

Request​

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

Parameters​

NameTypeInDescription
token_idstringpathRequired. Token ID

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/users/tokens/68ae06cfcccf4e8fc19362d1/rates' \
--header 'Authorization: Bearer <access_token>'

Response​

{
"hourly_rate_change": null,
"daily_rate_change": {
"start_date": "2026-11-09T00:05:12Z",
"end_date": "2026-11-09T09:40:03Z",
"start_value": "1.1",
"end_value": "1.12",
"rate": "1.81",
"change_type": 1
},
"weekly_rate_change": {
"start_date": "2026-11-09T00:05:12Z",
"end_date": "2026-11-09T09:40:03Z",
"start_value": "1.1",
"end_value": "1.12",
"rate": "1.81",
"change_type": 1
},
"monthly_rate_change": {
"start_date": "2026-11-02T08:00:00Z",
"end_date": "2026-11-09T09:40:03Z",
"start_value": "1.4",
"end_value": "1.12",
"rate": "-20",
"change_type": -1
},
"quarterly_rate_change": {
"start_date": "2026-10-01T08:00:00Z",
"end_date": "2026-11-09T09:40:03Z",
"start_value": "1",
"end_value": "1.12",
"rate": "12",
"change_type": 1
}
}

Response Fields​

FieldTypeDescription
hourly_rate_changeobject | nullMovement in the current hour
daily_rate_changeobject | nullMovement today
weekly_rate_changeobject | nullMovement this week
monthly_rate_changeobject | nullMovement this month
quarterly_rate_changeobject | nullMovement this quarter
*.start_datestringTime of the first price recorded in the window (RFC 3339)
*.end_datestringTime of the last price recorded in the window (RFC 3339)
*.start_valuestringToken price at start_date
*.end_valuestringToken price at end_date
*.ratestringChange from start_value to end_value in percent, truncated to 2 decimals. Negative for a decrease (for example "-20"); "0" when start_value is zero
*.change_typeinteger1 increase or unchanged, -1 decrease

Errors​

StatusCodeDescription
50010000Unexpected server-side failure, including a token_id that is not a valid 24-character hex id

See Errors for the error format and common codes.