Returns metadata about all available trading instruments including base/quote currencies, minimum order sizes (lotSz), price increments (tickSz), and maximum order limits. Essential for building valid orders.
From spec: Retrieve a list of available trading instruments/pairs.
Usage Tips
- Required parameter: instType (SPOT, MARGIN, SWAP, FUTURES, OPTION)
- Optional: instId to filter specific instrument
- Use before placing orders to validate lot sizes and tick sizes
- Contains critical fields: lotSz (min order size), tickSz (price increment), minSz (minimum size)
Parameters (4)
instFamily(string, query, optional)
Instrument family (e.g., BTC-USD). Required for OPTION
instId(string, query, optional)
Specific instrument ID to query
instType(string, query, required)
Instrument type (SPOT, MARGIN, SWAP, FUTURES, OPTION)
Underlying and quote currency (e.g., BTC-USD). Deprecated
Examples (1)
Get SPOT trading instruments metadataprobe-gate
Demonstrates fetching instrument metadata for SPOT pairs including trading rules, lot sizes, tick sizes, and other configuration required for order placement.