Markets

Get canonical instrument specifications for downstream services.

get/instrument-specs

Request

  • Base URL: https://testnet-api.hypercall.xyz
  • URL: https://testnet-api.hypercall.xyz/instrument-specs
  • Auth: none declared

Query parameters

currencystring nullable

Filter by currency (e.g., "BTC", "ETH"). Defaults to "BTC" when omitted.

_kindstring nullable

Option kind (unused)

statusstring nullable

Filter by instrument status. Defaults to "ACTIVE" to hide expired/settled instruments. Use "all" to return instruments in any status, or specify a comma-separated list (e.g., "ACTIVE,EXPIRED_PENDING_PRICE").

Response

List of canonical instrument specifications

base_assetstring required

Base asset for cross-venue mapping.

condition_idstring nullable

External condition identifier, if modeled.

contract_sizenumber double required

Contract size used for Greeks and notional scaling.

deliverystring nullable

Delivery mode, e.g. "CASH" or "PHYSICAL".

event_ts_nsinteger nullable

Timestamp for this spec version in nanoseconds. Currently always null: no persisted spec-change timestamp exists yet, and cache rebuild times would read as false spec changes.

exchangestring required

Venue identifier, e.g. "HYPERCALL".

exchange_symbolstring required

Native venue symbol used in REST and WebSocket calls.

expiry_nsinteger required

Expiry timestamp in nanoseconds since epoch.

initial_margin_fractionnumber double nullable

Initial margin fraction, if configured per instrument.

instrument_idstring required

Canonical string identifier used by downstream systems.

instrument_kindstring required

Instrument class: "OPTION", "PERP", "SPOT", or "FUTURE".

instrument_numeric_idinteger required

Database numeric identifier for legacy joins.

is_tradableboolean required

Whether the instrument can currently accept new trading activity.

listed_time_nsinteger nullable

First-listed time in nanoseconds, if known.

maintenance_margin_fractionnumber double nullable

Maintenance margin fraction, if configured per instrument.

maker_fee_bpsnumber double nullable

Maker fee in basis points, if configured per instrument.

min_trade_sizenumber double required

Minimum trade size.

option_kindstring nullable

Option side, "C" or "P" when this is an option.

option_token_addressstring nullable

Hypercall option token contract address, if deployed.

position_limitnumber double nullable

Per-instrument position limit, if configured.

price_decimalsinteger nullable

Decimal precision for wire price quantities.

quote_assetstring required

Quote asset for cross-venue mapping.

settle_assetstring nullable

Settlement asset for margin and PnL accounting.

settlement_hour_utcinteger nullable

UTC hour of day at which this instrument expires and settles.

settlement_oraclestring nullable

Settlement oracle identifier, if modeled.

settlement_time_utcstring nullable

UTC time of day ("HH:MM") at which this instrument expires and settles. Authoritative alongside expiry_ns; per-underlying policy.

size_decimalsinteger nullable

Decimal precision for wire size quantities.

statestring required

Lifecycle state: "OPEN", "SETTLEMENT", or "DELIVERED".

strikestring required

Strike price for derivatives. Serialized as a string.

symstring required

Trading pair for grouping, e.g. "BTC-USD".

taker_fee_bpsnumber double nullable

Taker fee in basis points, if configured per instrument.

tick_sizenumber double required

Base tick size for price rounding.

underlying_resolution_sourcestring nullable

Source used to resolve the underlying at settlement, if modeled.

Changes

No recorded changes to this operation across all 1 revision of this API.