broker-asyncapi

Receive real-time event/market lifecycle updates

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/tie-tech/hub/b2b-api/doc/broker-asyncapi/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "broker-asyncapi MCP server": {
    "url": "https://bump.sh/tie-tech/hub/b2b-api/doc/broker-asyncapi/mcp"
  }
}
Close
/events

Real-time lifecycle events stream for events and markets with resume capability.

Query Parameters:

  • since=<uint64> Last applied seq for resume (optional; must be >0; absent or 0 → start from live tail; replay window: 1 hour)
  • event_id=<id> Repeatable; filter by event_id (includes all markets of the event)
  • market_id=<id> Repeatable; filter by market_id
  • lang=<code> Repeatable; filter by language code (en, pt, id). Filters LocalizedText fields in payloads. If omitted, all available locales are included.

Resume Semantics:

  1. Client connects with since=S (last applied seq)
  2. Server replays frames with seq >= S in order
  3. Sends backlog_end (last_seq = current max)
  4. Continues live streaming If S > current max → no replay frames, then backlog_end (last_seq = current max), then live streaming Replay is limited to messages from the preceding one hour. If S refers to data older than one hour (or otherwise no longer retained) → error frame (code=resume_too_old) then close (4009)

Idempotency / Ordering:

  • seq is strictly increasing for delivered data frames, but is not guaranteed to be contiguous
  • Gaps are valid (for example, because of stream filters) and do not by themselves indicate data loss
  • Client drops any frame with seq <= last_applied_seq

Event Types:

  • event.created: New event created with full definition
  • event.status_changed: Event status changed (only status fields)
  • event.details_changed: Event content changed (title, category, rules_primary)
  • event.settled: Event resolved (includes expiration_value; resolved_market_id is deprecated, always null)
  • event.voided: Event cancelled (includes void_reason)
  • market.created: New market created with full definition
  • market.status_changed: Market status changed (only status fields)
  • market.details_changed: Full market detail set after a change (titles, strike_type, strikes, bounds)
  • market.settled: Market resolved (includes result, settlement_price, expiration_value)
  • market.voided: Market cancelled

Market Details At Resolution:

  • market.details_changed can arrive on a closed market at resolution, with a new floor_strike
  • It always comes before market.settled and event.settled of the same event
  • expiration_value in those two events matches the new floor_strike, and can carry more decimals than usual

Details Changes:

  • event.details_changed and market.details_changed carry the current values, not the changes: apply the whole payload
  • A frame arrives only for what changed: event.details_changed when event fields change, market.details_changed for each changed market. If both change, both frames arrive
  • change_reason gives the reason for the change. In market.details_changed it is null when there is no reason

Independent Market Operations:

  • market.status_changed, market.settled and market.voided can arrive while the event is still open
  • The other markets of that event keep trading, and no event.* frame accompanies these
  • market.settled from such a settle carries expiration_value null

Markets Added To An Open Event:

  • market.created can arrive while the event is open, with status unopened and status_revision 0
  • Its created_at and opens_at are its own, later than the event's; it comes before every market.status_changed of that market
  • event.created is not sent again, so its markets list does not include the added market

Heartbeats:

  • Sent when no lifecycle_update within configured interval
  • Heartbeat does NOT advance seq; only lifecycle_update frames advance seq
  • Heartbeat and backlog_end both repeat the last data seq

Flow Control:

  • Server may enforce max_pending_frames/bytes and close with code 4008 (flow_control)

Close Codes: 1000 normal 1001 going_away 1011 internal_error 4008 flow_control 4009 resume_too_old / protocol_version 4401 unauthorized

Operation WebSockets-specific information

  • headers object
    Hide headers attributes Show headers attributes object
    • PRE-ACCESS-KEY string Required

      Broker access key identifier

      Format should match the following pattern: ^[A-Za-z0-9._~-]{1,64}$.

    • PRE-ACCESS-TIMESTAMP string(date-time) Required

      RFC3339 timestamp with milliseconds

    • PRE-ACCESS-SIGNATURE string Required

      Keyed BLAKE2b-256 signature hex lowercase

      Format should match the following pattern: ^[0-9a-f]{64}$.

  • query object
    Hide query attributes Show query attributes object
    • since integer(int64)

      Resume from last applied seq (inclusive), within the one-hour replay window. Must be >0. If omitted or 0, start from live tail. A sequence older than the available window causes resume_too_old and close code 4009.

      Minimum value is 1.

    • event_id array[string]

      Repeatable filter by event_id. Includes all markets of the event. Absent → all events accessible to broker.

    • market_id array[string]

      Repeatable filter by market_id. Absent → all markets accessible to broker.

    • lang array[string]

      Repeatable filter by language code. Filters localized text fields in payloads. If omitted, all available locales are included in each payload.

      Values are en, pt, or id.

SUBSCRIBE /events

Message #1

Event or market lifecycle state change notification

Payload

  • type string Required

    Value is event_update.

  • seq integer(int64) Required

    Monotonic sequence for lifecycle events

    Minimum value is 0.

  • ts_ns integer(int64) Required

    Timestamp in nanoseconds

  • event_id string | null

    Event ID (if applicable)

  • market_id string | null

    Market ID (if applicable)

  • event_type string Required

    Lifecycle event type

    Values are event.created, event.status_changed, event.details_changed, event.settled, event.voided, market.created, market.status_changed, market.details_changed, market.settled, or market.voided.

  • payload object Required
    One of:
    EventCreatedPayload object EventStatusChangedPayload object EventDetailsChangedPayload object EventSettledPayload object EventVoidedPayload object MarketCreatedPayload object MarketStatusChangedPayload object MarketDetailsChangedPayload object MarketSettledPayload object MarketVoidedPayload object
Payload examples 
{
  "type": "event_update",
  "seq": 42,
  "ts_ns": 42,
  "event_id": "string",
  "market_id": "string",
  "event_type": "event.created",
  "payload": {
    "event_id": "string",
    "title": {
      "en": "string",
      "pt": "string",
      "id": "string"
    },
    "series_title": {
      "en": "string",
      "pt": "string",
      "id": "string"
    },
    "rules_primary": {
      "en": "string",
      "pt": "string",
      "id": "string"
    },
    "category": "crypto",
    "image_url": "string",
    "series": "",
    "status": "open",
    "void_reason": "string",
    "created_at": "2026-05-04T09:42:00Z",
    "opens_at": "2026-05-04T09:42:00Z",
    "closes_at": "2026-05-04T09:42:00Z",
    "settlement_sources": [
      {
        "name": "string",
        "url": "string",
        "underlying": {
          "base_currency": "string",
          "quote_currency": "string"
        }
      }
    ],
    "markets": [
      "string"
    ]
  }
}

Message #2

Keep-alive heartbeat (does not advance seq)

Payload

  • type string Required

    Value is heartbeat.

  • seq integer(int64)

    Repeats last delivered data seq; heartbeat does not advance global seq

    Minimum value is 0.

  • ts_ns integer(int64) Required
  • payload object Required
    Hide payload attribute Show payload attribute object
    • interval_sec integer Required

      Minimum value is 1.

Payload examples 
{
  "type": "heartbeat",
  "seq": 42,
  "ts_ns": 42,
  "payload": {
    "interval_sec": 42
  }
}

Message #3

Signals end of historical replay; live streaming begins

Payload

  • type string Required

    Value is backlog_end.

  • seq integer(int64) Required

    Minimum value is 0.

  • ts_ns integer(int64) Required
  • payload object Required
    Hide payload attribute Show payload attribute object
    • last_seq integer(int64) Required

      Minimum value is 0.

Payload examples 
{
  "type": "backlog_end",
  "seq": 42,
  "ts_ns": 42,
  "payload": {
    "last_seq": 42
  }
}

Message #4

Error notification before close

Payload

  • type string Required

    Value is error.

  • seq integer(int64) Required

    Minimum value is 0.

  • ts_ns integer(int64) Required
  • payload object Required
    Hide payload attributes Show payload attributes object
    • code string Required
    • message string Required
    • details object

      Additional properties are allowed.

Payload examples 
{
  "type": "error",
  "seq": 42,
  "ts_ns": 42,
  "payload": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}