AGagentkey
crypto

Open interest and funding of a perpetual contract on one exchange.

Returns the current perpetual-futures snapshot of one base asset (BTC, ETH …) on one exchange: open interest in USD and contracts, funding rate and next settlement, mark and index price. The USDT-quoted perpetual is used.

Fixed price: 3.6 credits per successful call, whichever provider serves it.

post/v2/ops/crypto.derivatives.snapshot

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/crypto.derivatives.snapshot
  • Auth
    HTTP bearer

Request body

exchange'binance' | 'okx' | 'bybit' | 'bitget' | 'htx' | 'bitfinex' | 'bitmex' | 'hyperliquid'

Exchange to read the contract from.

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

providerstring

Shorthand for routing.only = [provider].

symbolstring required

Base asset ticker, e.g. BTC. Case-insensitive.

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.