Response fields
object
Account Holdings with Account ID
account
object
Holdings with account ID
id
string (format: uuid)
brokerage_authorization
string (format: uuid)
portfolio_group
string (format: uuid)
name
string or null
number
string
institution_name
string
balance
object or null
Balance of the account
total
object or null
Total value of the account, as reported by the brokerage
amount
number
currency
string
meta
object
cash_restrictions
array of objects
id
string (format: uuid)
account
string (format: uuid)
currency
string (format: uuid)
type
string
amount
number
created_date
string
Time
balances
array of objects or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
cash
number or null
buying_power
number or null
positions
array of objects or null
symbol
object
Symbol returned in position object
id
string (format: uuid)
description
string
symbol
object
Universal symbol
id
string (format: uuid)
symbol
string
raw_symbol
string
description
string or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
exchange
object
Stock Exchange
id
string (format: uuid)
code
string
mic_code
string
name
string
timezone
string
start_time
string
close_time
string
suffix
string or null
type
object
Security Type
id
string (format: uuid)
code
string
description
string
is_supported
boolean
currencies
array of objects
id
string (format: uuid)
code
string
name
string
figi_code
string or null
figi_instrument
object or null
Open FIGI Identifiers
figi_code
string or null
figi_share_class
string or null
local_id
string or null
is_quotable
boolean
is_tradable
boolean
units
number or null
price
number or null
Last known market price for the symbol
open_pnl
number or null
fractional_units
number or null
Deprecated, use the units field for both fractional and integer units going forward
average_purchase_price
number or null
Average purchase price for this position. Either returned by the underlying broker or calculated using historical transactions.
option_positions
array of objects or null
symbol
object
Option Brokerage symbol
id
string (format: uuid)
description
string
option_symbol
object
Options Symbol
id
string (format: uuid)
ticker
string
option_type
string
strike_price
number
expiration_date
string (format: datetime)
is_mini_option
boolean
underlying_symbol
object
Underlying Symbol
id
string (format: uuid)
symbol
string
description
string or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
exchange
object
US Stock Exchange
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
Security Type
id
string (format: uuid)
code
string
description
string
is_supported
boolean
currencies
array of objects
id
string (format: uuid)
code
string
name
string
figi_code
string or null
figi_instrument
object or null
Open FIGI Identifiers
figi_code
string or null
figi_share_class
string or null
local_id
string
exchange_id
string (format: uuid)
price
number or null
Trade Price if limit or stop limit order
units
number
currency
object or null
Currency
id
string (format: uuid)
code
string
name
string
average_purchase_price
number or null
Average purchase price for this position
orders
array of objects or null
brokerage_order_id
string
Order id returned by brokerage
status
string
symbol
string (format: uuid)
universal_symbol
object
Universal symbol
id
string (format: uuid)
symbol
string
raw_symbol
string
description
string or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
exchange
object
Stock Exchange
id
string (format: uuid)
code
string
mic_code
string
name
string
timezone
string
start_time
string
close_time
string
suffix
string or null
type
object
Security Type
id
string (format: uuid)
code
string
description
string
is_supported
boolean
currencies
array of objects
id
string (format: uuid)
code
string
name
string
figi_code
string or null
figi_instrument
object or null
Open FIGI Identifiers
figi_code
string or null
figi_share_class
string or null
option_symbol
object
Options Symbol
id
string (format: uuid)
ticker
string
option_type
string
strike_price
number
expiration_date
string (format: datetime)
is_mini_option
boolean
underlying_symbol
object
Underlying Symbol
id
string (format: uuid)
symbol
string
description
string or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
exchange
object
US Stock Exchange
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
Security Type
id
string (format: uuid)
code
string
description
string
is_supported
boolean
currencies
array of objects
id
string (format: uuid)
code
string
name
string
figi_code
string or null
figi_instrument
object or null
Open FIGI Identifiers
figi_code
string or null
figi_share_class
string or null
local_id
string
exchange_id
string (format: uuid)
action
string
Trade Action potential values include (but are not limited to) - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
total_quantity
number or null
Trade Units. Cannot work with notional value.
open_quantity
number or null
Trade Units
canceled_quantity
number or null
Trade Units
filled_quantity
number or null
Trade Units
execution_price
number or null
Trade Price if limit or stop limit order
limit_price
number or null
Trade Price if limit or stop limit order
stop_price
number or null
Stop Price. If stop loss or stop limit order, the price to trigger the stop
order_type
string or null
Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
time_in_force
string
Trade time in force examples:
- FOK - Fill Or Kill
- Day - Day
- GTC - Good Til Canceled
- GTD - Good Til Date
time_placed
string
Time
time_updated
string or null
Time
time_executed
string or null
Time
expiry_date
string
Time
total_value
object
Calculated based on the sum of the values of account positions and cash balances
value
number or null
currency
string or null
1{2"account": {3"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",4"brokerage_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",5"portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",6"name": "Registered Retirement Savings Account",7"number": "Q6542138443",8"institution_name": "Alpaca",9"balance": null,10"meta": {11"type": "Margin",12"status": "ACTIVE",13"institution_name": "Alpaca"14},15"cash_restrictions": [16{17"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",18"account": "2bcd7cc3-e922-4976-bce1-9858296801c3",19"currency": "2bcd7cc3-e922-4976-bce1-9858296801c3",20"type": "ALLOCATE_MAX",21"amount": 10022}23],24"created_date": "2022-01-21T20:11:19.217Z"25},26"balances": [27{28"currency": {29"id": "87b24961-b51e-4db8-9226-f198f6518a89",30"code": "USD",31"name": "US Dollar"32},33"cash": 300.71,34"buying_power": 410.7135}36],37"positions": [38{39"symbol": {40"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",41"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",42"symbol": {43"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",44"symbol": "VAB.TO",45"raw_symbol": "VAB",46"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",47"currency": {48"id": "87b24961-b51e-4db8-9226-f198f6518a89",49"code": "USD",50"name": "US Dollar"51},52"exchange": {53"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",54"code": "TSX",55"mic_code": "XTSE",56"name": "Toronto Stock Exchange",57"timezone": "America/New_York",58"start_time": "09:30:00",59"close_time": "16:00:00",60"suffix": ".TO"61},62"type": {63"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",64"code": "cs",65"description": "Common Stock",66"is_supported": true67},68"currencies": [69{70"id": "87b24961-b51e-4db8-9226-f198f6518a89",71"code": "USD",72"name": "US Dollar"73}74],75"figi_code": "BBG000B9XRY4",76"figi_instrument": {77"figi_code": "BBG000B9Y5X2",78"figi_share_class": "BBG001S5N8V8"79}80},81"local_id": "3291231",82"is_quotable": true,83"is_tradable": true84},85"units": 40,86"price": 113.15,87"open_pnl": 0.44,88"fractional_units": 1.44,89"average_purchase_price": 108.335390}91],92"option_positions": [93{94"symbol": {95"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",96"description": "SPY CALL 7/17 200",97"option_symbol": {98"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",99"ticker": "SPY 220819P00200000",100"option_type": "CALL",101"strike_price": 200,102"expiration_date": "2017-07-17T15:13:07.177712+00:00",103"is_mini_option": false,104"underlying_symbol": {105"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",106"symbol": "SPY",107"description": "SPDR S&P 500 ETF Trust",108"currency": {109"id": "87b24961-b51e-4db8-9226-f198f6518a89",110"code": "USD",111"name": "US Dollar"112},113"exchange": {114"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",115"code": "ARCX",116"mic_code": "ARCA",117"name": "NYSE ARCA",118"timezone": "America/New_York",119"start_time": "09:30:00",120"close_time": "16:00:00",121"suffix": "None",122"allows_cryptocurrency_symbols": false123},124"type": {125"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",126"code": "cs",127"description": "Common Stock",128"is_supported": true129},130"currencies": [131{132"id": "87b24961-b51e-4db8-9226-f198f6518a89",133"code": "USD",134"name": "US Dollar"135}136],137"figi_code": "BBG000B9XRY4",138"figi_instrument": {139"figi_code": "BBG000B9Y5X2",140"figi_share_class": "BBG001S5N8V8"141}142},143"local_id": "40817960",144"exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"145}146},147"price": 31.33,148"units": 10,149"currency": {150"id": "87b24961-b51e-4db8-9226-f198f6518a89",151"code": "USD",152"name": "US Dollar"153},154"average_purchase_price": 108.3353155}156],157"orders": [158{159"brokerage_order_id": "string",160"status": "NONE",161"symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",162"universal_symbol": {163"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",164"symbol": "VAB.TO",165"raw_symbol": "VAB",166"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",167"currency": {168"id": "87b24961-b51e-4db8-9226-f198f6518a89",169"code": "USD",170"name": "US Dollar"171},172"exchange": {173"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",174"code": "TSX",175"mic_code": "XTSE",176"name": "Toronto Stock Exchange",177"timezone": "America/New_York",178"start_time": "09:30:00",179"close_time": "16:00:00",180"suffix": ".TO"181},182"type": {183"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",184"code": "cs",185"description": "Common Stock",186"is_supported": true187},188"currencies": [189{190"id": "87b24961-b51e-4db8-9226-f198f6518a89",191"code": "USD",192"name": "US Dollar"193}194],195"figi_code": "BBG000B9XRY4",196"figi_instrument": {197"figi_code": "BBG000B9Y5X2",198"figi_share_class": "BBG001S5N8V8"199}200},201"option_symbol": {202"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",203"ticker": "SPY 220819P00200000",204"option_type": "CALL",205"strike_price": 200,206"expiration_date": "2017-07-17T15:13:07.177712+00:00",207"is_mini_option": false,208"underlying_symbol": {209"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",210"symbol": "SPY",211"description": "SPDR S&P 500 ETF Trust",212"currency": {213"id": "87b24961-b51e-4db8-9226-f198f6518a89",214"code": "USD",215"name": "US Dollar"216},217"exchange": {218"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",219"code": "ARCX",220"mic_code": "ARCA",221"name": "NYSE ARCA",222"timezone": "America/New_York",223"start_time": "09:30:00",224"close_time": "16:00:00",225"suffix": "None",226"allows_cryptocurrency_symbols": false227},228"type": {229"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",230"code": "cs",231"description": "Common Stock",232"is_supported": true233},234"currencies": [235{236"id": "87b24961-b51e-4db8-9226-f198f6518a89",237"code": "USD",238"name": "US Dollar"239}240],241"figi_code": "BBG000B9XRY4",242"figi_instrument": {243"figi_code": "BBG000B9Y5X2",244"figi_share_class": "BBG001S5N8V8"245}246},247"local_id": "40817960",248"exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"249},250"action": "string",251"total_quantity": 0,252"open_quantity": 0,253"canceled_quantity": 0,254"filled_quantity": 0,255"execution_price": 31.33,256"limit_price": 31.33,257"stop_price": 31.33,258"order_type": "string",259"time_in_force": "string",260"time_placed": "2022-01-21T20:11:19.217Z",261"time_updated": "2022-01-21T20:11:19.217Z",262"time_executed": "2022-01-21T20:11:19.217Z",263"expiry_date": "2022-01-21T20:11:19.217Z"264}265],266"total_value": {267"value": 32600.71,268"currency": "USD"269}270}