---
title: "Add Watchlist Item"
method: POST
path: "/v1/watchlists/{watchlist_id}/items"
tags: ["Watchlist"]
---

# Add Watchlist Item

`POST /v1/watchlists/{watchlist_id}/items`

Add an instrument to a watchlist

## Path parameters

- `watchlist_id` string, uuid, required

## Request body

- AddWatchlistItemRequest — Request to add an instrument to a watchlist
  - `instrument_id` union, required — Instrument identifier: either an instrument identifier or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.
    - string, uuid — Instrument identifier
    - string — Symbol (symbol for equities, OSI for options)

## Response `200`

Item added successfully

- object
  - `error` ApiError — A direct mapping of tonic::Status, for use in HTTP responses.
    - `code` integer, required — The error code is used to identify the nature of the error. It corresponds to an HTTP status code.
    - `details` object[]
    - `message` string, required — A human-readable message providing more details about the error.
  - `metadata` ResponseMetadata, required — Metadata for the response. This will always contain a request ID which can be used to identify the request to Clear Street for tracing, and optionally may include pagination data.
    - `next_page_token` string, byte, nullable — Base64URL-encoded pagination token
    - `page_number` integer, nullable — Pagination. Included if this was a GET (list) response
    - `previous_page_token` string, byte, nullable — Base64URL-encoded pagination token
    - `request_id` string, required — A unique ID for this request, generated upon ingestion of the request.
    - `total_items` integer, nullable — Total number of items available (not just in this page).
    - `total_pages` integer, nullable — Total number of pages available.
  - `data` AddWatchlistItemData, required — Response data for adding a watchlist item
    - `item_id` string, uuid, required — ID of the created item

## Other responses

- `400` — Invalid request or watchlist is full
- `404` — Watchlist or instrument not found
- `409` — Instrument already exists in watchlist
- `500` — Internal server error

---

[API](https://skmtc.net/clear-street/apis/clear-street-trading-api.md) · [All operations](https://skmtc.net/clear-street/apis/clear-street-trading-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clear-street/clear-street-trading-api/revisions/80e6fb2644e0/schema)
