Instruments

Search and retrieve ticker metadata

The instruments endpoints give you structured metadata for any symbol in the StratAlerts universe. Use the list endpoint to search or filter by symbol, then use the detail endpoint when you need a single record by exact ticker. Both endpoints require the metadata:read scope and return the same object shape.

GET /instruments

Returns a paginated list of instruments. You can filter by a comma-separated set of symbols, run a prefix/substring search, or simply page through the full universe. GET https://app.stratalerts.com/api/market/v1/instruments

Requires scope: metadata:read

Request parameters

string

Comma-separated list of ticker symbols to retrieve. Symbols are normalized to uppercase. Maximum 250. When provided alongside search, only symbols that also match the search string are returned.

string

Substring filter applied to the symbol field (case-insensitive). Useful for finding symbols when you only know part of the ticker.

number

default:"50"

Maximum number of instruments to return. Clamped to the range 1–200.

Response fields

object[]

required

Array of instrument objects.

Show instrument object

string

required

Ticker symbol, uppercased (e.g., AAPL).

string

required

Full company or instrument name.

string

required

Asset class: stocks, futures, crypto, or empty string if unknown.

string

required

Primary exchange abbreviation (e.g., NASDAQ, NYSE).

string

required

Instrument type string from the underlying data provider (e.g., CS for common stock).

string

required

GICS sector name, or empty string for instruments without sector classification.

boolean

required

true if the symbol is actively tracked and receiving data.

Code examples

curl -G "https://app.stratalerts.com/api/market/v1/instruments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "symbols=AAPL,MSFT,NVDA" \
  --data-urlencode "limit=10"

import requests

resp = requests.get(
    "https://app.stratalerts.com/api/market/v1/instruments",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"symbols": "AAPL,MSFT,NVDA", "limit": 10},
)
resp.raise_for_status()
data = resp.json()
for instrument in data["items"]:
    print(instrument["symbol"], instrument["name"])

const resp = await fetch(
  "https://app.stratalerts.com/api/market/v1/instruments?symbols=AAPL,MSFT,NVDA&limit=10",
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);
const data = await resp.json();
data.items.forEach(({ symbol, name }) => console.log(symbol, name));

Example response

{
  "items": [
    {
      "symbol": "AAPL",
      "name": "Apple Inc.",
      "market": "stocks",
      "exchange": "NASDAQ",
      "type": "CS",
      "sector": "Information Technology",
      "active": true
    },
    {
      "symbol": "MSFT",
      "name": "Microsoft Corporation",
      "market": "stocks",
      "exchange": "NASDAQ",
      "type": "CS",
      "sector": "Information Technology",
      "active": true
    }
  ]
}

GET /instruments/

Returns a single instrument by its exact ticker symbol. The symbol in the path is normalized to uppercase before lookup. GET https://app.stratalerts.com/api/market/v1/instruments/{symbol}

Requires scope: metadata:read

Path parameters

string

required

The ticker symbol to look up (e.g., AAPL). Case-insensitive — the server normalizes to uppercase.

Response fields

Returns a single instrument object with the same fields as the list response above: symbol, name, market, exchange, type, sector, and active.

Code examples

curl "https://app.stratalerts.com/api/market/v1/instruments/AAPL" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

resp = requests.get(
    "https://app.stratalerts.com/api/market/v1/instruments/AAPL",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
resp.raise_for_status()
instrument = resp.json()
print(instrument["symbol"], instrument["sector"])

const resp = await fetch(
  "https://app.stratalerts.com/api/market/v1/instruments/AAPL",
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);
const instrument = await resp.json();
console.log(instrument.symbol, instrument.sector);

Example response

{
  "symbol": "AAPL",
  "name": "Apple Inc.",
  "market": "stocks",
  "exchange": "NASDAQ",
  "type": "CS",
  "sector": "Information Technology",
  "active": true
}

Error codes

HTTP status	Error code	Meaning
401	`missing_api_key`	No API key was provided or the key format is invalid.
403	`inactive_entitlement`	Your account does not have an active API entitlement.
403	`missing_scope`	Your API key does not have the `metadata:read` scope.
404	`unknown_symbol`	The requested symbol was not found (detail endpoint only).

Error responses use the following shape:

{
  "error": {
    "code": "unknown_symbol",
    "message": "unknown symbol"
  }
}

Overview

REST Endpoints

WebSocket

Search and retrieve ticker metadata

GET /instruments

Request parameters

Response fields

Code examples

Example response

GET /instruments/

Path parameters

Response fields

Code examples

Example response

Error codes

​Search and retrieve ticker metadata

​GET /instruments

​Request parameters

​Response fields

​Code examples

​Example response

​GET /instruments/

​Path parameters

​Response fields

​Code examples

​Example response

​Error codes

Search and retrieve ticker metadata

GET /instruments

Request parameters

Response fields

Code examples

Example response

GET /instruments/

Path parameters

Response fields

Code examples

Example response

Error codes