HomeDocumentationAPI Reference
Log In
API Reference

Get Ticker

Method Name

public/get_ticker

Get ticker information (best bid / ask, instrument contraints, fees info, etc.) for a single instrument

DEPRECATION NOTICE: This RPC is deprecated in favor of get_tickers on Dec 1, 2025.

Parameters

instrument_namestringrequired
Instrument name

Response

idstring or integerrequired
resultobjectrequired
result.amount_stepstringrequired
Minimum valid increment of order amount
result.base_asset_addressstringrequired
Blockchain address of the base asset
result.base_asset_sub_idstringrequired
Sub ID of the specific base asset as defined in Asset.sol
result.base_currencystringrequired
Underlying currency of base asset (ETH, BTC, etc)
result.base_feestringrequired
$ base fee added to every taker order
result.best_ask_amountstringrequired
Amount of contracts / tokens available at best ask price
result.best_ask_pricestringrequired
Best ask price
result.best_bid_amountstringrequired
Amount of contracts / tokens available at best bid price
result.best_bid_pricestringrequired
Best bid price
result.erc20_detailsobject or nullrequired
Details of the erc20 asset (if applicable)
result.erc20_details.decimalsintegerrequired
Number of decimals of the underlying on-chain ERC20 token
result.erc20_details.borrow_indexstring
Latest borrow index as per CashAsset.sol implementation
result.erc20_details.supply_indexstring
Latest supply index as per CashAsset.sol implementation
result.erc20_details.underlying_erc20_addressstring
Address of underlying on-chain ERC20 (not V2 asset)
result.fifo_min_allocationstringrequired
Minimum number of contracts that get filled using FIFO. Actual number of contracts that gets filled by FIFO will be the max between this value and (1 - pro_rata_fraction) x order_amount, plus any size leftovers due to rounding.
result.five_percent_ask_depthstringrequired
Total amount of contracts / tokens available at 5 percent above best ask price
result.five_percent_bid_depthstringrequired
Total amount of contracts / tokens available at 5 percent below best bid price
result.index_pricestringrequired
Index price
result.instrument_namestringrequired
Instrument name
result.instrument_typestringrequired
erc20, option, or perp
enum erc20optionperp
result.is_activebooleanrequired
If True: instrument is tradeable within activation and deactivation timestamps
result.maker_fee_ratestringrequired
Percent of spot price fee rate for makers
result.mark_pricestringrequired
Mark price
result.max_pricestringrequired
Maximum price at which an agressive buyer can be matched. Any portion of a market order that would execute above this price will be cancelled. A limit buy order with limit price above this value is treated as post only (i.e. it will be rejected if it would cross any existing resting order).
result.maximum_amountstringrequired
Maximum valid amount of contracts / tokens per trade
result.min_pricestringrequired
Minimum price at which an agressive seller can be matched. Any portion of a market order that would execute below this price will be cancelled. A limit sell order with limit price below this value is treated as post only (i.e. it will be rejected if it would cross any existing resting order).
result.minimum_amountstringrequired
Minimum valid amount of contracts / tokens per trade
result.option_detailsobject or nullrequired
Details of the option asset (if applicable)
result.option_details.expiryintegerrequired
Unix timestamp of expiry date (in seconds)
result.option_details.indexstringrequired
Underlying settlement price index
result.option_details.option_typestringrequired
enum CP
result.option_details.strikestringrequired
result.option_details.settlement_pricestring or null
Settlement price of the option
result.option_pricingobject or nullrequired
Greeks, forward price, iv and mark price of the instrument (options only)
result.option_pricing.ask_ivstringrequired
Implied volatility of the current best ask
result.option_pricing.bid_ivstringrequired
Implied volatility of the current best bid
result.option_pricing.deltastringrequired
Delta of the option
result.option_pricing.discount_factorstringrequired
Discount factor used to calculate option premium
result.option_pricing.forward_pricestringrequired
Forward price used to calculate option premium
result.option_pricing.gammastringrequired
Gamma of the option
result.option_pricing.ivstringrequired
Implied volatility of the option
result.option_pricing.mark_pricestringrequired
Mark price of the option
result.option_pricing.rhostringrequired
Rho of the option
result.option_pricing.thetastringrequired
Theta of the option
result.option_pricing.vegastringrequired
Vega of the option
result.perp_detailsobject or nullrequired
Details of the perp asset (if applicable)
result.perp_details.aggregate_fundingstringrequired
Latest aggregated funding as per PerpAsset.sol
result.perp_details.funding_ratestringrequired
Current hourly funding rate as per PerpAsset.sol
result.perp_details.indexstringrequired
Underlying spot price index for funding rate
result.perp_details.max_rate_per_hourstringrequired
Max rate per hour as per PerpAsset.sol
result.perp_details.min_rate_per_hourstringrequired
Min rate per hour as per PerpAsset.sol
result.perp_details.static_interest_ratestringrequired
Static interest rate as per PerpAsset.sol
result.pro_rata_amount_stepstringrequired
Pro-rata fill share of every order is rounded down to be a multiple of this number. Leftovers of the order due to rounding are filled FIFO.
result.pro_rata_fractionstringrequired
Fraction of order that gets filled using pro-rata matching. If zero, the matching is full FIFO.
result.quote_currencystringrequired
Quote currency (USD for perps, USDC for options)
result.scheduled_activationintegerrequired
Timestamp at which became or will become active (if applicable)
result.scheduled_deactivationintegerrequired
Scheduled deactivation time for instrument (if applicable)
result.taker_fee_ratestringrequired
Percent of spot price fee rate for takers
result.tick_sizestringrequired
Tick size of the instrument, i.e. minimum price increment
result.timestampintegerrequired
Timestamp of the ticker feed snapshot
result.open_interestobjectrequired
Margin type of subaccount (PM (Portfolio Margin), PM2 (Portfolio Margin 2), or SM (Standard Margin)) -> (current open interest, open interest cap, manager currency)
result.mark_price_fee_rate_capstring or null
Percent of option price fee cap, e.g. 12.5%, null if not applicable

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}