WebSocket API

WebSocket API provide real-time data coming from 3xpl.com blockchain explorer.

As a developer-friendly solution we offer AsyncAPI based document: stream.3xpl.net-asyncapi.yml. The AsyncAPI Generator is a tool that you can use to generate code examples (SDK) for preferred language based on provided AsyncAPI document.

Common features

The base endpoint is: wss://stream.3xpl.net. Public beta server available without authorization.
Once the socket is open you can subscribe to a public channel by sending a subscribe request message.
Every message is JSON encoded.
A special JSON value null used as a PING message. You can simply ignore it on a client side upon receiving. You can ignore such messages or use them to detect broken connections (nothing received from a server for a long time). Server sends PING message every 25 seconds.
Server supports reconnect scenario and provide history for missed data automatically.

Available blockchains

All channel contains {:blockchain} parameter.
You can get list of available blockchains directly from api main stats endpoint: https://api.3xpl.com/ (api token key required)

List of available blockchains

Id	Title
bitcoin	Bitcoin
ethereum	Ethereum
bitcoin-cash	Bitcoin Cash
bnb	BNB
dogecoin	Dogecoin
litecoin	Litecoin
ton	TON
zcash	Zcash

Available channels

SUB

{:blockchain}/blocks

Stream information about new blocks in blockchain

Parameters:

Name / type	Description
blockchain string	id of blockchain to receive blocks from

Response:

array [] List of blocks
- object {} Block object
  - block integer Block identifier
  - hash string Block hash
  - time string Timestamp when block issued
  - events object {} Key-value object with events count by module
    - {:module} integer Events count

Response examples:

Bitcoin block number 500000

[
    {
        block: 500000,
        hash: "00000000000000000024fb37364cbf81fd49cc2d51c09c75c35433c3a1945d04",
        time: "2017-12-18T18:35:25.000000Z",
        events: {
            bitcoin-main: 13340,
            bitcoin-omni: 420
        }
    }
]

SUB

{:blockchain}/events

Stream information about new events in blockchain

Parameters:

Name / type	Description
blockchain string	id of blockchain to receive events from

Response:

array [] List of events
- object {} Event object
  - blockchain string
  - module string Module in which the event occurred
  - block integer Number of block in which the event included
  - transaction string Hash of transaction contains the event
  - sort_key integer Sorting number
  - address string Address affected by the event
  - currency string Effect currency
  - effect string Amount in currency which address effected
  - failed boolean Shows is event failed by any reason
  - extra string
  - extra_indexed string

Response examples:

First events in Bitcoin blockchain

[
    {
        blockchain: "bitcoin",
        module: "bitcoin-main",
        block: 0,
        transaction: "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
        sort_key: 0,
        address: "the-void",
        currency: "bitcoin",
        effect: "-5000000000",
        failed: false,
        extra: null,
        extra_indexed: null
    },
    {
        blockchain: "bitcoin",
        module: "bitcoin-main",
        block: 0,
        transaction: "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
        sort_key: 1,
        address: "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        currency: "bitcoin",
        effect: "+5000000000",
        failed: false,
        extra: null,
        extra_indexed: null
    }
]

SUB

{:blockchain}/mempool

Stream information about new events in mempool (if specified blockchain supports it)

Parameters:

Name / type	Description
blockchain string	id of blockchain to receive events from

Response:

array [] List of mempool events
- object {} Mempool event object
  - blockchain string
  - module string Module in which the event occurred
  - block integer `-1` always
  - transaction string Hash of transaction contains the event
  - sort_key integer Sorting number
  - address string Address affected by the event
  - currency string Effect currency
  - effect string Amount in currency which address effected
  - failed boolean Shows is event failed by any reason
  - extra string
  - extra_indexed string

Response examples:

First events in Bitcoin blockchain

[
    {
        blockchain: "bitcoin",
        module: "bitcoin-main",
        block: -1,
        transaction: "63381b941dbe21d6b7d03cab158118d74c7c313eb4c9164abf64f1293702923a",
        sort_key: 326,
        address: "bc1qkcwtu2k9jjhyvlx804xx5ae786yksqhvju46ml",
        currency: "bitcoin",
        effect: "-723449",
        failed: false,
        extra: null,
        extra_indexed: null
    },
    {
        blockchain: "bitcoin",
        module: "bitcoin-main",
        block: -1,
        transaction: "63381b941dbe21d6b7d03cab158118d74c7c313eb4c9164abf64f1293702923a",
        sort_key: 325,
        address: "bc1qph5wssklxwsl50vyhstlg232nzqwp8sfws2zqm",
        currency: "bitcoin",
        effect: "-910585",
        failed: false,
        extra: null,
        extra_indexed: null
    }
]

SUB

{:blockchain}/transaction/{:hash}

Receive event when a mempool transaction will be included in the block

Parameters:

Name / type	Description
blockchain string	id of blockchain to receive events from
hash string	Transaction hash

Response:

object {} Transaction object
- module string Module in which the transaction processed
- block integer Number of block in which the transaction included
- transaction string Transaction hash
- time string Transaction timestamp

Response examples:

First transaction in Dogecoin blockchain

{
    module: "dogecoin-main",
    block: 0,
    transaction: "5b2a3f53f605d62c53e62932dac6925e3d74afa5a4b459745c36d42d0ed26a69",
    time: "2013-12-06T10:25:40.000000Z"
}

SUB

{:blockchain}/address/{:hash}

Stream information about new events address affected

Parameters:

Name / type	Description
blockchain string	id of blockchain to receive events from
hash string	Address

Response:

array [] List of events
- object {} Event object
  - blockchain string
  - module string Module in which the event occurred
  - block integer Number of block in which the event included
  - transaction string Hash of transaction contains the event
  - sort_key integer Sorting number
  - address string Address affected by the event
  - currency string Effect currency
  - effect string Amount in currency which address effected
  - failed boolean Shows is event failed by any reason
  - extra string
  - extra_indexed string

Response examples:

Some recently events affected to first address in Bitcoin blockchain

[
    {
        blockchain: "bitcoin",
        module: "bitcoin-main",
        block: 779007,
        transaction: "685e1c7bd823384335e1b3519148622e97a6e6a637bfee339c347e1d994b73bc",
        sort_key: 13093,
        time: "2023-03-02T18:38:33.000000Z",
        currency: "bitcoin",
        effect: "+7491",
        failed: false,
        extra: null,
        extra_indexed: null
    },
    {
        blockchain: "bitcoin",
        module: "bitcoin-main",
        block: 779006,
        transaction: "6783e8ef51befa0eb31f12c7e36317ceca1f766f0c7ce2af5c13ede7cffc43de",
        sort_key: 1918,
        time: "2023-03-02T18:24:51.000000Z",
        currency: "bitcoin",
        effect: "+7047",
        failed: false,
        extra: null,
        extra_indexed: null
    }
]