tastytradeDeveloper Docs
Legacy ↗

API Reference / Instruments

List Equities

getInstrumentsEquities
get/instruments/equities

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

Returns equity definitions for one or more symbols. Optionally filter by lendability, or restrict results to index (`is-index`) or ETF (`is-etf`) instruments.

Code samples

curl -X GET 'https://api.cert.tastyworks.com/instruments/equities?symbol[]=AAPL&is-etf=true&is-index=true&lendability=Easy%20To%20Borrow' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'User-Agent: tastytrade-docs-example/1.0'

Parameters

NameInTypeDescription
symbolqueryarrayThe symbol of the equity(s), i.e `AAPL` (example: symbol[]={value1}&symbol[]={value2})
e.g. ["AAPL"]
is-etfquerybooleanFlag indicating if equity is an etf instrument
e.g. true
is-indexquerybooleanFlag indicating if equity is an index instrument
e.g. true
lendabilityquerystringLendability
enum: Easy To Borrow, Locate Required, Preborrow
e.g. "Easy To Borrow"

Responses

200Equity definitions matching the requested symbols and filters.application/json

Example response

{
  "data": {
    "items": [
      {
        "active": true,
        "borrow-rate": "0.0",
        "bypass-manual-review": true,
        "country-of-incorporation": "string",
        "country-of-taxation": "string",
        "description": "APPLE INC",
        "halted-at": "2024-01-15T14:30:00.000Z",
        "instrument-sub-type": "Index",
        "instrument-type": "Equity",
        "is-closing-only": false,
        "is-etf": false,
        "is-fractional-quantity-eligible": true,
        "is-illiquid": false,
        "is-index": false,
        "is-options-closing-only": false,
        "lendability": "Easy To Borrow",
        "listed-market": "XNAS",
        "market-time-instrument-collection": "Equity",
        "overnight-trading-permitted": true,
        "short-description": "APPLE INC",
        "stops-trading-at": "2024-01-15T14:30:00.000Z",
        "streamer-symbol": "AAPL",
        "symbol": "AAPL",
        "underlying-product-type": "string",
        "option-tick-sizes": [
          {
            "value": "0.01",
            "threshold": "3.0"
          },
          {
            "value": "0.05"
          }
        ],
        "tick-sizes": [
          {
            "value": "0.0001",
            "threshold": "1.0"
          },
          {
            "value": "0.01"
          }
        ],
        "id": 726,
        "cusip": "037833100"
      }
    ]
  },
  "context": "/instruments/equities",
  "pagination": {
    "per-page": 0,
    "page-offset": 0,
    "item-offset": 0,
    "total-items": 0,
    "total-pages": 0,
    "current-item-count": 0
  }
}

Schema

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

    example: "/instruments/equities"

  • paginationobject

    Paging metadata, present on paginated list responses.

    • per-pageinteger
    • page-offsetinteger
    • item-offsetinteger
    • total-itemsinteger
    • total-pagesinteger
    • current-item-countinteger
401Missing or expired access token, or a missing/malformed `User-Agent` header.application/json

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "No valid access token was provided; access tokens expire after 15 minutes."
  }
}

Schema

  • errorrequiredobject
    • coderequiredstring

      Machine-readable error code (see the Error reference).

    • messagerequiredstring

      Human-readable explanation.

    • errorsarray<object>{3 fields}

      Present for multi-error / validation failures; one entry per problem.

429Request rate exceeded. Back off exponentially and reduce request frequency.application/json

Example response

{
  "error": {
    "code": "string",
    "message": "string",
    "errors": [
      {
        "code": "string",
        "message": "string",
        "domain": "string"
      }
    ]
  }
}

Schema

  • errorrequiredobject
    • coderequiredstring

      Machine-readable error code (see the Error reference).

    • messagerequiredstring

      Human-readable explanation.

    • errorsarray<object>{3 fields}

      Present for multi-error / validation failures; one entry per problem.

Related

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