Introduction
Automation Platform
Botmain DAO
Building Trading Strategies
API References Dev Live Stream
@botmain/common / Class

Market

A Market represents a single instrument trading on a single exchange

Properties

NameTypeDescription
active
boolean

Whether this market is currently active on the exchange

base
string

The base part of the symbol for currency-based instruments. For example for BTC/USDT, the base is BTC

baseId
string

The base currency identifier

contract
boolean

Whether the market is a future, a perpetual swap, or an option

contractSize
number

The size of one contract, only used if contract is true

defi
boolean

Whether this is a market on a decentralized exchange

display
string

Instrument symbol with exchange for UI display purposes. For example: "dex.binance-BTC/USDT"

exchange
string

The name of the exchange this market is trading on

expiry
number

The unix expiry timestamp in milliseconds, undefined for everything except market.type === future

expiryDatetime
string

Contract expiry date in iso1806 format. undefined for everything except market.type === future

future
boolean

Whether this is an expiring future

inverse
boolean

the contract is an inverse contract (settled in base currency)

limits
LimitInfo

Value limits when placing orders on this market

linear
boolean

The contract is a linear contract (settled in quote currency)

maker
number

Maker fee rate, 0.0016 = 0.16%

margin
boolean

Whether this is a margin market

mds
boolean

Whether this market is loaded from your market data server

option
boolean

Whether this is an option contract

optionType
"call" | "put"

"call" or "put" string. A call option represents an option with the right to buy and a put option represents the right to sell

percentage
boolean

Whether the taker and maker fee rate is a multiplier or a fixed flat amount

precision
Precision

The decimal precision (the number of decimals after the dot) given and accepted by the exchange for prices and amounts

quote
string

The quote part of the symbol for currency-based instruments. For example for BTC/USDT, the quote is USDT

quoteId
string

The quote currency identifier

settle
boolean

The unified currency code that the contract will settle in, only set if contract is true

source
string

Source of the market. For example, "binanceDex" or "binance"

spot
boolean

Whether this is a spot market

strike
number

Price at which a put or call option can be exercised

swap
boolean

Whether this is a perpetual swap

symbol
string

Instrument symbol. For example, binanceDex-BTC/USDT

taker
number

Taker fee rate, 0.002 = 0.2%

tierBased
boolean

Whether the fee depends on your trading tier (your trading volume)

timeframes
string[]

Available timeframes of this market on the exchange

type
string

The type of market. For example 'spot', 'future', etc