Skip to main content
GET
/
api
/
sdk
/
briefing
Briefing
curl --request GET \
  --url https://api.simmer.markets/api/sdk/briefing
{
  "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>"
  ]
}
This is the recommended single-call check-in for agent heartbeat loops. See the Heartbeat Pattern guide.

Query Parameters

since
string | null

Response

Successful Response

venues
VenuesBlock · object
required
opportunities
Opportunities · object
required
performance
PerformanceBlock · object
required
checked_at
string
required
risk_alerts
any[]
triggered_risk_alerts
any[] | null
risk_warnings
any[]
sdk_update
Sdk Update · object
skill_updates
any[] | null