Response fields
object
List of orders executed within the last 24 hours
orders
array of objects
List of orders executed in the last 24 hours
brokerage_order_id
string
Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
status
string
Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
universal_symbol
object
Contains 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.
id
string (format: uuid)
Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbol
string
The 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_symbol
string
The raw symbol is symbol
with the exchange suffix removed. For example, if symbol
is "VAB.TO", then raw_symbol
is "VAB".
description
string or null
A human-readable description of the security. This is usually the company name or ETF name.
currency
object
The currency in which the security is traded.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
exchange
object
The exchange on which the security is listed and traded.
id
string (format: uuid)
Unique ID for the exchange in SnapTrade.
code
string
A short name for the exchange. For standardized exchange code, please us the mic_code
field.
mic_code
string
The Market Identifier Code (MIC) for the exchange.
name
string
The full name of the exchange.
timezone
string
The timezone for the trading hours (start_time
and close_time
) of the exchange.
start_time
string
The time when the exchange opens for trading.
close_time
string
The time when the exchange closes for trading.
suffix
string or null
The 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.
type
object
The type of security. For example, "Common Stock" or "ETF".
id
string (format: uuid)
Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
code
string
A short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad
- ADRbnd
- Bondcs
- Common Stockcef
- Closed End Fundet
- ETFoef
- Open Ended Fundps
- Preferred Stockrt
- Rightstruct
- Structured Productut
- Unitwi
- When Issuedwt
- Warrant
description
string
A human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supported
boolean
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_code
string or null
This 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_instrument
object or null
Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_code
string or null
This identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_class
string or null
This 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.
currencies
array of objects
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
option_symbol
object
Contains 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.
id
string (format: uuid)
Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
ticker
string
The OCC symbol for the option.
option_type
string
The type of option. Either "CALL" or "PUT".
strike_price
number
The option strike price.
expiration_date
string (format: date)
The option expiration date.
is_mini_option
boolean
Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
underlying_symbol
object
Symbol object for the underlying security of an option.
id
string (format: uuid)
Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbol
string
The 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_symbol
string
The raw symbol is symbol
with the exchange suffix removed. For example, if symbol
is "VAB.TO", then raw_symbol
is "VAB".
description
string or null
A human-readable description of the security. This is usually the company name or ETF name.
currency
object
The currency in which the security is traded.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
exchange
object
The exchange on which the security is listed and traded.
id
string (format: uuid)
code
string
mic_code
string
name
string
timezone
string
start_time
string
close_time
string
suffix
string or null
allows_cryptocurrency_symbols
boolean
type
object
The type of security. For example, "Common Stock" or "ETF".
id
string (format: uuid)
Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
code
string
A short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad
- ADRbnd
- Bondcs
- Common Stockcef
- Closed End Fundet
- ETFoef
- Open Ended Fundps
- Preferred Stockrt
- Rightstruct
- Structured Productut
- Unitwi
- When Issuedwt
- Warrant
description
string
A human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supported
boolean
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_code
string or null
This 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_instrument
object or null
Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_code
string or null
This identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_class
string or null
This 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.
currencies
array of objects
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
action
string
The 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_quantity
number or null
The 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_quantity
number or null
The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
canceled_quantity
number or null
The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
filled_quantity
number or null
The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
execution_price
number or null
The price at which the order was executed.
limit_price
number or null
The 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.
stop_price
number or null
The stop price is the price at which a stop order is triggered. Should only apply to Stop
and StopLimit
orders.
order_type
string or null
The 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_force
string
The 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_placed
string (format: date-time)
The time the order was placed. This is the time the order was submitted to the brokerage.
time_updated
string (format: date-time) or null
The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
time_executed
string (format: date-time) or null
The time the order was executed in the brokerage system. This value is not always available from the brokerage.
expiry_date
string (format: date-time) or null
The time the order expires. This value is not always available from the brokerage.
symbol
string (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.
1{2"orders": [3{4"brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",5"status": "NONE",6"universal_symbol": {7"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",8"symbol": "VAB.TO",9"raw_symbol": "VAB",10"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",11"currency": {12"id": "87b24961-b51e-4db8-9226-f198f6518a89",13"code": "USD",14"name": "US Dollar"15},16"exchange": {17"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",18"code": "TSX",19"mic_code": "XTSE",20"name": "Toronto Stock Exchange",21"timezone": "America/New_York",22"start_time": "09:30:00",23"close_time": "16:00:00",24"suffix": ".TO"25},26"type": {27"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",28"code": "cs",29"description": "Common Stock",30"is_supported": true31},32"figi_code": "BBG000B9XRY4",33"figi_instrument": {34"figi_code": "BBG000B9Y5X2",35"figi_share_class": "BBG001S5N8V8"36},37"currencies": [38{39"id": "87b24961-b51e-4db8-9226-f198f6518a89",40"code": "USD",41"name": "US Dollar"42}43]44},45"option_symbol": {46"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",47"ticker": "AAPL 261218C00240000",48"option_type": "CALL",49"strike_price": 240,50"expiration_date": "2026-12-18",51"is_mini_option": false,52"underlying_symbol": {53"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",54"symbol": "SPY",55"raw_symbol": "VAB",56"description": "SPDR S&P 500 ETF Trust",57"currency": {58"id": "87b24961-b51e-4db8-9226-f198f6518a89",59"code": "USD",60"name": "US Dollar"61},62"exchange": {63"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",64"code": "ARCX",65"mic_code": "ARCA",66"name": "NYSE ARCA",67"timezone": "America/New_York",68"start_time": "09:30:00",69"close_time": "16:00:00",70"suffix": "None",71"allows_cryptocurrency_symbols": false72},73"type": {74"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",75"code": "cs",76"description": "Common Stock",77"is_supported": true78},79"figi_code": "BBG000B9XRY4",80"figi_instrument": {81"figi_code": "BBG000B9Y5X2",82"figi_share_class": "BBG001S5N8V8"83},84"currencies": [85{86"id": "87b24961-b51e-4db8-9226-f198f6518a89",87"code": "USD",88"name": "US Dollar"89}90]91}92},93"action": "string",94"total_quantity": 100,95"open_quantity": 10,96"canceled_quantity": 10,97"filled_quantity": 80,98"execution_price": 12.34,99"limit_price": 12.34,100"stop_price": 12.5,101"order_type": "Market",102"time_in_force": "string",103"time_placed": "2024-07-30T22:51:49.746Z",104"time_updated": "2024-08-05T00:05:57.409Z",105"time_executed": "2024-08-05T00:05:57.409Z",106"expiry_date": "2024-08-05T00:05:57.409Z",107"symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3"108}109]110}