Skip to content

Contract.md

Latest commit

 

History

History
68 lines (57 loc) · 6.37 KB

Contract.md

File metadata and controls

68 lines (57 loc) · 6.37 KB

Contract

Properties

Name Type Description Notes
name string Futures contract [optional] [default to undefined]
type string Contract type: inverse - inverse contract, direct - direct contract [optional] [default to undefined]
quantoMultiplier string The contract multiplier indicates how many units of the underlying asset the face value of one contract represents. [optional] [default to undefined]
leverageMin string Minimum leverage [optional] [default to undefined]
leverageMax string Maximum leverage [optional] [default to undefined]
maintenanceRate string The maintenance margin rate of the first tier of risk limit sheet [optional] [default to undefined]
markType string Deprecated [optional] [default to undefined]
markPrice string Current mark price [optional] [default to undefined]
indexPrice string Current index price [optional] [default to undefined]
lastPrice string Last trading price [optional] [default to undefined]
makerFeeRate string Maker fee rate, negative values indicate rebates [optional] [default to undefined]
takerFeeRate string Taker fee rate [optional] [default to undefined]
orderPriceRound string Minimum order price increment [optional] [default to undefined]
markPriceRound string Minimum mark price increment [optional] [default to undefined]
fundingRate string Current funding rate [optional] [default to undefined]
fundingInterval number Funding application interval, unit in seconds [optional] [default to undefined]
fundingNextApply number Next funding time [optional] [default to undefined]
riskLimitBase string Base risk limit (deprecated) [optional] [default to undefined]
interestRate string Interest rate parameter used in funding rate and premium-related calculations for perpetual contracts. Returned as a string decimal ratio (e.g. `0.0003`), same convention as `funding_rate` (ratio, not percent). [optional] [default to undefined]
riskLimitStep string Risk limit adjustment step (deprecated) [optional] [default to undefined]
riskLimitMax string Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits [optional] [default to undefined]
orderSizeMin string Minimum order size allowed by the contract [optional] [default to undefined]
enableDecimal boolean Whether decimal string type is supported for contract lot size. When this field is set to `true`, it indicates that the contract supports decimal lot sizes (i.e., the `size` field can use a decimal string type); when set to `false`, it indicates that the contract does not support decimal lot sizes (i.e., the `size` field can only use an integer type). [optional] [default to undefined]
orderSizeMax string Maximum order size allowed by the contract [optional] [default to undefined]
orderPriceDeviate string Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate [optional] [default to undefined]
refDiscountRate string Trading fee discount for referred users [optional] [default to undefined]
refRebateRate string Commission rate for referrers [optional] [default to undefined]
orderbookId number Orderbook update ID [optional] [default to undefined]
tradeId number Current trade ID [optional] [default to undefined]
tradeSize string Historical cumulative trading volume [optional] [default to undefined]
positionSize string Current total long position size [optional] [default to undefined]
configChangeTime number Last configuration update time [optional] [default to undefined]
inDelisting boolean `in_delisting=true` and position_size>0 indicates the contract is in delisting transition period `in_delisting=true` and position_size=0 indicates the contract is delisted [optional] [default to undefined]
ordersLimit number Maximum number of pending orders [optional] [default to undefined]
enableBonus boolean Whether bonus is enabled [optional] [default to undefined]
enableCredit boolean Whether portfolio margin account is enabled [optional] [default to undefined]
createTime number Created time of the contract [optional] [default to undefined]
fundingCapRatio string Deprecated [optional] [default to undefined]
status string Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) [optional] [default to undefined]
launchTime number Contract expiry timestamp [optional] [default to undefined]
delistingTime number Timestamp when contract enters reduce-only state [optional] [default to undefined]
delistedTime number Contract delisting time [optional] [default to undefined]
marketOrderSlipRatio string The maximum slippage allowed for market orders, with the slippage rate calculated based on the latest market price [optional] [default to undefined]
marketOrderSizeMax string The maximum number of contracts supported for market orders, with a default value of 0. When the default value is used, the maximum number of contracts is limited by the `order_size_max` field [optional] [default to undefined]
fundingRateLimit string Upper and lower limits of funding rate [optional] [default to undefined]
contractType string Contract classification type, e.g. stocks, metals, indices, forex, commodities, etc. [optional] [default to undefined]
fundingImpactValue string Funding rate depth impact value [optional] [default to undefined]

Enum: Contract.Type

  • Inverse (value: 'inverse')

  • Direct (value: 'direct')

Enum: Contract.MarkType

  • Internal (value: 'internal')

  • Index (value: 'index')