tastytradeDeveloper Docs
Legacy ↗

API Reference / Watchlists

Get Pairs Watchlist

getPairsWatchlistsPairsWatchlistName
get/pairs-watchlists/{pairs_watchlist_name}

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

Returns a single read-only tastytrade pairs watchlist, including its `pairs-equations`.

Code samples

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

Parameters

NameInTypeDescription
pairs_watchlist_name*pathinteger
e.g. 1

Responses

200The requested pairs watchlist.application/json

Example response

{
  "data": {
    "name": "Index Pairs",
    "pairs-equations": {},
    "order-index": 0
  },
  "context": "/pairs-watchlists/{pairs_watchlist_name}"
}

Schema

  • datarequiredobject (PairsWatchlist)

    A read-only tastytrade-published pairs watchlist that groups related instruments via pairs equations for pairs-trading analysis. JSON keys are dasherized.

    • namestring

      The unique name of the pairs watchlist.

      example: "Index Pairs"

    • pairs-equationsobject

      The equations defining the instrument pairs tracked by this watchlist. The structure is not formally specified; inspect a live response before coding against it.

    • order-indexinteger <int32>

      The order index of the pairs watchlist.

      example: 0

  • contextrequiredstring

    example: "/pairs-watchlists/{pairs_watchlist_name}"

401Missing or invalid 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.

404The requested pairs watchlist was not found. Verify the identifier and the environment (sandbox vs production).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.

429Rate limit exceeded. Back off exponentially before retrying.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.