Field Value Reference (Enum Values)

This section defines the allowed values for specific fields used across the OSL Spot API.


Enumerated Values Reference

Transfer Identifier

ValueDescription
TRUESupport
FALSENot supported

Withdrawal Identifier

ValueDescription
TRUESupport
FALSENot supported

Release Status

ValueDescription
offlineRemoved
grayCanary release
onlineRelease
haltSuspension

Trading Side

ValueDescription
buyBuy
sellSell

Order Type

ValueDescription
limitLimit order
marketMarket order

Order Status

ValueDescription
liveNo filled
partially_filledPartial filled
filledFilled
cancelledCancelled

Execute Strategies

ValueDescription
gtcThe standard limit order. It remains active on the order book until it is fully executed or manually cancelled by the user.
post_onlyEnsures the order is only added to the book as a Maker.
fokThe order must be executed in its entirety immediately at the specified price. If the full quantity cannot be filled at once, the entire order is cancelled.
iocAny portion of the order that can be filled immediately at the limit price will be executed. Any remaining, unfilled portion is automatically cancelled.

Self-Trade Prevention (STP)

Specified through the STP parameter when placing an order to handle matching parties that are the same user.

ValueDescription
EXPIRE_MAKERCancels the existing order on the book. The new order remains active and continues to look for other matches.
EXPIRE_TAKERCancels the new order immediately. The existing order remains on the book.
EXPIRE_BOTHCancels both the existing order on the book and the new order.

Order Channel

Used to track the order source channel.

ValueDescription
WEBWebsite
IOSiOS mobile application
ANDROIDAndroid mobile application
APIAPI trading
SYSSystem order

Order Source

Used to track the source type or role of the order.

ValueDescription
normalPlace an order normally
marketMarket order

Asset Type

ValueDescription
hold_only(Default) Displays only the coins you currently own
allDisplays every coin you have ever traded or held

Account Type

ValueDescription
spotSpot Account, can be used directly for spot trading
fundingFunding Account, including deposit funds; needs to be transferred to the Spot Account for spot trading

Role

ValueDescription
initiatorTransfer initiator
receiverTransfer recipient

Order Filled Type

ValueDescription
takerTaker
makerMaker

Deposit Type

ValueDescription
on_chainOn-chain deposit
internal_transferInternal transfer

Deposit Status

ValueDescription
pendingConfirming
failFailed
successSuccess

Deposit and Withdrawal Address Identifier

ValueDescription
on_chainOn-chain address
internal_transferUID/email/mobile