Get Cryptocurrency

getInstrumentsCryptocurrenciesSymbol

get/instruments/cryptocurrencies/{symbol}

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

Returns a single cryptocurrency instrument for the given symbol. The symbol contains a forward slash (e.g. `BTC/USD`) and must be URL-encoded (e.g. `BTC%2FUSD`) in the path.

Code samples

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

import requests

url = "https://api.cert.tastyworks.com/instruments/cryptocurrencies/BTC/USD"
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/BTC/USD", {
  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/BTC/USD", 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/BTC/USD"))
    .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	Symbol e.g. "BTC/USD"

Responses

200The cryptocurrency instrument for the requested symbol.application/json

Example response

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

Schema

datarequiredobject (Cryptocurrency)
A tradeable cryptocurrency instrument such as BTC/USD. Cryptocurrency symbols contain a forward slash and are most often traded in fractional quantities.
- idinteger <int32>
  Unique numeric identifier for the cryptocurrency instrument.
  example: 1
- activeboolean
  Whether the instrument is currently active and available for trading.
  example: true
- descriptionstring
  Full human-readable description of the cryptocurrency pair.
  example: "Bitcoin to USD"
- instrument-typestring
  Instrument type discriminator; always `Cryptocurrency` for this model.
  example: "Cryptocurrency"
- is-closing-onlyboolean
  Whether the instrument is restricted to closing transactions only.
  example: false
- short-descriptionstring
  Short human-readable name for the cryptocurrency.
  example: "Bitcoin"
- streamer-symbolstring
  Symbol used to subscribe to market data on the DXLink streamer.
  example: "BTC/USD:CXTALP"
- symbolstring
  The cryptocurrency symbol (e.g. `BTC/USD`). URL-encode the forward slash when used in a URL.
  example: "BTC/USD"
- tick-sizestring <decimal>
  Minimum price increment for the instrument. Decimal value serialized as a JSON string (e.g. "150.25").
  example: "0.01"
- destination-venue-symbolsarray<object>{6 fields}
  Symbol listings at each destination venue, including the venue's precision limits and whether the venue is routable.
contextrequiredstring
example: "/instruments/cryptocurrencies/{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 cryptocurrency exists for the given symbol. Verify the symbol and that it is URL-encoded.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 Cryptocurrency

Code samples

Parameters

Responses

Related