tastytradeDeveloper Docs
Legacy ↗

API Reference / Instruments

getInstrumentsSearch

getInstrumentsSearch
get/instruments/search

Base URL: https://api.cert.tastyworks.com (Sandbox) · https://api.tastyworks.com (Production)

Search instruments by symbol, description, or tags

Code samples

curl -X GET 'https://api.cert.tastyworks.com/instruments/search?category=%7Bcategory%7D&exchange=%7Bexchange%7D&from-date=2024-01-15&instrument-sub-type=%7Binstrument-sub-type%7D&limit=1&query=%7Bquery%7D&type=%7Btype%7D' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'User-Agent: tastytrade-docs-example/1.0'

Parameters

NameInTypeDescription
categoryquerystringComma-separated categories to filter (case-insensitive)
exchangequerystringComma-separated exchanges to filter (case-insensitive)
from-datequerystringLower bound on stops_trading_at; surfaces expired events that stopped trading on/after this date
e.g. "2024-01-15"
instrument-sub-typequerystringComma-separated instrument sub-types to filter (equities only): ETF, Index
limitqueryintegerMaximum number of results
e.g. 1
queryquerystringSearch query
typequerystringComma-separated instrument types to filter

Responses

200Search instruments by symbol, description, or tagsapplication/json

Example response

{
  "data": {
    "items": [
      {
        "category": "string",
        "description": "string",
        "event-product-external-id": "abc123",
        "exchange": "string",
        "expiration-value": "100.00",
        "external-id": "abc123",
        "instrument-type": "Equity",
        "stops-trading-at": "2024-01-15T14:30:00.000Z",
        "strike-types": "string",
        "sub-category": "string",
        "symbol": "AAPL",
        "underlying-product": "string",
        "underlying-product-type": "string",
        "underlying-streamer-symbol": "AAPL"
      }
    ]
  },
  "context": "/instruments/search",
  "pagination": {
    "per-page": 0,
    "page-offset": 0,
    "item-offset": 0,
    "total-items": 0,
    "total-pages": 0,
    "current-item-count": 0
  }
}

Schema

  • datarequiredobject
    • itemsrequiredarray<object>{14 fields}
  • contextrequiredstring

    example: "/instruments/search"

  • paginationobject

    Paging metadata, present on paginated list responses.

    • per-pageinteger
    • page-offsetinteger
    • item-offsetinteger
    • total-itemsinteger
    • total-pagesinteger
    • current-item-countinteger

Related

Agents: this page is also Markdown (with the embedded OpenAPI definition) — append .md or send Accept: text/markdown. Index at /llms.txt.