logo
Account Information

List account orders

get
https://api.snaptrade.com/api/v1/accounts/{accountId}/orders

Fetch all recent orders from a user's account.

Execute an API Request

Path
accountIdstring (format: uuid)required

The ID of the account to get orders.

Query
userIdstringrequired

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

userSecretstringrequired

SnapTrade User Secret (generated when registering user)

statestring

defaults value is set to "all"

daysinteger (format: int32)

Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.

Authorization
Request
Installation
GitHubnpm
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

array of objects
object

Record of order in brokerageaccount

1
[
2
  {
3
    "brokerage_order_id": "string",
4
    "status": "NONE",
5
    "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",
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": true
31
      },
32
      "currencies": [
33
        {
34
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
35
          "code": "USD",
36
          "name": "US Dollar"
37
        }
38
      ],
39
      "figi_code": "BBG000B9XRY4",
40
      "figi_instrument": {
41
        "figi_code": "BBG000B9Y5X2",
42
        "figi_share_class": "BBG001S5N8V8"
43
      }
44
    },
45
    "option_symbol": {
46
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
47
      "ticker": "SPY 220819P00200000",
48
      "option_type": "CALL",
49
      "strike_price": 200,
50
      "expiration_date": "2017-07-17T15:13:07.177712+00:00",
51
      "is_mini_option": false,
52
      "underlying_symbol": {
53
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
54
        "symbol": "SPY",
55
        "description": "SPDR S&P 500 ETF Trust",
56
        "currency": {
57
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
58
          "code": "USD",
59
          "name": "US Dollar"
60
        },
61
        "exchange": {
62
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
63
          "code": "ARCX",
64
          "mic_code": "ARCA",
65
          "name": "NYSE ARCA",
66
          "timezone": "America/New_York",
67
          "start_time": "09:30:00",
68
          "close_time": "16:00:00",
69
          "suffix": "None",
70
          "allows_cryptocurrency_symbols": false
71
        },
72
        "type": {
73
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
74
          "code": "cs",
75
          "description": "Common Stock",
76
          "is_supported": true
77
        },
78
        "currencies": [
79
          {
80
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
81
            "code": "USD",
82
            "name": "US Dollar"
83
          }
84
        ],
85
        "figi_code": "BBG000B9XRY4",
86
        "figi_instrument": {
87
          "figi_code": "BBG000B9Y5X2",
88
          "figi_share_class": "BBG001S5N8V8"
89
        }
90
      },
91
      "local_id": "40817960",
92
      "exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"
93
    },
94
    "action": "string",
95
    "total_quantity": 0,
96
    "open_quantity": 0,
97
    "canceled_quantity": 0,
98
    "filled_quantity": 0,
99
    "execution_price": 31.33,
100
    "limit_price": 31.33,
101
    "stop_price": 31.33,
102
    "order_type": "string",
103
    "time_in_force": "string",
104
    "time_placed": "2022-01-21T20:11:19.217Z",
105
    "time_updated": "2022-01-21T20:11:19.217Z",
106
    "time_executed": "2022-01-21T20:11:19.217Z",
107
    "expiry_date": "2022-01-21T20:11:19.217Z"
108
  }
109
]
Made with Konfig