from finance_dev import FinanceDev, models
with FinanceDev(
security=models.Security(
client_id="<YOUR_CLIENT_ID_HERE>",
client_secret="<YOUR_CLIENT_SECRET_HERE>",
),
) as fd_client:
res = fd_client.watchlist.delete(watchlist_id=12345)
assert res.watchlist is not None
# Handle response
print(res.watchlist)import { FinanceDev } from "@ariesdotcom/finance-dev";
const financeDev = new FinanceDev({
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await financeDev.watchlist.delete({
watchlistId: 12345,
});
console.log(result);
}
run();curl --request DELETE \
--url https://api.aries.com/v1/config/watchlist/{watchlist_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aries.com/v1/config/watchlist/{watchlist_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aries.com/v1/config/watchlist/{watchlist_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aries.com/v1/config/watchlist/{watchlist_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.aries.com/v1/config/watchlist/{watchlist_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aries.com/v1/config/watchlist/{watchlist_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 12345,
"name": "Tech Stocks",
"symbols": [
"AAPL",
"GOOGL",
"MSFT"
]
}Delete Watchlist
Deletes a watchlist owned by the authenticated user, identified by its numeric watchlist_id. If the targeted watchlist is the user’s only remaining watchlist, the API does not remove it; instead it resets the watchlist to a default empty state (name set to Default, symbols cleared) so the user always has at least one watchlist. The affected watchlist is returned in the response so clients can refresh local state without an extra read.
Use Case: Remove an individual watchlist that is no longer needed while keeping the rest of the user’s watchlists intact.
from finance_dev import FinanceDev, models
with FinanceDev(
security=models.Security(
client_id="<YOUR_CLIENT_ID_HERE>",
client_secret="<YOUR_CLIENT_SECRET_HERE>",
),
) as fd_client:
res = fd_client.watchlist.delete(watchlist_id=12345)
assert res.watchlist is not None
# Handle response
print(res.watchlist)import { FinanceDev } from "@ariesdotcom/finance-dev";
const financeDev = new FinanceDev({
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await financeDev.watchlist.delete({
watchlistId: 12345,
});
console.log(result);
}
run();curl --request DELETE \
--url https://api.aries.com/v1/config/watchlist/{watchlist_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aries.com/v1/config/watchlist/{watchlist_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aries.com/v1/config/watchlist/{watchlist_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aries.com/v1/config/watchlist/{watchlist_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.aries.com/v1/config/watchlist/{watchlist_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aries.com/v1/config/watchlist/{watchlist_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 12345,
"name": "Tech Stocks",
"symbols": [
"AAPL",
"GOOGL",
"MSFT"
]
}Authorizations
OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.
Scopes
Create, update, replace, and delete your watchlists.
Path Parameters
The numeric ID of the watchlist to delete. You can get this from a previous list/create/update response (the id field in the returned watchlist).
12345
Response
Watchlist deleted, or reset to default when it was the user's only remaining watchlist. The response body contains the affected watchlist.
Saved list of symbols a user wants to monitor. Watchlists are read-only from a trading-risk perspective and do not place orders.
Watchlist identifier. Use this value when reading, updating, or deleting a specific watchlist.
Symbols from the request that could not be resolved and were dropped from symbols. Only present on create and update responses when at least one submitted symbol failed resolution.
User-facing watchlist name, such as Tech Stocks or Dividend Ideas. Show this as the list label in your app.
Symbols saved in the watchlist. Use exact uppercase ticker symbols and confirm unfamiliar symbols with symbol search. May be null for a watchlist saved through Replace All Watchlists without symbols.
Was this page helpful?