Skip to main content
GET
Crypto market overview

Authorizations

X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Response

Crypto market overview snapshot.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

success
boolean
required

Always true for a successful response.

Example:

true

statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

data
object
required

Crypto market overview — total market capitalisation, 24h volume, BTC/ETH/major dominance split, the Fear & Greed index and a list of trending coins.

meta
object

Response metadata. Always present; timestamp is the server time the response was generated.