Briefing
curl --request GET \
--url https://api.simmer.markets/api/sdk/briefingimport requests
url = "https://api.simmer.markets/api/sdk/briefing"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.simmer.markets/api/sdk/briefing', 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.simmer.markets/api/sdk/briefing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.simmer.markets/api/sdk/briefing"
req, _ := http.NewRequest("GET", url, nil)
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.simmer.markets/api/sdk/briefing")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simmer.markets/api/sdk/briefing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"venues": {
"sim": {
"currency": "<string>",
"balance": 123,
"pnl": 0,
"realized_pnl": 123,
"unrealized_pnl": 123,
"positions_count": 0,
"positions_needing_attention": [],
"actions": []
},
"polymarket": {
"currency": "<string>",
"balance": 123,
"pnl": 0,
"realized_pnl": 123,
"unrealized_pnl": 123,
"positions_count": 0,
"positions_needing_attention": [],
"actions": []
},
"kalshi": {
"currency": "<string>",
"balance": 123,
"pnl": 0,
"realized_pnl": 123,
"unrealized_pnl": 123,
"positions_count": 0,
"positions_needing_attention": [],
"actions": []
}
},
"opportunities": {},
"performance": {
"total_pnl": 0,
"pnl_percent": 0
},
"checked_at": "<string>",
"risk_alerts": [],
"triggered_risk_alerts": [
"<unknown>"
],
"risk_warnings": [],
"sdk_update": {},
"skill_updates": [
"<unknown>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Context & Briefing
Briefing
Single-call briefing for agent heartbeat check-ins.
Returns portfolio, positions (bucketed), opportunities, and performance in one response. Replaces 5-6 separate API calls.
Parameters:
- since: ISO timestamp — only show changes since this time. Defaults to 24h ago.
Requires API key in Authorization header.
GET
/
api
/
sdk
/
briefing
Briefing
curl --request GET \
--url https://api.simmer.markets/api/sdk/briefingimport requests
url = "https://api.simmer.markets/api/sdk/briefing"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.simmer.markets/api/sdk/briefing', 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.simmer.markets/api/sdk/briefing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.simmer.markets/api/sdk/briefing"
req, _ := http.NewRequest("GET", url, nil)
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.simmer.markets/api/sdk/briefing")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simmer.markets/api/sdk/briefing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"venues": {
"sim": {
"currency": "<string>",
"balance": 123,
"pnl": 0,
"realized_pnl": 123,
"unrealized_pnl": 123,
"positions_count": 0,
"positions_needing_attention": [],
"actions": []
},
"polymarket": {
"currency": "<string>",
"balance": 123,
"pnl": 0,
"realized_pnl": 123,
"unrealized_pnl": 123,
"positions_count": 0,
"positions_needing_attention": [],
"actions": []
},
"kalshi": {
"currency": "<string>",
"balance": 123,
"pnl": 0,
"realized_pnl": 123,
"unrealized_pnl": 123,
"positions_count": 0,
"positions_needing_attention": [],
"actions": []
}
},
"opportunities": {},
"performance": {
"total_pnl": 0,
"pnl_percent": 0
},
"checked_at": "<string>",
"risk_alerts": [],
"triggered_risk_alerts": [
"<unknown>"
],
"risk_warnings": [],
"sdk_update": {},
"skill_updates": [
"<unknown>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}This is the recommended single-call check-in for agent heartbeat loops. See the Heartbeat Pattern guide.
Query Parameters
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
