Search symbols / SnapTrade

Search symbols

post

https://api.snaptrade.com/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.

Execute an API Request

Authentication Method

Use commercial authentication when acting on behalf of your application and passing end-user credentials with requests that require them.

Credentials

clientId

consumerKey

Request Body

substringstring

The search query for symbols.

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
import {
2
  Snaptrade,
3
  SnaptradeAuth,
4
} from "snaptrade-typescript-sdk";
5

6
const snaptrade = new Snaptrade({
7
  auth: SnaptradeAuth.commercialApiKey({
8
    consumerKey: "CONSUMER_KEY",
9
    clientId: "CLIENT_ID",
10
  }),
11
});
12

13
const response =
14
  await snaptrade.referenceData.getSymbols({
15
    substring: "AAPL",
16
  });
17
console.log(response.data);

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.

idstring (format: uuid)

Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.

symbolstring

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. Share classes and preferred series use SnapTrade's canonical dotted form, for example HBND.U.TO, FTN.PR.A.TO, and ECF.PRA.

raw_symbolstring

The raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".

descriptionstring or null

A human-readable description of the security. This is usually the company name or ETF name.

currencyobject

The currency in which the security is traded.

exchangeobject

The exchange on which the security is listed and traded.

typeobject

The type of security. For example, "Common Stock" or "ETF".

figi_codestring 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_instrumentobject or null

Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.

currenciesarray of objects

Deprecated

Refrain from usage of this field

This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.

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
    "figi_code": "BBG000B9XRY4",
29
    "figi_instrument": {
30
      "figi_code": "BBG000B9Y5X2",
31
      "figi_share_class": "BBG001S5N8V8"
32
    },
33
    "currencies": [
34
      {
35
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
36
        "code": "USD",
37
        "name": "US Dollar"
38
      }
39
    ]
40
  }
41
]