Submissions

Poll market events across every submission of your brokerage

Changed on

The brokerage-wide change feed: one poll instead of one per submission. Same event types, object, visibility rules and cursor contract as GET /broker/submissions/{submission_id}/events, plus submission_id on every event and, on quote_received, the quote's documents (the same entries GET /broker/submissions/{submission_id}/quotes lists; download_path is served by GET /broker/finalized-documents/{document_id}/pdf, carrier_url is carrier-hosted). documents is null on every other type, and an empty list when the quote has no document.

The end-of-stream signal is the cursor, never page length. A non-null next_cursor means more events may exist: store it and poll again with since=next_cursor until you receive a null. A page may hold fewer than limit events, or none at all, with a non-null cursor; never treat a short page as the tail. next_cursor is null only when the request proved your position is the tail of the currently-visible stream; resume later polls from your last non-null cursor. Dedupe by event id.

A machine token issued to a partner reads only the submissions that partner created.

get/broker/events

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Query parameters

sincestring

Opaque cursor from a previous page's next_cursor; returns events strictly after it. Omit to read from the beginning.

limitinteger

Max events per page (internal audit rows are not counted). Values outside [1, 100] are clamped, never rejected.

Response

One page of events plus the follow-up cursor

next_cursorstring nullable

Example response

{
  "events": [
    {
      "documents": [
        {
          "kind": "hedge_quote_pdf"
        }
      ]
    }
  ]
}

Changes