supanovasupanovaDOCS
Open Launchpad
Launchpad documentation
market data

One pair with its full figures.

GET /api/v1/market/pairs/{pairId}. One pair with its full figures.

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}

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

NameInTypeRequiredConstraintsDescription
pairIdpathstringYesmax length: 160; pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}:(?:curve|amm)$<instrument id>:curve or :amm
X-Request-IdheaderstringNomin 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.

bash
curl --fail-with-body --silent --show-error \
  --request GET \
  --url "https://launch-api.supanova.app/api/v1/market/pairs/${PAIR_ID}" \
  --header "X-API-Key: $SUPANOVA_API_KEY"

Responses

200

Pair.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Type: object.

FieldTypeRequiredConstraintsDescription
itemobject · Schema 1Yes——
metaobject · Schema 2Yes——

Additional fields are not allowed.

400

The request is malformed or failed validation. Codes: VALIDATION_FAILED, AMBIGUOUS_CREDENTIALS.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
Retry-AfterintegerWhole seconds to wait before retrying a rate-limited request.
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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.item

Type: object.

FieldTypeRequiredConstraintsDescription
baseobject · Schema 3Yes——
created_atstring or nullYes——
created_at_blockstring or nullYes——
created_at_txn_idstring or nullYes——
fdvstringYespattern: ^-?\d+(?:\.\d+)?$—
fdv_usdone or more variants · Schema 4Yes——
fee_bpsintegerYesminimum: -9007199254740991; maximum: 9007199254740991—
graduationobject · Schema 5Yes——
holders_countintegerYesminimum: -9007199254740991; maximum: 9007199254740991—
last_trade_atstring or nullYes——
liquidityobject · Schema 6Yes——
marketstringYes——
market_capone or more variants · Schema 7Yes—Circulating market cap in CC: price x circulating_supply (fdv x circulating_supply / total_supply).
market_cap_usdone or more variants · Schema 4Yes——
pair_idstringYes——
pricestringYespattern: ^-?\d+(?:\.\d+)?$—
price_changeobject · Schema 8Yes——
price_usdone or more variants · Schema 4Yes——
quoteobject · Schema 3Yes——
statusstringYesallowed: "active", "graduated"—
tsintegerYesminimum: -9007199254740991; maximum: 9007199254740991—
txnsobject · Schema 9Yes——
venuestringYesallowed: "amm", "curve"—
volumeobject · Schema 8Yes——
volume_usdobject · Schema 10Yes——

Additional fields are not allowed.

Schema 2

Response 200.meta

Type: object.

FieldTypeRequiredConstraintsDescription
as_ofstringYes——
cc_usdone or more variants · Schema 11Yes——
ledger_offsetstringYes——
network_idstringYes——
source"pqs"Yes——

Additional fields are not allowed.

Schema 3

Response 200.item.base

Type: object.

FieldTypeRequiredConstraintsDescription
asset_idstringYes——
instrument_adminstring or nullYes——
namestringYes——
symbolstringYes——

Additional fields are not allowed.

Schema 4

Response 200.item.fdv_usd

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. pattern: ^-?\d+(?:\.\d+)?$
  • Variant 2: null.

Schema 5

Response 200.item.graduation

Type: object.

FieldTypeRequiredConstraintsDescription
percentstringYespattern: ^-?\d+(?:\.\d+)?$—
stagestringYesallowed: "graduating", "ignition", "in_orbit", "near_escape"—
threshold_ccstringYespattern: ^-?\d+(?:\.\d+)?$—

Additional fields are not allowed.

Schema 6

Response 200.item.liquidity

Type: object.

FieldTypeRequiredConstraintsDescription
ccstringYespattern: ^-?\d+(?:\.\d+)?$—
reservesobject · Schema 12Yes——
usdone or more variants · Schema 4Yes——

Additional fields are not allowed.

Schema 7

Response 200.item.market_cap

Type: one or more variants.

Circulating market cap in CC: price x circulating_supply (fdv x circulating_supply / total_supply).

At least one of these variants must match:

  • Variant 1: string. pattern: ^-?\d+(?:\.\d+)?$
  • Variant 2: null.

Schema 8

Response 200.item.price_change

Type: object.

FieldTypeRequiredConstraintsDescription
h1stringYespattern: ^-?\d+(?:\.\d+)?$—
h24stringYespattern: ^-?\d+(?:\.\d+)?$—
h6stringYespattern: ^-?\d+(?:\.\d+)?$—
m5stringYespattern: ^-?\d+(?:\.\d+)?$—

Additional fields are not allowed.

Schema 9

Response 200.item.txns

Type: object.

FieldTypeRequiredConstraintsDescription
h1object · Schema 13Yes——
h24object · Schema 13Yes——
h6object · Schema 13Yes——
m5object · Schema 13Yes——

Additional fields are not allowed.

Schema 10

Response 200.item.volume_usd

Type: object.

FieldTypeRequiredConstraintsDescription
h1one or more variants · Schema 4Yes——
h24one or more variants · Schema 4Yes——
h6one or more variants · Schema 4Yes——
m5one or more variants · Schema 4Yes——

Additional fields are not allowed.

Schema 11

Response 200.meta.cc_usd

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: object · Schema 14.
  • Variant 2: null.

Schema 12

Response 200.item.liquidity.reserves

Type: object.

FieldTypeRequiredConstraintsDescription
basestringYespattern: ^-?\d+(?:\.\d+)?$—
quotestringYespattern: ^-?\d+(?:\.\d+)?$—

Additional fields are not allowed.

Schema 13

Response 200.item.txns.h1

Type: object.

FieldTypeRequiredConstraintsDescription
buysintegerYesminimum: -9007199254740991; maximum: 9007199254740991—
sellsintegerYesminimum: -9007199254740991; maximum: 9007199254740991—

Additional fields are not allowed.

Schema 14

Response 200.meta.cc_usd variant 1

Type: object.

FieldTypeRequiredConstraintsDescription
as_ofstringYes——
ratestringYespattern: ^-?\d+(?:\.\d+)?$—
sourcestringYes——
stalebooleanYes——

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.

Generated from the public API contractDeveloper settings