OHLCV candles of the pair token (one series across graduation), in CC or USD.
GET /api/v1/market/pairs/{pairId}/candles. OHLCV candles of the pair token (one series across graduation), in CC or USD.
Anonymous calls are accepted under a per-IP budget; an X-API-Key raises the limit. When the deployment sets MARKET_DATA_REQUIRE_API_KEY=true the key becomes mandatory and anonymous calls answer 401 MARKET_DATA_API_KEY_REQUIRED.
Request
GET /api/v1/market/pairs/{pairId}/candles
The schema permits anonymous access. Supported credentials: a customer API key with read scope in X-API-Key. Deployment policy can require a key for market-data routes.
Parameters
| Name | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
pairId | path | string | Yes | max length: 160; pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}:(?:curve|amm)$ | — |
currency | query | string | No | default: cc; allowed: "cc", "usd" | — |
from | query | string | No | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
interval | query | string | No | default: 1h; allowed: "1m", "5m", "1h", "4h", "1d" | — |
to | query | string | No | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
X-Request-Id | header | string | No | min length: 8; max length: 128; pattern: ^[A-Za-z0-9._:-]+$ | Optional client correlation identifier. The server always generates a separate authoritative request ID and retains a valid supplied value only as secondary audit correlation metadata. |
cURL
Set PAIR_ID to the path and required query values before running this example. URL-encode path values as needed.
curl --fail-with-body --silent --show-error \
--request GET \
--url "https://launch-api.supanova.app/api/v1/market/pairs/${PAIR_ID}/candles" \
--header "X-API-Key: $SUPANOVA_API_KEY"Responses
200
Candles, oldest first.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
candles | array of object · Schema 1 | Yes | — | — |
currency | string | Yes | allowed: "cc", "usd" | — |
interval | string | Yes | allowed: "1m", "5m", "1h", "4h", "1d" | — |
meta | object · Schema 2 | Yes | — | — |
pair_id | string | Yes | — | — |
Additional fields are not allowed.
400
Invalid interval or window (at most 500 candles). Also: VALIDATION_FAILED, AMBIGUOUS_CREDENTIALS.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
401
Unknown API key, or a key is required. Also: API_KEY_INVALID, API_KEY_REVOKED, MARKET_DATA_API_KEY_REQUIRED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
403
The credential may not call this route. Codes: API_KEY_IP_NOT_ALLOWED, PRODUCT_ACCOUNT_RESTRICTED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
404
Unknown pair.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
429
The caller exceeded an IP or principal request budget.
| Header | Type | Description |
|---|---|---|
Retry-After | integer | Whole seconds to wait before retrying a rate-limited request. |
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
503
The PQS market projection is not configured.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
default
Machine-readable API error. The HTTP status identifies the error class.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
Nested schemas
Field links above lead to the complete nested object, array, and variant definitions below. Required fields are scoped to their containing object.
Schema 1
Response 200.candles
Type: array of object.
Array items: object · Schema 3.
Schema 2
Response 200.meta
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
as_of | string | Yes | — | — |
cc_usd | one or more variants · Schema 4 | Yes | — | — |
ledger_offset | string | Yes | — | — |
network_id | string | Yes | — | — |
source | "pqs" | Yes | — | — |
Additional fields are not allowed.
Schema 3
Response 200.candles item
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
close | string | Yes | pattern: ^-?\d+(?:\.\d+)?$ | — |
high | string | Yes | pattern: ^-?\d+(?:\.\d+)?$ | — |
low | string | Yes | pattern: ^-?\d+(?:\.\d+)?$ | — |
open | string | Yes | pattern: ^-?\d+(?:\.\d+)?$ | — |
time | string | Yes | — | — |
ts | integer | Yes | minimum: -9007199254740991; maximum: 9007199254740991 | — |
volume | string | Yes | pattern: ^-?\d+(?:\.\d+)?$ | — |
Additional fields are not allowed.
Schema 4
Response 200.meta.cc_usd
Type: one or more variants.
At least one of these variants must match:
- Variant 1: object · Schema 5.
- Variant 2: null.
Schema 5
Response 200.meta.cc_usd variant 1
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
as_of | string | Yes | — | — |
rate | string | Yes | pattern: ^-?\d+(?:\.\d+)?$ | — |
source | string | Yes | — | — |
stale | boolean | Yes | — | — |
Additional fields are not allowed.
Source contract
This page is generated from the checked-in customer OpenAPI snapshot. Download JSON, download YAML, or compare the live API reference. Snapshot provenance records the retrieval date and checksum.