Platform profile
Query a platform’s profile and metrics.
GET/api/v1/platforms/profile
Available data
- Returns
- Query a platform’s profile and metrics
- What each request returns
- Query the data selected by the endpoint parameters.
Authentication
Send Authorization: Bearer YOUR_API_KEY or X-API-KEY on every request.
Query Parameters
Platform identification
platform_name identifies one protocol or exchange
platform_namestringqueryExampleBinancerequiredPlatform name
Detail scope
basic returns base fields; with_chain_breakdown requests chain details; full requests available extensions
scopestringqueryExamplefulloptionalDetail scope · basic / with_chain_breakdown / full · Default: basic
Open-interest options
These options affect available open-interest details. A symbol limit applies only when details are enabled
include_oi_symbol_detailbooleanqueryExampletrueoptionalInclude open interest by symbol · Default: false
oi_symbol_limitintegerqueryExample2optionalMaximum symbols in open-interest details · Default: 20 · ≥ 1, ≤ 100
Response
countnumberReturned row count
scopestringDetail scope
totalnumberTotal matching records
items[]object[]
Result rows
platform_namestringPlatform name
platform_typestringPlatform type
tvlunknown | nullTotal value locked
Errors & fallback
200
assets_resolve name multi-match; confirm from data[] candidates.
200
The object resolved but no data is available; empty_reason may be not_covered_by_source, unsupported_metric, or limited_depth.
400
Invalid parameters or an ambiguous market listing; ambiguity responses include required_params + candidates.
401
The API key is missing or invalid.
403
The current key scope or plan cannot access this data domain.
404
The requested resource does not exist; source coverage gaps are not 404 responses.
402
Credits or monthly quota exhausted.
429
Request rate exceeded; retry_after is returned in the body and Retry-After in the response headers.