Batch Brief
curl --request GET \
--url https://api.shoal.xyz/v1/brief/batch \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/brief/batch"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/brief/batch', 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.shoal.xyz/v1/brief/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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.shoal.xyz/v1/brief/batch"
req, _ := http.NewRequest("GET", 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.get("https://api.shoal.xyz/v1/brief/batch")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/brief/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyBrief
Batch Brief
Get combined radar and signal events for multiple organizations in one call
GET
/
v1
/
brief
/
batch
Batch Brief
curl --request GET \
--url https://api.shoal.xyz/v1/brief/batch \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/brief/batch"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/brief/batch', 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.shoal.xyz/v1/brief/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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.shoal.xyz/v1/brief/batch"
req, _ := http.NewRequest("GET", 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.get("https://api.shoal.xyz/v1/brief/batch")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/brief/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyThe batch brief endpoint is designed for AI agents and dashboards that monitor multiple organizations. Instead of making 2N calls (N radar + N signal), make 1 call for up to 25 organizations.
Invalid IDs within the batch return inline errors (not a 404), so one bad ID doesn’t fail the whole request.
Batch brief event objects follow the same canonical event contract as Radar, Signal, and Search:
Batch brief is a higher-tier endpoint. Use
/v1/brief for single-organization workflows when batch access is not available on your plan.Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ids | string | Yes | Comma-separated organization IDs (max 25) |
since | string | Yes | ISO 8601 timestamp — only events after this time |
limit | integer | No | Max events per type per org (default 5, max 10) |
compact | boolean | No | Omit evidence, bullets, owners, and participants (legacy compatibility fields are also omitted) |
Request
cURL
curl -X GET "https://api.shoal.xyz/v1/brief/batch?ids=526,765,1024&since=2026-02-01T00:00:00Z&compact=true" \
-H "Authorization: Bearer YOUR_API_KEY"
Response (200)
{
"organizations": [
{
"organizationId": 526,
"label": "Ethereum",
"radar": [...],
"signal": [...],
"counts": { "radar": 3, "signal": 2 }
},
{
"organizationId": 765,
"label": "Solana",
"radar": [...],
"signal": [...],
"counts": { "radar": 1, "signal": 4 }
},
{
"organizationId": 99999,
"label": null,
"error": "Organization not found",
"radar": [],
"signal": [],
"counts": { "radar": 0, "signal": 0 }
}
]
}
Errors
| Status | Error | Cause |
|---|---|---|
| 400 | ids parameter is required | Missing org IDs |
| 400 | No valid organization IDs provided | All IDs unparseable |
| 400 | Maximum 25 organization IDs per batch request | Too many IDs |
| 400 | since parameter is required | Missing time filter |
summarybulletsownersparticipantsevidencelatestEvidenceTimestampsignificance
Agent Usage Pattern
Python
import requests, os
API_KEY = os.environ["SHOAL_API_KEY"]
PORTFOLIO = "526,765,1024,2048,4096"
# One call for the entire portfolio
r = requests.get(
"https://api.shoal.xyz/v1/brief/batch",
headers={"Authorization": f"Bearer {API_KEY}"},
params={"ids": PORTFOLIO, "since": "2026-02-28T00:00:00Z", "compact": "true"},
)
data = r.json()
for org in data["organizations"]:
if org["counts"]["signal"] > 0:
print(f"{org['label']}: {org['counts']['signal']} new signals")