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_name  string required
Instrument name

Response

id  string or integer required
result  object required
result. amount_step  string required
Minimum valid increment of order amount
result. base_asset_address  string required
Blockchain address of the base asset
result. base_asset_sub_id  string required
Sub ID of the specific base asset as defined in Asset.sol
result. base_currency  string required
Underlying currency of base asset (ETH, BTC, etc)
result. base_fee  string required
$ base fee added to every taker order
result. best_ask_amount  string required
Amount of contracts / tokens available at best ask price
result. best_ask_price  string required
Best ask price
result. best_bid_amount  string required
Amount of contracts / tokens available at best bid price
result. best_bid_price  string required
Best bid price
result. erc20_details  object or null required
Details of the erc20 asset (if applicable)
result.erc20_details. decimals  integer required
Number of decimals of the underlying on-chain ERC20 token
result.erc20_details. borrow_index  string
Latest borrow index as per CashAsset.sol implementation
result.erc20_details. supply_index  string
Latest supply index as per CashAsset.sol implementation
result.erc20_details. underlying_erc20_address  string
Address of underlying on-chain ERC20 (not V2 asset)
result. fifo_min_allocation  string required
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_depth  string required
Total amount of contracts / tokens available at 5 percent above best ask price
result. five_percent_bid_depth  string required
Total amount of contracts / tokens available at 5 percent below best bid price
result. index_price  string required
Index price
result. instrument_name  string required
Instrument name
result. instrument_type  string required
erc20, option, or perp
enum erc20 option perp
result. is_active  boolean required
If True: instrument is tradeable within activation and deactivation timestamps
result. maker_fee_rate  string required
Percent of spot price fee rate for makers
result. mark_price  string required
Mark price
result. max_price  string required
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_amount  string required
Maximum valid amount of contracts / tokens per trade
result. min_price  string required
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_amount  string required
Minimum valid amount of contracts / tokens per trade
result. option_details  object or null required
Details of the option asset (if applicable)
result.option_details. expiry  integer required
Unix timestamp of expiry date (in seconds)
result.option_details. index  string required
Underlying settlement price index
result.option_details. option_type  string required
enum C P
result.option_details. strike  string required
result.option_details. settlement_price  string or null
Settlement price of the option
result. option_pricing  object or null required
Greeks, forward price, iv and mark price of the instrument (options only)
result.option_pricing. ask_iv  string required
Implied volatility of the current best ask
result.option_pricing. bid_iv  string required
Implied volatility of the current best bid
result.option_pricing. delta  string required
Delta of the option
result.option_pricing. discount_factor  string required
Discount factor used to calculate option premium
result.option_pricing. forward_price  string required
Forward price used to calculate option premium
result.option_pricing. gamma  string required
Gamma of the option
result.option_pricing. iv  string required
Implied volatility of the option
result.option_pricing. mark_price  string required
Mark price of the option
result.option_pricing. rho  string required
Rho of the option
result.option_pricing. theta  string required
Theta of the option
result.option_pricing. vega  string required
Vega of the option
result. perp_details  object or null required
Details of the perp asset (if applicable)
result.perp_details. aggregate_funding  string required
Latest aggregated funding as per PerpAsset.sol
result.perp_details. funding_rate  string required
Current hourly funding rate as per PerpAsset.sol
result.perp_details. index  string required
Underlying spot price index for funding rate
result.perp_details. max_rate_per_hour  string required
Max rate per hour as per PerpAsset.sol
result.perp_details. min_rate_per_hour  string required
Min rate per hour as per PerpAsset.sol
result.perp_details. static_interest_rate  string required
Static interest rate as per PerpAsset.sol
result. pro_rata_amount_step  string required
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_fraction  string required
Fraction of order that gets filled using pro-rata matching. If zero, the matching is full FIFO.
result. quote_currency  string required
Quote currency (USD for perps, USDC for options)
result. scheduled_activation  integer required
Timestamp at which became or will become active (if applicable)
result. scheduled_deactivation  integer required
Scheduled deactivation time for instrument (if applicable)
result. taker_fee_rate  string required
Percent of spot price fee rate for takers
result. tick_size  string required
Tick size of the instrument, i.e. minimum price increment
result. timestamp  integer required
Timestamp of the ticker feed snapshot
result. open_interest  object required
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_cap  string 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}