GET
/
api
/
v1
/
index
/
{index}
/
candles
Get index candles
curl --request GET \
  --url https://api.international.coinbase.com/api/v1/index/{index}/candles \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'
{
  "aggregations": [
    {
      "start": "2024-10-31T00:00:00Z",
      "open": "311.4512360891112",
      "high": "312.4418815371496",
      "low": "297.4296073392959",
      "close": "299.5950052685418"
    }
  ]
}
const indexService = new IndexService(client);

indexService.getIndexCandles({
    index: 'COIN50',
    granularity: 'ONE_DAY',
    start: '2024-01-01T00:00:00Z',
}).then(async (response) => {
    console.log('Index Candles: ', response);
})

For more information, please visit the INTX TS SDK.

Authorizations

​
CB-ACCESS-KEY
string
header
required

The Client ID that owns the API Key for the request

​
CB-ACCESS-PASSPHRASE
string
header
required

The pass phrase affiliated with the API Key

​
CB-ACCESS-SIGN
string
header
required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

​
CB-ACCESS-TIMESTAMP
string
header
required

The timestamp of when the request is being made

Path Parameters

​
index
string
required

Identifies the index by name (e.g., COIN50)

Query Parameters

​
granularity
enum<string>
required

The aggregation period of the candles data

Available options:
ONE_DAY,
ONE_HOUR
​
start
string
required

Start timestamp in ISO 8601 timestamp format (e.g. 2024-10-21T00:00:00Z)

​
end
string

End timestamp in ISO 8601 timestamp format (e.g. 2024-10-31T00:00:00Z)

Response

200
application/json

Index Candle list

The response is of type object.