API reference

32 public operations, generated from the canonical OpenAPI contract this site's client types are built from.

Contract version 1.0.0

Assets

/v1/assets/map
Map venue-listed assets to stable IDs and Canton instrument identities
networkstring
In query.
listing_statusstring
In query.
symbolstring
In query.
instrument_adminstring
In query.
instrument_idstring
In query.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/assets/listings/latest
Get ranked latest asset market data
networkstring
In query.
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
sortstring
In query.
sort_dirstring
In query.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/assets/info
Get descriptive token metadata for stable asset IDs
includestring
In query.
idsrequiredstring
One to 100 distinct stable CantonCap asset IDs, comma-separated. Unknown and unpublished IDs are omitted without revealing private records.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/assets/{asset_id}
Get one asset by stable ID
includestring
In query.
asset_idrequiredstring
Stable opaque CantonCap asset ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/assets/quotes/latest
Get latest aggregate quotes for stable asset IDs
idsrequiredstring
One to 100 distinct stable CantonCap asset IDs, comma-separated. Unknown and unpublished IDs are omitted without revealing private records.
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
price_change_periodsstring
In query.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/assets/quotes/historical
Get historical quote snapshots
idsrequiredstring
One to 100 distinct stable CantonCap asset IDs, comma-separated. Unknown and unpublished IDs are omitted without revealing private records.
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
intervalstring
UTC-aligned candle duration or historical quote sampling interval. Results are newest first; missing buckets are omitted. Quote sampling selects the latest eligible measurement in each interval.
time_startdate-time
Inclusive UTC range start; defaults to 24 hours before time_end. At most 31 days per request, further bounded by plan history depth.
time_enddate-time
Exclusive UTC range end; defaults to request time and is pinned by continuation cursors.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
/v1/assets/ohlcv/historical
Get aggregate asset OHLCV candles
idsrequiredstring
One to 100 distinct stable CantonCap asset IDs, comma-separated. Unknown and unpublished IDs are omitted without revealing private records.
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
intervalstring
UTC-aligned candle duration or historical quote sampling interval. Results are newest first; missing buckets are omitted. Quote sampling selects the latest eligible measurement in each interval.
time_startdate-time
Inclusive UTC range start; defaults to 24 hours before time_end. At most 31 days per request, further bounded by plan history depth.
time_enddate-time
Exclusive UTC range end; defaults to request time and is pinned by continuation cursors.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
/v1/assets/{asset_id}/market-chart
Get price, FDV, market-cap, and volume series for one asset
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
intervalstring
UTC-aligned candle duration or historical quote sampling interval. Results are newest first; missing buckets are omitted. Quote sampling selects the latest eligible measurement in each interval.
time_startdate-time
Inclusive UTC range start; defaults to 24 hours before time_end. At most 31 days per request, further bounded by plan history depth.
time_enddate-time
Exclusive UTC range end; defaults to request time and is pinned by continuation cursors.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
asset_idrequiredstring
Stable opaque CantonCap asset ID.
/v1/assets/market-pairs/latest
Get market pairs with current price, volume, and liquidity
idsrequiredstring
One to 100 distinct stable CantonCap asset IDs, comma-separated. Unknown and unpublished IDs are omitted without revealing private records.
venue_idstring
In query.
networkstring
In query.
modelstring
In query.
categorystring
In query.
quote_asset_idstring
In query.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/assets/{asset_id}/registry-configurations
List registry configurations for an asset
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
asset_idrequiredstring
Stable opaque CantonCap asset ID.

Global

/v1/global/metrics/latest
Get aggregate public Canton market metrics
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.

Issuers

/v1/issuers
List verified and curated issuer entities
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/issuers/{issuer_id}
Get an issuer profile and linked assets
issuer_idrequiredstring
Stable opaque CantonCap issuer ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/issuers/{issuer_id}/evidence
Get published sources for issuer profile facts
issuer_idrequiredstring
Stable opaque CantonCap issuer ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/issuers/{issuer_id}/relationships
Get published issuer validators and instrument administrators
issuer_idrequiredstring
Stable opaque CantonCap issuer ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.

Markets

/v1/markets
List venue markets
venue_idstring
In query.
asset_idstring
In query.
modelstring
In query.
categorystring
In query.
networkstring
In query.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/markets/{market_id}
Get market metadata and latest state
market_idrequiredstring
Stable opaque CantonCap market ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/markets/{market_id}/ticker
Get the latest venue ticker
market_idrequiredstring
Stable opaque CantonCap market ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/markets/{market_id}/orderbook
Get the latest public order-book snapshot
depthinteger
In query.
market_idrequiredstring
Stable opaque CantonCap market ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
POST/v1/markets/{market_id}/quote
Get a read-only venue quote
market_idrequiredstring
Stable opaque CantonCap market ID.
/v1/markets/{market_id}/trades
Get public market trades and coverage
time_startdate-time
Inclusive UTC range start; defaults to 24 hours before time_end. At most 31 days per request, further bounded by plan history depth.
time_enddate-time
Exclusive UTC range end; defaults to request time and is pinned by continuation cursors.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
market_idrequiredstring
Stable opaque CantonCap market ID.
/v1/markets/{market_id}/ohlcv
Get venue or CantonCap-rollup candles
intervalstring
UTC-aligned candle duration or historical quote sampling interval. Results are newest first; missing buckets are omitted. Quote sampling selects the latest eligible measurement in each interval.
time_startdate-time
Inclusive UTC range start; defaults to 24 hours before time_end. At most 31 days per request, further bounded by plan history depth.
time_enddate-time
Exclusive UTC range end; defaults to request time and is pinned by continuation cursors.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
market_idrequiredstring
Stable opaque CantonCap market ID.
/v1/markets/{market_id}/liquidity
Get the latest model-specific liquidity snapshot
market_idrequiredstring
Stable opaque CantonCap market ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.

Pools

/v1/pools
List liquidity pools and their asset pairs
venue_idstring
In query.
asset_idstring
In query.
networkstring
In query.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/pools/{pool_id}
Get pool information and its asset pair
pool_idrequiredstring
Stable opaque CantonCap pool ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
POST/v1/pools/{pool_id}/quote
Get a read-only executable venue pool quote
pool_idrequiredstring
Stable opaque CantonCap pool ID.

Simple

/v1/simple/price
Get latest prices for stable asset IDs
idsrequiredstring
One to 100 distinct stable CantonCap asset IDs, comma-separated. Unknown and unpublished IDs are omitted without revealing private records.
convertstring
One ISO-style quote currency code, or a comma-delimited set where the operation explicitly documents a bounded collection.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.

Status

/v1/status/sources
Get market-data availability and freshness

Venues

/v1/venues
List venues and current data availability
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/venues/{venue_id}
Get venue detail and source-reported statistics
venue_idrequiredstring
Stable CantonCap venue ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/venues/{venue_id}/markets
List markets supplied by a venue
networkstring
In query.
modelstring
In query.
categorystring
In query.
quote_asset_idstring
In query.
limitinteger
Maximum page size, bounded by the caller's plan.
cursorstring
Opaque continuation cursor from the previous response.
venue_idrequiredstring
Stable CantonCap venue ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.
/v1/venues/{venue_id}/capabilities
Get supported market-data features and history for a venue
venue_idrequiredstring
Stable CantonCap venue ID.
If-None-Matchstring
Return 304 when this entity tag matches the current representation.