Skip to content

Get global market overview​

GET
/v2/market-overview

The worker refreshes the overview every five minutes. Global amounts are USD JSON numbers; last_updated values are RFC 3339 provider timestamps. fear_greed is null when no index is available. On an index fetch failure, the last known value and its original timestamp are retained: health stays healthy while the value is at most 48 hours old and the global overview saves successfully; missing or older values degrade health. GET /v2/market-overview returns 503 before the cache is populated or after it expires. The overview cache expires after two hours without a successful write. Implausible upstream data is rejected and the previous cache is retained: 24-hour volume above three times market cap, a 24-hour market cap change above +90%, or a 24-hour volume change above +1000%. A rejected refresh counts as a failed refresh for /v2/_hc until the next successful one. Only upward changes are bounded because the provider computes change_24h against its own value one day earlier; after an upstream glitch the echo can read close to -100% for the glitch's duration and is served as is.

Authorizations​

bearerAuth

Required when cp_auth.enabled=true. The token must have the oracle scope.

Type
HTTP (bearer)

Responses​

Cached market overview.

application/json
JSON
{
  
"fear_greed": {
  
  
"value": 0,
  
  
"label": "Fear",
  
  
"last_updated": "string",
  
  
"source": "alternative.me"
  
},
  
"market_cap": {
  
  
"value": 0,
  
  
"display_value": "$2.50T",
  
  
"change_24h": 0,
  
  
"last_updated": "string",
  
  
"source": "coingecko"
  
},
  
"volume_24h": {
  
  
"value": 0,
  
  
"display_value": "$2.50T",
  
  
"change_24h": 0,
  
  
"last_updated": "string",
  
  
"source": "coingecko"
  
},
  
"btc_market_cap_percentage": 0
}

Playground​

Authorization

Samples​