GET /v1/flow/oi-agg

#`GET /v1/flow/oi-agg`getOpenInterestAggregated

Open interest in coins summed over the perpetual venues

Scope	analytics:read
Lowest tier	sandbox
Weight (units)	3; 10 over 30 days
History each tier may read	Sandbox: 7 days; Starter: 30 days; Elite (included): 30 days; Developer: 180 days; Business: 365 days
SDK	Python client.flow.oi_aggregated · JavaScript cd.flow.oiAggregated

Parameters

Parameter	In	Type	Description
`coin` required	query	`string`	Coin ticker, upper case (BTC).
`res`	query	`string`	Resolution of the series (5, 15, 30, 60, 240, 1D).
`from`	query	`string`	Start, inclusive: unix seconds or RFC 3339.
`to`	query	`string`	End, exclusive: unix seconds or RFC 3339. Default now.
`venues`	query	`string`	Comma-separated venue ids (default all).

Errors

400 invalid_param, invalid_cursor
401 unauthorized: missing, unknown, revoked or expired key
403 insufficient_scope, tier_required
404 not_found, not_available, not_in_sandbox
422 window_too_large
429 rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After
503 api_disabled, overloaded

Example

Shell

curl "https://api.chartdeck.trade/v1/flow/oi-agg?coin=BTC" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.flow.oi_aggregated(coin="BTC")
print(r.data, r.meta["attribution"])

JavaScript

import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.flow.oiAggregated({ coin: "BTC" });
console.log(r.data, r.meta.attribution);

GET /v1/flow/oi-agg

#GET /v1/flow/oi-agggetOpenInterestAggregated

#`GET /v1/flow/oi-agg`getOpenInterestAggregated