GET /v1/indices/{index}

#`GET /v1/indices/{index}`getIndexBars

Market-cap index bars (TOTAL, TOTAL2, TOTAL3) and the newest snapshot

Scope	analytics:read
Lowest tier	sandbox
Weight (units)	1; 2 over 1,000 bars
History each tier may read	Sandbox: 30 days; Starter: 365 days; Elite (included): 365 days; Developer: 1825 days; Business: all recorded
SDK	Python client.indices.bars · JavaScript cd.indices.bars

Parameters

Parameter	In	Type	Description
`index` required	path	`"TOTAL" \| "TOTAL2" \| "TOTAL3"`	The index.
`res`	query	`string`	Resolution (default 1h).
`from`	query	`string`	Start, inclusive: unix seconds or RFC 3339.
`to`	query	`string`	End, exclusive: unix seconds or RFC 3339. Default now.

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/indices/TOTAL" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.indices.bars("<index>")
print(r.data, r.meta["attribution"])

JavaScript

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

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.indices.bars("<index>");
console.log(r.data, r.meta.attribution);

GET /v1/indices/{index}

#GET /v1/indices/{index}getIndexBars

#`GET /v1/indices/{index}`getIndexBars