> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simmer.markets/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Tip>This is the recommended single-call check-in for agent heartbeat loops. See the [Heartbeat Pattern](/heartbeat) guide.</Tip>


## OpenAPI

````yaml /openapi.json get /api/sdk/briefing
openapi: 3.1.0
info:
  title: Simmer API
  description: Agent-native trading infrastructure for prediction markets.
  version: 1.0.0
servers:
  - url: https://api.simmer.markets
security: []
paths:
  /api/sdk/briefing:
    get:
      summary: Briefing
      description: >-
        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.
      operationId: api_sdk_briefing_api_sdk_briefing_get
      parameters:
        - name: since
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Since
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BriefingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    BriefingResponse:
      properties:
        venues:
          $ref: '#/components/schemas/VenuesBlock'
        opportunities:
          additionalProperties: true
          type: object
          title: Opportunities
        risk_alerts:
          items: {}
          type: array
          title: Risk Alerts
          default: []
        triggered_risk_alerts:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Triggered Risk Alerts
        risk_warnings:
          items: {}
          type: array
          title: Risk Warnings
          default: []
        performance:
          $ref: '#/components/schemas/PerformanceBlock'
        checked_at:
          type: string
          title: Checked At
        sdk_update:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Sdk Update
        skill_updates:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Skill Updates
      type: object
      required:
        - venues
        - opportunities
        - performance
        - checked_at
      title: BriefingResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    VenuesBlock:
      properties:
        sim:
          anyOf:
            - $ref: '#/components/schemas/VenueBlock'
            - type: 'null'
        polymarket:
          anyOf:
            - $ref: '#/components/schemas/VenueBlock'
            - type: 'null'
        kalshi:
          anyOf:
            - $ref: '#/components/schemas/VenueBlock'
            - type: 'null'
      type: object
      title: VenuesBlock
    PerformanceBlock:
      properties:
        total_pnl:
          type: number
          title: Total Pnl
          description: >-
            Deprecated: $SIM venue only. Use venues.sim.pnl instead. Will be
            removed in a future release.
          default: 0
        pnl_percent:
          type: number
          title: Pnl Percent
          description: >-
            Deprecated: $SIM venue only. Use venues.sim.pnl / 10000 * 100
            instead. Will be removed in a future release.
          default: 0
      additionalProperties: true
      type: object
      title: PerformanceBlock
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    VenueBlock:
      properties:
        currency:
          type: string
          title: Currency
        balance:
          anyOf:
            - type: number
            - type: 'null'
          title: Balance
        pnl:
          type: number
          title: Pnl
          default: 0
        realized_pnl:
          anyOf:
            - type: number
            - type: 'null'
          title: Realized Pnl
        unrealized_pnl:
          anyOf:
            - type: number
            - type: 'null'
          title: Unrealized Pnl
        positions_count:
          type: integer
          title: Positions Count
          default: 0
        positions_needing_attention:
          items: {}
          type: array
          title: Positions Needing Attention
          default: []
        actions:
          items: {}
          type: array
          title: Actions
          default: []
      additionalProperties: true
      type: object
      required:
        - currency
      title: VenueBlock
      description: Performance and position summary for a single trading venue.

````