tastytradeDeveloper Docs
Legacy ↗

API Reference / Instruments

List Cryptocurrencies

getInstrumentsCryptocurrencies
get/instruments/cryptocurrencies

Base 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'

Parameters

NameInTypeDescription
symbolqueryarraySymbol(s) (example: symbol[]={value1}&symbol[]={value2})
e.g. ["BTC/USD"]

Responses

200Cryptocurrency instruments matching the requested symbols.application/json

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

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

    example: "/instruments/cryptocurrencies"

  • 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.