This documentation is no longer maintained. Please visit the new documentation to get the latest information.
Skip to main content

Dictionary

Category​

CodeDescription
US_STOCKU.S. stocks
US_ETFU.S. ETFs
US_OPTIONU.S. options
JP_STOCKJ.P. stocks
JP_ETFJ.P. ETFs

Trading Hours​

FieldDescription
Y[Deprecated]Include extended trading hours
N[Deprecated]Only support regular trading hours
NIGHTOnly support night trading hours
ALL_DAYIncluded Overnight Hours, 8:00 p.m.ET - 8:00 p.m.ET(the next day)
ALLInclude extended trading hours
COREOnly support regular trading hours

ExchangeCode​

CodeDescription
NASNASDAQ Capital Market
NYSENew York Stock Exchange
ASENYSE MKT
PSENYSE Archipelago Exchange
BATBATS Exchanges
NMSNASDAQ Global Market
NSQNASDAQ Global Select Market
OTCOver The Counter Bulletin Board
PKPink Sheets

Currency​

CodeDescription
USDUS Dollar

Order Side​

CodeDescription
BUYBuy
SELLSell
SHORTShort

OrderTIF​

CodeDescription
DAYDay Order
GTCGTC Order

Order Types​

CodeDescriptionAvailable Market
LIMITLimit OrderU.S.
MARKETMarket OrderU.S.
STOP_LOSSStop OrderU.S.
STOP_LOSS_LIMITStop Limit OrderU.S.

OrderEntrustType​

CodeDescription
QTYquantity
AMOUNTamount

OrderEvent​

CodeDescription
CANCELLEDCanceled
REPLACEDRevised
REJECTEDRejected
FILLEDFilled

TrailingType​

CodeDescription
PERCENTAGEPercentage
AMOUNTAmount

AccountType​

CodeDescription
MARGINMargin Account
CASHCash Account

AccountTaxType​

CodeDescription
GENERALGeneral
SPECIFICSpecific

EventType​

CodeDescription
301Reverse stock split
302Stock split

EventStatus​

CodeDescription
IValid
UValid
CCancellation, invalid
DDeletion, invalid

EventSource​

CodeDescription
IHSIHS
EDIEDI
ICEICE
WEBULL_ARTIFICIALWebull artificial
OTC_OFFICIAL_WEBOTC official web
SOURCECCASS
WEBULL_AUDITORWebull auditor
SOURCE_NAME_JY_DBJYDB
WEBOther

MarginType​

CodeDescription
ONE_DAYThe customer's open position needs to be closed on the same day. That's the intraday margin.
INDEFINITECustomers can open positions overnight using unlimited margin.

Instrument Types​

FieldDescription
EQUITYStocks,ETFs

Currency​

FieldDescription
USDUS Dollar
JPYJapanese Yen

Market​

FieldDescription
USUS Stock Market
JPJP Stock Market

Order Status​

FieldDescription
PENDINGPending
SUBMITTEDSubmitted
CANCELLEDCanceled
FAILEDFailed
FILLEDFilled
PARTIAL_FILLEDPartial Filled

Time In Force​

FieldDescription
DAYDay Order
GTCGood 'Til Canceled

Entrust Type​

FieldDescription
QTYPlace order as per quantity
AMOUNTPlace order according to the amount

Position Intent​

FieldDescription
BUY_TO_OPENBuy to open a new position
BUY_TO_CLOSEBuy to close an existing position
SELL_TO_CLOSESell to close an existing position
SELL_TO_OPENSell to open a new position