Reference Data

Search account symbols

post
https://api.snaptrade.com/api/v1/accounts/{accountId}/symbols

Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.

The search results are further limited to the symbols supported by the brokerage for which the account is under.

Execute an API Request

Path
accountIdstring (format: uuid)required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

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. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Request Body
substringstring

The search query for symbols.

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

Response fields

array of objects

A list of Universal Symbol objects that match the given query.

object

Uniquely describes a single security + exchange combination across all brokerages.

1
[
2
{
3
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
4
"symbol": "VAB.TO",
5
"raw_symbol": "VAB",
6
"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
7
"currency": {
8
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
9
"code": "USD",
10
"name": "US Dollar"
11
},
12
"exchange": {
13
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
14
"code": "TSX",
15
"mic_code": "XTSE",
16
"name": "Toronto Stock Exchange",
17
"timezone": "America/New_York",
18
"start_time": "09:30:00",
19
"close_time": "16:00:00",
20
"suffix": ".TO"
21
},
22
"type": {
23
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
24
"code": "cs",
25
"description": "Common Stock",
26
"is_supported": true
27
},
28
"currencies": [
29
{
30
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
31
"code": "USD",
32
"name": "US Dollar"
33
}
34
],
35
"figi_code": "BBG000B9XRY4",
36
"figi_instrument": {
37
"figi_code": "BBG000B9Y5X2",
38
"figi_share_class": "BBG001S5N8V8"
39
}
40
}
41
]