Events Unified Format

Explore the standardized unified format for events across various protocols and networks.

Events sent are formatted using the UNIFIED_V1 schema, which is a standardized format across all supported protocols and networks. This section will provide more details on the UNIFIED_V1 schema for each supported event type.

❗️

Note:

The UNIFIED_V1 format is currently still in development. Some fields might still be subject to change.

📘

Info:

To get a list of supported protocols, networks, and their events, please refer to this page.

Standardized Envelope

All events produced by Event Streaming will be produced in a standardized envelope. Below is an example of the structure:

{
  "protocol":"bitcoin",
  "network":"mainnet",
  "event_type":"<event_type>",
  "data": {}
}

The table below shows the schema breakdown:

FieldTypeDescription
protocolstringThe blockchain protocol.
networkstringThe blockchain network.
event_typestringThe name/type of the event.

Based on the Event Type:

- unified_block
- unified_reorg

Based on Address:

- unified_confirmed_tx_log
- unified_confirmed_balance
- unified_confirmed_tx
- unified_confirmed_tx_trace
dataobjectThe event payload is determined by which event_type is shown.

👋 Need Help?

Contact us through email or our support page for any issues, bugs, or assistance you may need.