Get started

Endpoints · Watchlists

Create a watchlist

Creates a watchlist, optionally with instruments.

POST/api/v1/watchlists

Scope: watchlists:write

Parameters

Body

  • namestringbodyrequired

    Name, up to 80 characters.

  • instrument_idsstring[]body

    Instruments to start with, up to 200.

  • pinnedbooleanbody

    List it first. Default false.

Request
curl https://yieldsniper.finance/api/v1/watchlists \
  -H "Authorization: Bearer $YS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Treasury candidates",
    "instrument_ids": [
      "ins_4c29f40abec73e1b",
      "ins_0abd5ec576be07e6",
      "ins_2f32db0cbfbb54dd"
    ]
  }'
Response201
{
  "object": "watchlist",
  "id": "wl_6adccafe1c9b331c1d1bbfcc",
  "name": "Treasury candidates",
  "instrument_ids": [
    "ins_4c29f40abec73e1b",
    "ins_0abd5ec576be07e6",
    "ins_2f32db0cbfbb54dd"
  ],
  "pinned": false,
  "created_at": "2026-10-24T15:13:02.567Z",
  "updated_at": "2026-10-24T15:13:02.567Z"
}

Returns

The watchlist. 409 limit_reached when you already have 50.

Object: Watchlist