v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB

Watchlist

Update a Watchlist

Replace entirely the set of securities contained in the watchlist while optionally renaming it. Destructive operation.

put/v1/trading/accounts/{account_id}/watchlists/{watchlist_id}

Request body

namestring required

The watchlist name

symbolsstring[] required

The new list of symbol names to watch

Example request

{
  "symbols": [
    "[\"AAPL\", \"TSLA\"]"
  ]
}

Response

Updated watchlist.

account_idstring uuid required

Unique identifier of the account that owns this watchlist.

created_atstring date-time required

When watchlist was created

idstring uuid required

Unique identifier of the watchlist itself.

namestring required

User friendly Name of watchlist

updated_atstring date-time required

When watchlist was last updated

Example response

{
  "assets": [
    {
      "attributes": [
        "ptp_no_exception",
        "ipo"
      ],
      "borrow_status": "easy_to_borrow",
      "easy_to_borrow": true,
      "exchange": "NASDAQ",
      "fractionable": true,
      "id": "904837e3-3b76-47ec-b432-046db621571b",
      "marginable": true,
      "name": "Apple Inc. Common Stock",
      "shortable": true,
      "status": "active",
      "symbol": "AAPL",
      "tradable": true
    }
  ]
}