Asset by ID

All endpoints on this page are Platform API endpoints.

Canonical asset: GET /v1/assets/:assetId

Fetch a canonical asset and, optionally, attach additional “include” blocks in one request.

• Auth: x-api-key
• Scope: assets:read

Query params

• include (optional): comma-separated list of:
  • profile
  • risk
  • ohlcv
  • markets
• mint (optional): pick a specific variant mint for include computations; must be a variant of this asset.

When using includes, additional params apply:

ohlcv params

• ohlcvInterval (default 1H): one of 1m, 5m, 15m, 1H, 4H, 1D, 1W
• ohlcvFrom / ohlcvTo (unix seconds): default to last 7 days

markets params

• marketsOffset (default 0)
• marketsLimit (default 10, clamped to 1–50)

Notes

• Includes are best-effort and returned as { ok: true, data } or { ok: false, reason, message } per include key.
• This endpoint may trigger background cache warming if data is missing/stale.

Example

curl -sS "$API_BASE_URL/v1/assets/$ASSET_ID?include=profile,risk,ohlcv,markets" \
  -H "x-api-key: $API_KEY"

Variants: GET /v1/assets/:assetId/variants

List variants for a canonical asset, optionally filtered.

• Auth: x-api-key
• Scope: assets:read

Query params

• kind (optional): one of
  • native, wrapped, bridged, etf, yield, leveraged, basket, lst, stablecoin, tokenized_equity
• trustTier (optional): one of tier1, tier2, experimental

Notes

• Each returned variant includes a market snapshot when available; the server may derive a fallback market snapshot from cached DEX markets.

Example

curl -sS "$API_BASE_URL/v1/assets/$ASSET_ID/variants?trustTier=tier1" \
  -H "x-api-key: $API_KEY"

Variant market (single): GET /v1/assets/:assetId/variant-market

Fetch the cached “variant market” snapshot for a single mint of the asset.

• Auth: x-api-key
• Scope: assets:read

Query params

• mint (optional): defaults to the asset’s primary variant mint

Example

curl -sS "$API_BASE_URL/v1/assets/$ASSET_ID/variant-market" \
  -H "x-api-key: $API_KEY"

Markets: GET /v1/assets/:assetId/markets

List cached DEX markets for a mint of the asset.

• Auth: x-api-key
• Scope: assets:read

Query params

• mint (optional): defaults to the asset’s primary variant mint
• offset (default 0)
• limit (default 10, clamped to 1–50)

Notes

• Response includes protocolTokensByMarket for certain pools to help identify protocol-owned tokens.
• This endpoint may trigger background cache warming when markets are missing/stale.

OHLCV (by mint): GET /v1/assets/:assetId/ohlcv

Return OHLCV candles for a specific mint (variant).

• Auth: x-api-key
• Scope: assets:read

Query params

• mint (optional): defaults to primary variant mint
• interval (default 1H): one of 1m, 5m, 15m, 1H, 4H, 1D, 1W
• from / to (unix seconds): default to last 7 days

Notes

• When stale/missing, the server may trigger cache warming.

Price chart (canonical): GET /v1/assets/:assetId/price-chart

Return canonical price candles.

• Auth: x-api-key
• Scope: assets:read

Behavior

• If the asset has an external listing ID, this endpoint serves external provider candles (and may warm cache).
• Otherwise it falls back to mint-based OHLCV using the primary variant (or mint query param).

Profile: GET /v1/assets/:assetId/profile

Return cached external profile/market stats when the asset has an external listing ID.

• Auth: x-api-key
• Scope: assets:read

Notes

• If no external listing ID is available, response includes profile: { ok: false, reason: "not_available" }.
• When stale/missing, the server may trigger background cache warming.

Tickers: GET /v1/assets/:assetId/tickers

Return cached exchange tickers for the canonical asset (when it has an external listing ID).

• Auth: x-api-key
• Scope: assets:read

Query params

• offset (default 0)
• limit (default 10, clamped to 1–50)
• order (optional): accepted values include volume_desc etc; currently served from cached order.

Risk summary/details: GET /v1/assets/:assetId/risk-summary and /risk-details

Return a market-based score derived from cached market snapshots.

• Auth: x-api-key
• Scope: assets:read

Query params

• mint (optional): defaults to primary variant mint

Notes

• risk-details includes more inputs in the response (for debugging/scoring transparency).

Description: GET /v1/assets/:assetId/description

Return a cached per-mint description summary when available.

• Auth: x-api-key
• Scope: assets:read

Query params

• mint (optional): defaults to primary variant mint