tastytradeDeveloper Docs
Legacy ↗

API Reference / Watchlists

Get Watchlist

getWatchlistsWatchlistName
get/watchlists/{watchlist_name}

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

Returns a single watchlist belonging to the authenticated user, with its full `watchlist-entries`. URL-encode the name if it contains spaces (for example `Tech%20Megacaps`).

Code samples

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

Parameters

NameInTypeDescription
watchlist_name*pathstring

Responses

200The requested user watchlist.application/json

Example response

{
  "data": {
    "name": "Tech Megacaps",
    "watchlist-entries": {},
    "cms-id": "tt-tech-megacaps",
    "group-name": "Sectors",
    "order-index": 10
  },
  "context": "/watchlists/{watchlist_name}"
}

Schema

  • datarequiredobject (Watchlist)

    A named collection of instruments to track. Used for both user watchlists and read-only public watchlists. JSON keys are dasherized.

    • namestring

      The name of the watchlist. For user watchlists it is the `watchlist_name` path parameter; URL-encode it when it contains spaces.

      example: "Tech Megacaps"

    • watchlist-entriesobject

      The instruments being watched. Each entry has a `symbol` and an optional `instrument-type`.

    • cms-idstring

      Content management system identifier of the watchlist.

      example: "tt-tech-megacaps"

    • group-namestring

      The group this watchlist belongs to, used to organize related watchlists.

      example: "Sectors"

    • order-indexinteger <int32>

      The order index of the watchlist.

      example: 10

  • contextrequiredstring

    example: "/watchlists/{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.

404No watchlist exists with the given name for this user.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.