Risk snapshot
Query the latest available risk observation at or before an as-of time.
Available data
- Returns
- Query the latest available risk observation at or before an as-of time.
- What each request returns
- The latest available observation per object and metric before the cutoff
Authentication
Requires an API key with Risk permission.
Query Parameters
REST uses a URL-encoded JSON array; MCP uses a JSON array directly. Valid identifiers do not guarantee data coverage
object_refsstringqueryExample[{"type":"listing","id":"listing_gate_BTC_USDT_perp"}]requiredURL-encoded JSON array of listing, instrument, asset, asset_entity or chain_contract references. MCP takes an array directly. chain_contract requires chain_id and contract_address; a valid reference does not guarantee coverage
risk_typestringqueryoptionalFilter by risk category
metric_codestringqueryExample["open_interest"]optionalMetric codes as a JSON array string, up to 20 items; for example ["open_interest"]. MCP takes an array
Get the latest available observation at or before as_of. The observation may be older than the requested cutoff
as_ofstringqueryExample2026-11-04T22:30:00ZoptionalRFC3339 UTC cutoff, default current UTC time. Returned observations may be older; check resolved_as_of
Object input templates
These are input shapes, not proof of coverage. Use the verified listing example for covered open-interest observations.
[
{
"type": "listing",
"id": "listing_gate_BTC_USDT_perp"
}
][
{
"type": "chain_contract",
"chain_id": "ethereum",
"contract_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
}
]Response
Business data; shape is specific to this endpoint
itemsobject[]Task-specific risk rows
history_endstringLatest covered historical time
history_startstringEarliest covered historical time
latest_observation_idstringIdentifier of the observation selected by the snapshot
latest_value_boolboolean | nullLatest boolean value, or null
latest_value_jsonunknown | nullLatest structured value, or null
latest_value_numericnumber | nullLatest numeric observation at or before as_of; interpret with unit
latest_value_textstring | nullLatest text value, or null
metric_codestringMetric identifier, such as open_interest
requested_as_ofstringRequested cutoff time
resolved_as_ofstringLatest available observation at or before the cutoff; can be older than the request
risk_typestring | nullRisk category
source_task_idstringSource task identifier
target_ref_keystring | nullResolved target identifier; use returned values rather than constructing it from symbols
unitstring | nullValue unit; the verified OI example uses usd
missing_metricsstring[]Requested metric codes that are not covered
data_statusDataStatusBusiness status: verified/ok, partial, no_data or not_ready. HTTP 200 alone does not establish coverage
empty_reasonstring | nullReason for an empty or unavailable result; may be absent
Null on success; otherwise an error string or object
codestringError code
detailsobjectAdditional error details
messagestringError explanation
retryablebooleanWhether the error can be retried
generated_atstringResponse generation time, not the observation time
Response metadata
has_morebooleanWhether a subsequent page is available
next_cursorstring | nullOpaque cursor; null when no next page is available
object_refsobject[]Matched object references
asset_entity_idstring | nullAsset entity identifier
asset_idstring | nullCanonical asset identifier
chain_idstring | nullCanonical chain identifier
contract_addressstring | nullToken contract address associated with chain_id
idstring | nullCanonical object identifier
instrument_idstring | nullInstrument identifier
listing_idstring | nullListing identifier
quote_currencystring | nullQuote currency hint
symbolstring | nullAsset or pool token symbol
typeObjectRefTypeReference type: listing, instrument, asset, asset_entity or chain_contract
venue_idstring | nullVenue identifier
requested_as_ofstring | nullRequested cutoff time
resolved_as_ofstring | nullLatest available observation at or before the cutoff; can be older than the request
unresolved_object_refsobject[]References that could not be resolved
asset_entity_idstring | nullAsset entity identifier
asset_idstring | nullCanonical asset identifier
chain_idstring | nullCanonical chain identifier
contract_addressstring | nullToken contract address associated with chain_id
idstring | nullCanonical object identifier
instrument_idstring | nullInstrument identifier
listing_idstring | nullListing identifier
quote_currencystring | nullQuote currency hint
symbolstring | nullAsset or pool token symbol
typestringReference type: listing, instrument, asset, asset_entity or chain_contract
venue_idstring | nullVenue identifier
request_idstringRequest trace identifier