> ## Documentation Index > Fetch the complete documentation index at: https://edgeful.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # update watchlist > add and remove tickers on one market's watchlist. tickers are uppercased and must be known on that market; additions append in order and duplicates change nothing. returns the previous and current lists and what changed. this changes your account, and Edgeful shows the change after a reload. requires the key's write permission. ## OpenAPI ````yaml /openapi-public.json post /v1/settings/watchlists openapi: 3.1.0 info: title: Edgeful API description: >- Public API reference for Edgeful market analysis. The bearer token is your Edgeful API key. Reports support the docs playground. Report responses include row-level output in `detailed` only when your plan includes row-level detail. version: 1.0.0 servers: - url: https://api.edgeful.com description: Production security: - BearerAuth: [] tags: - name: reports - name: discovery - name: live data - name: settings - name: custom reports paths: /v1/settings/watchlists: post: tags: - settings summary: update watchlist description: >- add and remove tickers on one market's watchlist. tickers are uppercased and must be known on that market; additions append in order and duplicates change nothing. returns the previous and current lists and what changed. this changes your account, and Edgeful shows the change after a reload. requires the key's write permission. operationId: update_watchlist requestBody: content: application/json: schema: $ref: '#/components/schemas/WatchlistUpdateRequest' examples: default: summary: add NQ to the futures watchlist and drop YM value: market: futures add: - NQ remove: - YM required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WatchlistUpdateResponse' '400': description: >- The request names a value Edgeful cannot use; `detail` says which values are valid. content: application/json: examples: refused: summary: refused value: detail: NQX is not a futures ticker Edgeful knows. '403': description: >- Valid API key, but the account has no API-enabled subscription or the key's writes are off. content: application/json: examples: missing_entitlement: summary: missing entitlement value: detail: detail: No active subscription with API access found. code: missing_entitlement writes_disabled: summary: writes disabled value: detail: detail: >- Enable writes for this API key or connected Claude in the API dashboard. code: writes_disabled '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: >- The account's settings write budget is exhausted; wait `Retry-After` seconds. Refused attempts count too. content: application/json: examples: write_budget_exhausted: summary: write budget exhausted value: detail: detail: Settings write limit reached. Try again shortly. code: write_budget_exhausted headers: Retry-After: description: seconds to wait before sending the write again. schema: type: integer '503': description: The write budget could not be checked; retry shortly. content: application/json: examples: write_limits_unavailable: summary: write limits unavailable value: detail: detail: >- Settings write limits are temporarily unavailable. Try again shortly. code: write_limits_unavailable security: - BearerAuth: [] x-codeSamples: - lang: curl label: cURL source: |- curl --request POST \ --url 'https://api.edgeful.com/v1/settings/watchlists' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{"market": "futures", "add": ["NQ"], "remove": ["YM"]}' - lang: python label: Python source: |- import requests url = "https://api.edgeful.com/v1/settings/watchlists" headers = {"Authorization": "Bearer "} payload = {'market': 'futures', 'add': ['NQ'], 'remove': ['YM']} response = requests.post(url, headers=headers, json=payload) print(response.json()) - lang: javascript label: JavaScript source: |- const url = "https://api.edgeful.com/v1/settings/watchlists"; const options = { method: "POST", headers: { Authorization: "Bearer ", "Content-Type": "application/json" }, body: JSON.stringify({"market": "futures", "add": ["NQ"], "remove": ["YM"]}), }; const response = await fetch(url, options); const data = await response.json(); console.log(data); - lang: php label: PHP source: >- ", "Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{"market": "futures", "add": ["NQ"], "remove": ["YM"]}'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); echo $response; - lang: go label: Go source: |- package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/settings/watchlists", strings.NewReader(`{"market": "futures", "add": ["NQ"], "remove": ["YM"]}`)) req.Header.Set("Authorization", "Bearer ") req.Header.Set("Content-Type", "application/json") resp, _ := http.DefaultClient.Do(req) defer resp.Body.Close() body, _ := io.ReadAll(resp.Body) fmt.Println(string(body)) } - lang: java label: Java source: >- import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.edgeful.com/v1/settings/watchlists")) .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{\"market\": \"futures\", \"add\": [\"NQ\"], \"remove\": [\"YM\"]}")) .build(); HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); - lang: ruby label: Ruby source: >- require "net/http" require "uri" uri = URI("https://api.edgeful.com/v1/settings/watchlists") request = Net::HTTP::Post.new(uri) request["Authorization"] = "Bearer " request["Content-Type"] = "application/json" request.body = '{"market": "futures", "add": ["NQ"], "remove": ["YM"]}' response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end puts response.body components: schemas: WatchlistUpdateRequest: properties: market: type: string enum: - futures - stock - forex - crypto title: Market description: the market whose watchlist changes. add: anyOf: - items: type: string maxLength: 30 minLength: 1 type: array maxItems: 100 - type: 'null' title: Add description: >- tickers to append in order, uppercased and validated on the market; duplicates change nothing. remove: anyOf: - items: type: string maxLength: 30 minLength: 1 type: array maxItems: 100 - type: 'null' title: Remove description: tickers to drop; a missing ticker changes nothing. additionalProperties: false type: object required: - market title: WatchlistUpdateRequest WatchlistUpdateResponse: properties: status: type: string title: Status description: updated or unchanged. market: type: string title: Market description: the market. previous: items: type: string type: array title: Previous description: the list before this write, for undo. current: items: type: string type: array title: Current description: the list after this write. changed: $ref: '#/components/schemas/WatchlistChanged' description: what this write changed. additionalProperties: true type: object required: - status - market - previous - current - changed title: WatchlistUpdateResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError WatchlistChanged: properties: added: items: type: string type: array title: Added description: tickers appended. removed: items: type: string type: array title: Removed description: tickers dropped. additionalProperties: true type: object required: - added - removed title: WatchlistChanged ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Send your Edgeful API key in the Authorization header as `Bearer ` (for example, `Bearer ef_live_`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.