Reference Data

Search symbols

Changed on

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.

post/symbols

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/symbols
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Request body

substringstring

The search query for symbols.

Example request

{
  "substring": "AAPL"
}

Response

OK

idstring uuid required

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

symbolstring required

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 required

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

descriptionstring nullable

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

figi_codestring nullable

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.

Example response

[
  {
    "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
    "symbol": "VAB.TO",
    "raw_symbol": "VAB",
    "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
    "currency": {
      "id": "87b24961-b51e-4db8-9226-f198f6518a89",
      "code": "USD",
      "name": "US Dollar"
    },
    "exchange": {
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "code": "TSX",
      "mic_code": "XTSE",
      "name": "Toronto Stock Exchange",
      "timezone": "America/New_York",
      "start_time": "09:30:00",
      "close_time": "16:00:00",
      "suffix": ".TO"
    },
    "type": {
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "code": "cs",
      "description": "Common Stock",
      "is_supported": true
    },
    "figi_code": "BBG000B9XRY4",
    "figi_instrument": {
      "figi_code": "BBG000B9Y5X2",
      "figi_share_class": "BBG001S5N8V8"
    },
    "currencies": [
      {
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
        "code": "USD",
        "name": "US Dollar"
      }
    ]
  }
]

Changes

  • ee2f9f651615Revision changes
    • breaking

      the response property ////// became nullable for the status