List Cryptocurrencies
getInstrumentsCryptocurrencies/instruments/cryptocurrenciesBase URL: https://api.cert.tastyworks.com (Sandbox) · https://api.tastyworks.com (Production)
Returns active cryptocurrency instruments, optionally filtered by one or more symbols. Cryptocurrency symbols contain a forward slash (e.g. `BTC/USD`), so URL-encode them (e.g. `BTC%2FUSD`) before placing them in query parameters.
Code samples
curl -X GET 'https://api.cert.tastyworks.com/instruments/cryptocurrencies?symbol[]=BTC%2FUSD' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'User-Agent: tastytrade-docs-example/1.0'import requests
url = "https://api.cert.tastyworks.com/instruments/cryptocurrencies?symbol[]=BTC%2FUSD"
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/cryptocurrencies?symbol[]=BTC%2FUSD", {
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/cryptocurrencies?symbol[]=BTC%2FUSD", 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/cryptocurrencies?symbol[]=BTC%2FUSD"))
.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 | query | array | Symbol(s) (example: symbol[]={value1}&symbol[]={value2}) e.g. ["BTC/USD"] |
Responses
Example response
{
"data": {
"items": [
{
"id": 1,
"active": true,
"description": "Bitcoin to USD",
"instrument-type": "Cryptocurrency",
"is-closing-only": false,
"short-description": "Bitcoin",
"streamer-symbol": "BTC/USD:CXTALP",
"symbol": "BTC/USD",
"tick-size": "0.01",
"destination-venue-symbols": [
{
"id": 1,
"symbol": "BTC",
"destination-venue": "CITADEL_CRYPTOCURRENCY",
"max-quantity-precision": 8,
"max-price-precision": 8,
"routable": true
}
]
}
]
},
"context": "/instruments/cryptocurrencies",
"pagination": {
"per-page": 0,
"page-offset": 0,
"item-offset": 0,
"total-items": 0,
"total-pages": 0,
"current-item-count": 0
}
}Schema
datarequiredobjectitemsrequiredarray<object>{10 fields}
contextrequiredstringexample:
"/instruments/cryptocurrencies"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.