Response fields
brokerage_order_idstringOrder ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
ordersarray of objectsbrokerage_order_idstringOrder ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
brokerage_group_order_idstring or nullThe brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
order_rolestring or nullThe role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
statusstringIndicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:
- NONE
- PENDING
- ACCEPTED
- FAILED
- REJECTED
- CANCELED
- PARTIAL_CANCELED
- CANCEL_PENDING
- EXECUTED
- PARTIAL
- REPLACE_PENDING
- REPLACED
- EXPIRED
- QUEUED
- TRIGGERED
- ACTIVATED
universal_symbolobject or nullContains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the option_symbol field will be populated.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)Unique ID for the exchange in SnapTrade.
codestringA short name for the exchange. For standardized exchange code, please use the mic_code field.
mic_codestring or nullThe Market Identifier Code (MIC) for the exchange.
namestringThe full name of the exchange.
timezonestringThe timezone for the trading hours (start_time and close_time) of the exchange.
start_timestringThe time when the exchange opens for trading.
close_timestringThe time when the exchange closes for trading.
suffixstring or nullThe suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is .TO. See UniversalSymbol->symbol and UniversalSymbol->raw_symbol for more detail.
typeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundpm- Precious Metalsps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
option_symbolobject or nullContains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the universal_symbol field will be populated.
idstring (format: uuid)Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
tickerstringThe OCC symbol for the option.
option_typestringThe type of option. Either "CALL" or "PUT".
strike_pricenumberThe option strike price.
expiration_datestring (format: date)The option expiration date.
is_mini_optionbooleanWhether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
underlying_symbolobjectSymbol object for the underlying security of an option.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)codestringmic_codestring or nullnamestringtimezonestringstart_timestringclose_timestringsuffixstring or nulltypeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundpm- Precious Metalsps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
quote_universal_symbolobject or nullQuote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)Unique ID for the exchange in SnapTrade.
codestringA short name for the exchange. For standardized exchange code, please use the mic_code field.
mic_codestring or nullThe Market Identifier Code (MIC) for the exchange.
namestringThe full name of the exchange.
timezonestringThe timezone for the trading hours (start_time and close_time) of the exchange.
start_timestringThe time when the exchange opens for trading.
close_timestringThe time when the exchange closes for trading.
suffixstring or nullThe suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is .TO. See UniversalSymbol->symbol and UniversalSymbol->raw_symbol for more detail.
typeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundpm- Precious Metalsps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
quote_currencyobject or nullQuote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote.
actionstringThe action describes the intent or side of a trade. This is usually BUY or SELL but can include other potential values like the following depending on the specific brokerage.
- BUY
- SELL
- BUY_COVER
- SELL_SHORT
- BUY_OPEN
- BUY_CLOSE
- SELL_OPEN
- SELL_CLOSE
total_quantitystring or nullThe total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
open_quantitystring or nullThe number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
canceled_quantitystring or nullThe number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
filled_quantitystring or nullThe number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
execution_pricestring (format: decimal) or nullThe price at which the order was executed. For option orders, this represents the price per share.
limit_pricestring (format: decimal) or nullThe limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to Limit and StopLimit orders. For option orders, this represents the price per share.
stop_pricestring (format: decimal) or nullThe stop price is the price at which a stop order is triggered. Should only apply to Stop and StopLimit orders. For option orders, this represents the price per share.
trailing_stopobject or nullFor trailing stop orders, contains the trail configuration. Null for all other order types.
amountstringThe trail amount. Interpreted as dollars if type is DOLLAR, or a percentage if type is PERCENT.
typestringWhether the trail amount is a dollar amount (DOLLAR) or a percentage (PERCENT). For example, if amount is "0.60" and type is DOLLAR, the stop price will trail the market price by $0.60. If amount is "5" and type is PERCENT, the stop price will trail the market price by 5%.
order_typestring or nullThe type of order placed. The most common values are Market, Limit, Stop, and StopLimit. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
time_in_forcestringThe Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.
Day- Day. The order is valid only for the trading day on which it is placed.GTC- Good Til Canceled. The order is valid until it is executed or canceled.FOK- Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.IOC- Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.GTD- Good Til Date. The order is valid until the specified date.MOO- Market On Open. The order is to be executed at the day's opening price.EHP- Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
time_placedstring (format: date-time)The time the order was placed. This is the time the order was submitted to the brokerage.
time_updatedstring (format: date-time) or nullThe time the order was last updated in the brokerage system. This value is not always available from the brokerage.
time_executedstring (format: date-time) or nullThe time the order was executed in the brokerage system. This value is not always available from the brokerage.
expiry_datestring (format: date-time) or nullThe time the order expires. This value is not always available from the brokerage.
symbolstring (format: uuid)A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
child_brokerage_order_idsobject or nulltake_profit_order_idstringThe brokerage order ID for the take profit leg of the bracket order
stop_loss_order_idstringThe brokerage order ID for the stop loss leg of the bracket order
1{2"brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",3"orders": [4{5"brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",6"brokerage_group_order_id": "1234567890",7"order_role": "TRIGGER",8"status": "NONE",9"universal_symbol": {10"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",11"symbol": "VAB.TO",12"raw_symbol": "VAB",13"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",14"currency": {15"id": "87b24961-b51e-4db8-9226-f198f6518a89",16"code": "USD",17"name": "US Dollar"18},19"exchange": {20"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",21"code": "TSX",22"mic_code": "XTSE",23"name": "Toronto Stock Exchange",24"timezone": "America/New_York",25"start_time": "09:30:00",26"close_time": "16:00:00",27"suffix": ".TO"28},29"type": {30"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",31"code": "cs",32"description": "Common Stock",33"is_supported": true34},35"figi_code": "BBG000B9XRY4",36"figi_instrument": {37"figi_code": "BBG000B9Y5X2",38"figi_share_class": "BBG001S5N8V8"39},40"currencies": [41{42"id": "87b24961-b51e-4db8-9226-f198f6518a89",43"code": "USD",44"name": "US Dollar"45}46]47},48"option_symbol": {49"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",50"ticker": "AAPL 261218C00240000",51"option_type": "CALL",52"strike_price": 240,53"expiration_date": "2026-12-18T00:00:00.000Z",54"is_mini_option": false,55"underlying_symbol": {56"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",57"symbol": "SPY",58"raw_symbol": "VAB",59"description": "SPDR S&P 500 ETF Trust",60"currency": {61"id": "87b24961-b51e-4db8-9226-f198f6518a89",62"code": "USD",63"name": "US Dollar"64},65"exchange": {66"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",67"code": "ARCX",68"mic_code": "ARCA",69"name": "NYSE ARCA",70"timezone": "America/New_York",71"start_time": "09:30:00",72"close_time": "16:00:00",73"suffix": "None",74"allows_cryptocurrency_symbols": false75},76"type": {77"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",78"code": "cs",79"description": "Common Stock",80"is_supported": true81},82"figi_code": "BBG000B9XRY4",83"figi_instrument": {84"figi_code": "BBG000B9Y5X2",85"figi_share_class": "BBG001S5N8V8"86},87"currencies": [88{89"id": "87b24961-b51e-4db8-9226-f198f6518a89",90"code": "USD",91"name": "US Dollar"92}93]94}95},96"quote_universal_symbol": {97"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",98"symbol": "VAB.TO",99"raw_symbol": "VAB",100"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",101"currency": {102"id": "87b24961-b51e-4db8-9226-f198f6518a89",103"code": "USD",104"name": "US Dollar"105},106"exchange": {107"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",108"code": "TSX",109"mic_code": "XTSE",110"name": "Toronto Stock Exchange",111"timezone": "America/New_York",112"start_time": "09:30:00",113"close_time": "16:00:00",114"suffix": ".TO"115},116"type": {117"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",118"code": "cs",119"description": "Common Stock",120"is_supported": true121},122"figi_code": "BBG000B9XRY4",123"figi_instrument": {124"figi_code": "BBG000B9Y5X2",125"figi_share_class": "BBG001S5N8V8"126},127"currencies": [128{129"id": "87b24961-b51e-4db8-9226-f198f6518a89",130"code": "USD",131"name": "US Dollar"132}133]134},135"quote_currency": {136"id": "87b24961-b51e-4db8-9226-f198f6518a89",137"code": "USD",138"name": "US Dollar"139},140"action": "string",141"total_quantity": "100",142"open_quantity": "10",143"canceled_quantity": "10",144"filled_quantity": "80",145"execution_price": "12.34",146"limit_price": "12.34",147"stop_price": "12.50",148"trailing_stop": {149"amount": "0.60",150"type": "DOLLAR"151},152"order_type": "Market",153"time_in_force": "string",154"time_placed": "2024-07-30T22:51:49.746Z",155"time_updated": "2024-08-05T00:05:57.409Z",156"time_executed": "2024-08-05T00:05:57.409Z",157"expiry_date": "2024-08-05T00:05:57.409Z",158"symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",159"child_brokerage_order_ids": {160"take_profit_order_id": "12345678",161"stop_loss_order_id": "12345678"162}163}164]165}