Get Instruments Info

API Description

Retrieves detailed information about trading instruments including contract specifications, trading rules, and market data. This endpoint provides essential information for trading operations. If symbol is not provided, it returns information for all instruments on the specified chain.

HTTP Request

GET /v4/public/mm/instruments-info

Request Parameters

Parameter
Type
Required
Description

chainId

uint64

Yes

Chain ID (e.g., 143 for Monad mainnet)

symbol

string

No

Trading pair symbol (e.g., BTCUSDC). If not provided, returns all instruments

Response Parameters

Parameter
Type
Description

instrumentAddress

string

Contract address of the instrument

symbol

string

Trading pair symbol (e.g., BTCUSDC)

base

object

Base asset information

-> symbol

string

Base token symbol (e.g., BTC)

quote

object

Quote asset information

-> symbol

string

Quote token symbol (e.g., USDC)

-> address

string

Quote token contract address

-> decimals

number

Quote token decimal places

market

object

Market information

-> address

string

Market contract address

-> type

string

Market type (e.g., STORK)

initialMarginRatio

number

Initial margin ratio (in basis points, e.g., 1000 = 10%)

maintenanceMarginRatio

number

Maintenance margin ratio (in basis points, e.g., 500 = 5%)

minMarginAmount

string

Minimum margin amount (in wei/smallest unit)

tradingFeeRatio

number

Trading fee ratio (in basis points, e.g., 2 = 0.02%)

protocolFeeRatio

number

Protocol fee ratio (in basis points)

tip

string

Tip amount (in wei/smallest unit)

quoteType

string

Quote type: "STABLE", "NONSTABLE", or "INVALID"

minTradeValue

string

Minimum trade value (in wei/smallest unit)

minOrderValue

string

Minimum order value (in wei/smallest unit)

minRangeValue

string

Minimum range value (in wei/smallest unit)

fundingIntervalHour

number

Funding interval in hours (0 for perpetual)

minRangeTickDelta

number

Minimum range tick delta

instrumentCondition

string

Instrument condition: "NORMAL", "FROZEN", or "RESOLVED"

placeLimitOrderPaused

boolean

Whether limit orders are paused

disableMakerOrderRebate

boolean

Whether maker order rebates are disabled

Request Example

Python (requests)

Note: This endpoint requires API authentication. See Quick Start Guide for signature generation details.

Example 1: Get specific instrument by symbol

Example 2: Get all instruments (without symbol parameter)

Response Example

Success Response

Single instrument (with symbol parameter):

Multiple instruments (without symbol parameter):

Error Response

Notes

  • This endpoint requires API authentication (see Quick Start Guide)

  • chainId is required; symbol is optional

  • If symbol is not provided, returns all instruments on the specified chain

  • If symbol is provided but not found, returns an error

  • Returns comprehensive instrument specifications including:

    • Margin requirements (initial and maintenance)

    • Fee ratios (trading and protocol)

    • Minimum trade/order/range values

    • Market type and contract addresses

    • Instrument condition and status flags

  • All amount values are returned in wei/smallest unit format (strings to preserve precision)

  • Ratios are in basis points (e.g., 1000 = 10%, 2 = 0.02%)

  • fundingIntervalHour: 0 indicates a perpetual contract

  • quoteType: "STABLE" for stablecoins, "NONSTABLE" for other tokens

  • instrumentCondition: "NORMAL" for active trading, "FROZEN" for paused, "RESOLVED" for resolved

  • Useful for validating trading parameters before placing orders

  • Rate limit: 120 requests per minute

  • Success response has code: 0 (not 200)

Last updated