---
title: "Pair candles"
method: GET
path: "/timeseries/pair-candles"
tags: ["Timeseries"]
---

# Pair candles

`GET /timeseries/pair-candles`

## Request

- Base URL: `https://api.coinmetrics.io/v4`
- URL: `https://api.coinmetrics.io/v4/timeseries/pair-candles`
- Auth: API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/docs/timeseries/pair-candles/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns candles for specified asset pairs.<br/> Results are ordered by tuple `(pair, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>

## Query parameters

- `pairs` string[], required
- `frequency` string
- `start_time` string
- `end_time` string
- `start_inclusive` boolean
- `end_inclusive` boolean
- `timezone` string
- `page_size` integer
- `paging_from` 'start' | 'end', PagingFrom
- `limit_per_pair` integer
- `pretty` boolean
- `format` 'json' | 'csv'
- `next_page_token` string

## Response `200`

Time series of pair candles.

- PairCandlesResponse
  - `data` PairCandle[], required
    - `pair` string, required: Unique name of the pair.
    - `time` string, required: The time in ISO 8601 date-time format. Always with nanoseconds precision.
    - `price_open` string, required: The opening price of the candle.
    - `price_close` string, required: The closing price of the candle.
    - `price_high` string, required: The high price of the candle.
    - `price_low` string, required: The low price of the candle.
  - `next_page_token` string: Token of the next page results for a given request.
  - `next_page_url` string: URL of the next page results for a given request.

## Other responses

- `400`: Pair not found.
- `401`: Requested resource requires authorization.
- `403`: Requested resource is not available with supplied credentials.
- `414`: Provided URI is too long. It must not be greater than 10000 symbols.

---

[API](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4.md) - [All operations](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/revisions/774268c0a4fe?raw)