Market Data — Watchlist¶
⚠️ Generated file — do not edit. Regenerate with
python tools/webull-docgen/docgen.py <target>(reference,master,reconciliationorall).
Watchlist CRUD and instrument membership.
Get Watchlists¶
GET /market-data/watchlists/list
Retrieves user watchlists.
| SDK | data.GetWatchlists |
| Reference | get-watchlist.md |
Response 200
Array of objects:
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | Watchlist unique identifier | |
name |
string | Watchlist name | |
sort |
integer | Sort order number for display ordering | |
create_time |
string | Watchlist creation time | |
update_time |
string | Watchlist last update time |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Create Watchlist¶
POST /market-data/watchlists/create
Creates a new watchlist.
| SDK | data.CreateWatchlist |
| Reference | create-watchlist.md |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | Watchlist name |
sort |
integer | Sort order number (optional) |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | Newly created watchlist unique identifier |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Update Watchlist¶
POST /market-data/watchlists/update
Updates watchlist information.
| SDK | data.UpdateWatchlist |
| Reference | update-watchlist.md |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | yes | Watchlist unique identifier |
name |
string | New watchlist name (optional) | |
sort |
integer | New sort order number (optional) |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | Whether the operation was successful |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Delete Watchlist¶
POST /market-data/watchlists/delete
Deletes a watchlist.
| SDK | data.DeleteWatchlist |
| Reference | delete-watchlist.md |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | yes | Watchlist unique identifier |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | Whether the operation was successful |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Get Watchlist Instruments¶
GET /market-data/watchlists/instruments/list
Retrieves instruments in a watchlist.
| SDK | data.GetWatchlistInstruments |
| Reference | get-watchlist-instruments.md |
Request — parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
watchlist_id |
query | string | yes | Watchlist unique identifier. |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | Watchlist unique identifier | |
instruments |
array | List of instruments in the watchlist |
Nested — instruments:
| Field | Type | Required | Description |
|---|---|---|---|
instrument_id |
string | Unique identifier of the instrument (stock ID, event contract market ID, etc. unified as instrument_id) | |
symbol |
string | Trading symbol of the instrument | |
name |
string | Full name of the instrument | |
exchange_code |
string | Standardized exchange code | |
sort |
integer | Sort order within the watchlist | |
added_time |
string | Time when the instrument was added to the watchlist (ISO 8601) |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Add Watchlist Instruments¶
POST /market-data/watchlists/instruments/add
Adds instruments to a watchlist.
| SDK | data.AddWatchlistInstruments |
| Reference | add-watchlist-instruments.md |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | yes | Watchlist unique identifier |
instruments |
array | yes | List of instruments to add |
Nested — instruments:
| Field | Type | Required | Description |
|---|---|---|---|
symbol |
string | yes | Security symbol |
category |
string | yes | Security category — one of: US_STOCK, HK_STOCK |
sort |
integer | Sort order within the watchlist (optional, used for update) |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | Whether the operation was successful |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Remove Watchlist Instruments¶
POST /market-data/watchlists/instruments/remove
Removes instruments from a watchlist.
| SDK | data.RemoveWatchlistInstruments |
| Reference | remove-watchlist-instruments.md |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | yes | Watchlist unique identifier |
instruments |
array | yes | List of instruments to remove |
Nested — instruments:
| Field | Type | Required | Description |
|---|---|---|---|
symbol |
string | yes | Security symbol |
category |
string | yes | Security category — one of: US_STOCK, HK_STOCK |
sort |
integer | Sort order within the watchlist (optional, used for update) |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | Whether the operation was successful |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.
Update Watchlist Instruments¶
POST /market-data/watchlists/instruments/update
Updates instruments sort order in a watchlist.
| SDK | data.UpdateWatchlistInstruments |
| Reference | update-watchlist-instruments.md |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
watchlist_id |
string | yes | Watchlist unique identifier |
instruments |
array | yes | List of instruments to update sort order |
Nested — instruments:
| Field | Type | Required | Description |
|---|---|---|---|
symbol |
string | yes | Security symbol |
category |
string | yes | Security category — one of: US_STOCK, HK_STOCK |
sort |
integer | Sort order within the watchlist (optional, used for update) |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | Whether the operation was successful |
Errors — 401 unauthorized, 417 business error, 500 server error. See Errors.