Type Reference

Definition of structures and enums referenced in request or response values

chevron-rightStrategy [Enum]hashtag

TWAP - Time weighted average price

VWAP - Volume weighted average price

IS - Implementation shortfall (arrival price)

Target Time - Volume weighted average price

Market - Market order

Limit - Limit order

Iceberg - Iceberg order

IOC - Immediate or Cancel

chevron-rightStrategyParams [Structure]hashtag

passive_only boolean Passive position when placing a take order

active_limit boolean Aggressively repegs child orders

reduce_only boolean Only send orders that reduce the size of a current position

ool_pause boolean See OOL Pause

strict_durationarrow-up-right boolean Ensure the order finishes at the end time, regardless of fills

dicy boolean Enable DiCy

spot_leverage boolean Sets the isLeverage parameter for BinancePM and Bybit orders

max_clip_size integer Maximum clip size, if not set, uses dynamic (optional)

chevron-rightOrderStatus [Enum]hashtag

SCHEDULED - Order has been scheduled and will be executed (skipped if started immediately)

ACTIVE - Order is being executed within the designated time window

FINISHER - Last portion of order is being executed

COMPLETE - Execution is complete

CANCELED - Order has been cancelled

PAUSED - Order has been paused

chevron-rightMultiOrderStatus [Enum]hashtag

ACTIVE - Order is being executed within the designated time window

COMPLETE - Execution is complete

CANCELED - Order has been cancelled

PAUSED - Order has been paused

chevron-rightMarketType [Enum]hashtag

spot - spot market

perp - perpetual futures/swaps market

# Not yet available

future

option

# only for balances

unified - unified wallet

chevron-rightAssetType [Enum]hashtag

token - asset is a token

position - asset is a contract/position

chevron-rightExchange [Enum]hashtag

Binance

Bybit

OKX

Last updated

Was this helpful?