Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

interval
enum<string>
default:1h

Bucket size.

Available options:
1h,
4h,
1d
view
enum<string>
default:markets

markets returns one row per market. index returns one row: the open-interest-weighted index over the selected markets, which is all markets or one asset_class.

Available options:
markets,
index
asset_class
string

Only this sentiment class. With view=index, it is the index's class.

coins
string

Comma-separated markets, up to 50. Works with view=markets only.

start_time
integer

Start time in epoch milliseconds. Defaults to 7 days before end_time. The range is at most 30 days.

end_time
integer

End time in epoch milliseconds. Defaults to now.

Response

OK

data
object[]
required

Result rows.

has_more
boolean
required

true when another page follows.

next_cursor
string | null
required

Cursor for the next page, passed as cursor. null on the last page.

meta
object
required

Response metadata. Its keys depend on the endpoint and are described above.