Get Equity

getInstrumentsEquitiesSymbol

get/instruments/equities/{symbol}

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

Returns a single equity definition for the provided symbol (e.g. `AAPL`).

Code samples

curl -X GET 'https://api.cert.tastyworks.com/instruments/equities/AAPL' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'User-Agent: tastytrade-docs-example/1.0'

import requests

url = "https://api.cert.tastyworks.com/instruments/equities/AAPL"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "User-Agent": "tastytrade-docs-example/1.0",
}
resp = requests.get(url, headers=headers)
print(resp.status_code, resp.json())

const resp = await fetch("https://api.cert.tastyworks.com/instruments/equities/AAPL", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "User-Agent": "tastytrade-docs-example/1.0",
  },
})
const data = await resp.json()
console.log(resp.status, data)

package main

import (
	"net/http"
	"io"
	"fmt"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.cert.tastyworks.com/instruments/equities/AAPL", nil)
	req.Header.Set("Authorization", "Bearer YOUR_ACCESS_TOKEN")
	req.Header.Set("User-Agent", "tastytrade-docs-example/1.0")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(out))
}

import java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.cert.tastyworks.com/instruments/equities/AAPL"))
    .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
    .header("User-Agent", "tastytrade-docs-example/1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.statusCode() + " " + resp.body());

Parameters

Name	In	Type	Description
symbol*	path	string	The symbol of the equity, i.e. `AAPL` e.g. "AAPL"

Responses

200The equity definition for the requested symbol.application/json

Example response

{
  "data": {
    "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/{symbol}"
}

Schema

datarequiredobject (Equity)
An equity instrument (common stock, ETF, or index) identified by its ticker symbol.
- activeboolean
  Whether the equity is currently active and tradeable.
  example: true
- borrow-ratestring <decimal>
  Current rate charged to borrow shares for short selling. Decimal value serialized as a JSON string (e.g. "150.25").
  example: "0.0"
- bypass-manual-reviewboolean
- country-of-incorporationstring
- country-of-taxationstring
- descriptionstring
  Full company or fund description.
  example: "APPLE INC"
- halted-atstring <date-time>
- instrument-sub-typestring
  Optional sub-classification of the equity instrument.
  example: "Index"
- instrument-typestring
  Instrument type discriminator; always `Equity` for this model.
  example: "Equity"
- is-closing-onlyboolean
  Whether the equity is restricted to closing transactions only.
  example: false
- is-etfboolean
  Whether the equity is an exchange-traded fund.
  example: false
- is-fractional-quantity-eligibleboolean
  Whether the equity can be traded in fractional share quantities.
  example: true
- is-illiquidboolean
  Whether the equity is flagged as illiquid.
  example: false
- is-indexboolean
  Whether the equity is an index instrument.
  example: false
- is-options-closing-onlyboolean
  Whether options on this equity are restricted to closing transactions only.
  example: false
- lendabilitystring
  Borrowing classification for short selling: `Easy To Borrow`, `Locate Required`, or `Preborrow`.
  example: "Easy To Borrow"
- listed-marketstring
  Market identifier code (MIC) of the listing exchange.
  example: "XNAS"
- market-time-instrument-collectionstring
  Market-time collection used to determine trading hours for the instrument.
  example: "Equity"
- overnight-trading-permittedboolean
- short-descriptionstring
  Short human-readable name for the equity.
  example: "APPLE INC"
- stops-trading-atstring <date-time>
- streamer-symbolstring
  Symbol used to subscribe to market data on the DXLink streamer.
  example: "AAPL"
- symbolstring
  The equity ticker symbol (e.g. `AAPL`).
  example: "AAPL"
- underlying-product-typestring
- option-tick-sizesarray<object>{3 fields}
  Tick sizes for options on the equity.
  example: [{"value":"0.01","threshold":"3.0"},{"value":"0.05"}]
- tick-sizesarray<object>{3 fields}
  Tick sizes for the equity. Each entry gives a tick `value` and, when the tick applies only below a price level, a `threshold`.
  example: [{"value":"0.0001","threshold":"1.0"},{"value":"0.01"}]
- idinteger
  Unique numeric identifier of the equity instrument.
  example: 726
- cusipstring
  CUSIP identifier of the equity.
  example: "037833100"
contextrequiredstring
example: "/instruments/equities/{symbol}"

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.

404No equity exists for the given symbol. Verify the symbol is correct.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.

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.

Rate-limit class: read · idempotent — Rate limits & backoff
Error reference — codes, causes, and fixes

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

Get Equity

Code samples

Parameters

Responses

Related