List Briefings
curl --request GET \
--url https://api.linqalpha.com/v1/briefings \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.linqalpha.com/v1/briefings"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.linqalpha.com/v1/briefings', 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.linqalpha.com/v1/briefings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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.linqalpha.com/v1/briefings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.linqalpha.com/v1/briefings")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linqalpha.com/v1/briefings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": {},
"payload": [
{
"id": "<string>",
"title": "<string>",
"topic": "<string>",
"tickers": [
"<string>"
],
"language": "<string>",
"scheduled_time": "<string>",
"timezone": "<string>",
"scheduled_day_of_week": 123,
"scheduled_day_of_month": 123,
"next_delivery_at": "<string>",
"is_active": true,
"source_type": "<string>",
"attach_pdf": true,
"created_at": "<string>",
"updated_at": "<string>"
}
]
}Briefing
List Briefing Schedules
Retrieve all briefing schedules for the authenticated user.
GET
/
v1
/
briefings
List Briefings
curl --request GET \
--url https://api.linqalpha.com/v1/briefings \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.linqalpha.com/v1/briefings"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.linqalpha.com/v1/briefings', 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.linqalpha.com/v1/briefings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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.linqalpha.com/v1/briefings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.linqalpha.com/v1/briefings")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linqalpha.com/v1/briefings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": {},
"payload": [
{
"id": "<string>",
"title": "<string>",
"topic": "<string>",
"tickers": [
"<string>"
],
"language": "<string>",
"scheduled_time": "<string>",
"timezone": "<string>",
"scheduled_day_of_week": 123,
"scheduled_day_of_month": 123,
"next_delivery_at": "<string>",
"is_active": true,
"source_type": "<string>",
"attach_pdf": true,
"created_at": "<string>",
"updated_at": "<string>"
}
]
}Retrieve all briefing schedules for the authenticated user.
Each briefing includes its topic, tickers, schedule configuration, and next delivery time. Use this to display an overview of all active and inactive briefings.
Response
Returns a flat array of briefing objects. Thetickers field contains resolved ticker symbols and next_delivery_at shows when the next briefing will be generated.Was this page helpful?
⌘I