List Active Equities
getInstrumentsEquitiesActive/instruments/equities/activeBase URL: https://api.cert.tastyworks.com (Sandbox) · https://api.tastyworks.com (Production)
Returns all active equities in a paginated fashion. Use `per-page` and `page-offset` to page through results, and optionally filter by lendability.
Code samples
curl -X GET 'https://api.cert.tastyworks.com/instruments/equities/active?page-offset=10&per-page=10&lendability=Easy%20To%20Borrow' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'User-Agent: tastytrade-docs-example/1.0'import requests
url = "https://api.cert.tastyworks.com/instruments/equities/active?page-offset=10&per-page=10&lendability=Easy%20To%20Borrow"
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/active?page-offset=10&per-page=10&lendability=Easy%20To%20Borrow", {
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/active?page-offset=10&per-page=10&lendability=Easy%20To%20Borrow", 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/active?page-offset=10&per-page=10&lendability=Easy%20To%20Borrow"))
.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 |
|---|---|---|---|
| page-offset | query | integer | e.g. 10 |
| per-page | query | integer | e.g. 10 |
| lendability | query | string | Lendability. i.e. `Easy To Borrow`, `Locate Required` or `Preborrow` enum: Easy To Borrow, Locate Required, Preborrow e.g. "Easy To Borrow" |
Responses
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/active",
"pagination": {
"per-page": 0,
"page-offset": 0,
"item-offset": 0,
"total-items": 0,
"total-pages": 0,
"current-item-count": 0
}
}Schema
datarequiredobjectitemsrequiredarray<object>{28 fields}
contextrequiredstringexample:
"/instruments/equities/active"paginationobjectPaging metadata, present on paginated list responses.
per-pageintegerpage-offsetintegeritem-offsetintegertotal-itemsintegertotal-pagesintegercurrent-item-countinteger
Example response
{
"error": {
"code": "unauthorized",
"message": "No valid access token was provided; access tokens expire after 15 minutes."
}
}Schema
errorrequiredobjectcoderequiredstringMachine-readable error code (see the Error reference).
messagerequiredstringHuman-readable explanation.
errorsarray<object>{3 fields}Present for multi-error / validation failures; one entry per problem.
Example response
{
"error": {
"code": "string",
"message": "string",
"errors": [
{
"code": "string",
"message": "string",
"domain": "string"
}
]
}
}Schema
errorrequiredobjectcoderequiredstringMachine-readable error code (see the Error reference).
messagerequiredstringHuman-readable explanation.
errorsarray<object>{3 fields}Present for multi-error / validation failures; one entry per problem.
Related
- 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.