Skip to main content
POST
crypto.derivatives.protocol

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
protocol
string
required

Protocol slug.

Required string length: 1 - 512
excludeTotalDataChart
boolean
required

True to exclude aggregated chart from response.

excludeTotalDataChartBreakdown
boolean
required

True to exclude broken down chart from response.

Response

The result

id
string
required

Id.

description
string

Description.

name
string

Name.

url
string

Url link.

displayName
string

Display name.

methodologyURL
string

Methodology url.

referralUrl
string

Referral link.

change1d
number

Change1d.

total24h
number

Total24h: how many.

total48hto24h
number

Total48hto24h: how many.

total7d
number

Total7d: how many.

address
string

Address.

category
string

Category.

chains
string[]

Chains.

cmcId
string

Cmc id.

disabled
boolean

True when disabled.