cURL
curl --request POST \
--url 'https://api.edgeful.com/v1/settings/bookmarks' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}'import requests
url = "https://api.edgeful.com/v1/settings/bookmarks"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'add': [{'report': 'gap-fill', 'sub_report': 'by-size'}], 'remove': [{'report': 'opening-stats'}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/settings/bookmarks";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}),
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/settings/bookmarks");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/settings/bookmarks", strings.NewReader(`{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}`))
req.Header.Set("Authorization", "Bearer <api-key>")
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))
}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/bookmarks"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"add\": [{\"report\": \"gap-fill\", \"sub_report\": \"by-size\"}], \"remove\": [{\"report\": \"opening-stats\"}]}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/settings/bookmarks")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"previous": {
"stock": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
],
"session": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
]
},
"current": {
"stock": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
],
"session": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
]
},
"changed": {
"added": [
{
"report": "<string>",
"sub_report": "<string>",
"lists": [
"<string>"
]
}
],
"removed": [
{
"report": "<string>",
"sub_report": "<string>",
"lists": [
"<string>"
]
}
]
}
}settings
update bookmarks
add and remove report bookmarks by report slug and sub_report. Edgeful files each bookmark under the stock list, the session list or both from the page’s markets; adding an existing bookmark or removing a missing one changes 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.
POST
/
v1
/
settings
/
bookmarks
cURL
curl --request POST \
--url 'https://api.edgeful.com/v1/settings/bookmarks' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}'import requests
url = "https://api.edgeful.com/v1/settings/bookmarks"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'add': [{'report': 'gap-fill', 'sub_report': 'by-size'}], 'remove': [{'report': 'opening-stats'}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/settings/bookmarks";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}),
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/settings/bookmarks");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/settings/bookmarks", strings.NewReader(`{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}`))
req.Header.Set("Authorization", "Bearer <api-key>")
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))
}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/bookmarks"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"add\": [{\"report\": \"gap-fill\", \"sub_report\": \"by-size\"}], \"remove\": [{\"report\": \"opening-stats\"}]}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/settings/bookmarks")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"add": [{"report": "gap-fill", "sub_report": "by-size"}], "remove": [{"report": "opening-stats"}]}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"previous": {
"stock": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
],
"session": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
]
},
"current": {
"stock": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
],
"session": [
{
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>"
}
]
},
"changed": {
"added": [
{
"report": "<string>",
"sub_report": "<string>",
"lists": [
"<string>"
]
}
],
"removed": [
{
"report": "<string>",
"sub_report": "<string>",
"lists": [
"<string>"
]
}
]
}
}Authorizations
Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).
Body
application/json
Response
Successful Response
updated or unchanged.
the lists before this write, for undo.
Show child attributes
Show child attributes
the lists after this write.
Show child attributes
Show child attributes
what this write changed.
Show child attributes
Show child attributes
Was this page helpful?