Private Channels

Private channels require login before subscribing. They provide real-time updates for account-specific data.

Account Order Update

Example Request

{
    "op": "subscribe",
    "args": [
        {
             "channel": "accountOrderUpdate",
             "marketType": "inclusionPreconf",
             "pricerOnly": false
        }
    ]
}

Example Response

{
    "e": "accountOrderUpdate",
    "E": 1742288403296,
    "s": "ETH-PC-403684",
    "P": {
        "o": 173639360,
        "c": "613ec528",
        "a": 2049,
        "C": 53,
        "t": 2,
        "i": "ETH-PC-403684",
        "m": 1000000403684,
        "p": "0.00000000001",
        "q": "3181683",
        "F": "3181683",
        "fp": "0.00003181683",
        "f": "0.0000028635147",
        "s": false,
        "P": false,
        "S": 10,
        "d": 1742288403289,
        "u": 1742288403289
    }
}

Request

Name	Type	Description
op	string	e.g.subscribe
args	object	Arguments
└channel	string	Channel name, e.g.,accountOrderUpdate.
└marketType	string	Market type, e.g.,inclusionPreconf.
└pricerOnly	boolean	Flag for only displaying pricer information. Optional. Default tofalse.

Response Body

Name	Type	Description
e	string	Event type, e.g.,accountOrderUpdate
E	integer	Event timestamp in milliseconds.
P	array	Array of order objects.
└o	integer	Order ID, e.g.,1234.
└c	string	Client Order ID, e.g.,43f4159e.
└a	integer	Account ID.
└C	integer	User ID who created this order. For pricer only.
└t	boolean	Order Type.
└i	string	Instrument ID.
└m	integer	Market Id.
└p	string	Order price.
└q	string	Order total quantity.
└F	string	Order filled quantity .
└fp	string	Order filled price * quantity.
└f	fee	Order fee.
└s	boolean	Order side.
└P	boolean	Flag for post-only order.
└S	integer	Order Status.
└d	integer	Timestamp of order creation time.
└u	integer	Timestamp of last update time.

Notes

• Timestamp Fields: All timestamps are in milliseconds since the Unix epoch.

Account Transaction Update

Example Request

{
    "op": "subscribe",
    "args": [
        {
            "channel": "accountTransactionUpdate",
            "marketType": "inclusionPreconf"
        }
    ]
}

Example Response

{
    "e": "accountTransactionUpdate",
    "E": 1742288580882,
    "s": "ETH-PC-403699",
    "P": {
        "t": 146600149,
        "i": "ETH-PC-403699",
        "o": 173651088,
        "a": 2049,
        "s": true,
        "p": "0.00000000001",
        "q": "1248972",
        "f": "0.0000011240748",
        "d": 1742288580863
    }
}

Request

Name	Type	Description
op	string	e.g.subscribe
args	object	Arguments
└channel	string	Channel name, e.g.,accountTransactionUpdate.
└marketType	string	Market type, e.g.,inclusionPreconf.

Response Body

Name	Type	Description
e	string	Event type, e.g.,accountTransactionUpdate
E	integer	Event timestamp in milliseconds.
P	object	Payload data containing block builder update details.
s	string	Instrument ID, e.g.,ETH-PC-403699.
└t	integer	Transaction ID, e.g.,123456.
└i	string	Instrument ID, e.g.,ETH-PC-403699.
└o	integer	Order ID of the trade executed, e.g.,123456.
└a	integer	Account ID of the trade executed, e.g.,123.
└s	boolean	Traded Side, e.g.,true.
└p	string	Traded price, e.g.,0.00000000001.
└q	string	Traded quantity, e.g.,1248972.
└f	string	Trading fee, e.g.,0.0000011240748.
└d	timestamp	Timestamp of the trade execution, e.g.,1742288580863.

Notes

• Timestamp Fields: All timestamps are in milliseconds since the Unix epoch.

Account Position Update

Example Request

{
    "op": "subscribe",
    "args": [
        {
            "channel": "accountPositionUpdate",
            "marketType": "inclusionPreconf",
            "pricerOnly": true
        }
    ]
}

Example Response

{
    "e": "accountPositionUpdate",
    "E": 1742288402217,
    "P": {
        "a": 2049,
        "s": 403684,
        "m": 1,
        "q": "20427356",
        "l": "0",
        "p": "0",
        "e": false,
        "b": false,
        "c": 1742288355000,
        "u": 1742288402000,
        "A": "20427356"
    }
}

Request

Name	Type	Description
op	string	e.g.subscribe
args	object	Arguments
└channel	string	Channel name, e.g.,accountPositionUpdate.
└marketType	string	Market type, e.g.,inclusionPreconf.
└pricerOnly	boolean	Flag for only displaying pricer information. Optional. Default tofalse.

Response Body

Name	Type	Description
e	string	Event type, e.g.,accountPositionUpdate
E	integer	Event timestamp in milliseconds.
P	object	Payload data containing account position update details.
└a	integer	Account Id.
└s	integer	Slot number of the position.
└m	integer	Market type of the position.
└q	string	Position's total quantity.
└l	string	Position's locked quantity
└p	string	Position purchased price.
└e	boolean	Expired flag.
└b	integer	Builder fill enable flag.
└c	integer	Position create timestamp.
└u	integer	Position last updated timestamp.
└A	integer	Position's available quantity.

Notes

• Timestamp Fields: All timestamps are in milliseconds since the Unix epoch.

Preconf Bundle Update

Example Request

{
    "op": "subscribe",
    "args": [
        {
            "channel": "preconfBundleUpdate"
        }
    ]
}

Example Response

{
    "e": "preconfBundleUpdate",
    "E": 1743674748083,
    "P": {
        "s": 519181,
        "e": 1260000,
        "bu": [
            {
                "u": "456a8e9d-ce47-421d-8135-9ed9680ab57e",
                "B": 1,
                "o": 1,
                "txs": [
                    {
                        "r": false,
                        "tx": "0x02f88b827e7e8302bcff8084773594008303345094f37512b7c630890c500b02724671cf3ae5607563843b9aca009b45746847617320496e636c7573696f6e20507265636f6e66732e20c001a007797cf3e30a7d45ef43ab9b76d309b76db5f3704cb4936890245b374bad5925a00ad6fa6556dd1448beaf39fc6c5faa097eaf615144905f7d60fb72b15ded30e4",
                        "h": "0x653304b826eca4f48510d29e8ac2a9fcad6ecf3ef3bc3ca3a837718f3d6fa368"
                    },
                    {
                        "r": false,
                        "tx": "0x02f88b827e7e8302bd008084773594008303345094f37512b7c630890c500b02724671cf3ae5607563843b9aca009b45746847617320496e636c7573696f6e20507265636f6e66732e20c080a03b1a7ca0651410d37aedef11740e4e902a9bcb106bcb3bb1f98f18d9ed2bda25a02fabfa492e172ac244cb809d0d035c75ed4b04e5f7e92258781e7cd55daabef9",
                        "h": "0x3076010ac7607ae41a9dacb14b55bba5a91ca4aad1189ed90e5adac638f7d43c"
                    }
                ],
                "p": "0.00000000597"
            }
        ],
        "r": "0x8f02425b5f3c522b7ef8ea124162645f0397c478"
    }
}

Request

Name	Type	Description
op	string	e.g.subscribe
args	object	Arguments
└channel	string	Channel name, e.g.,preconfBundleUpdate.

Response Body

Name	Type	Description
e	string	Event type, e.g.,preconfBundleUpdate
E	integer	Event timestamp in milliseconds.
P	object	Payload data containing block builder update details.
└s	integer	slot ID.
└e	integer	Empty block space in the slot (For block owner only.)
└bu	array	Array of preconf bundles in the slot.
└└u	string	UUID of the bundle.
└└p	string	Gas price of the bundle.
└└txs	array	Array of transaction in the bundle
└└└r	boolean	Whether this ethereum transaction can be reverted.
└└└tx	string	Raw ethereum transaction data in the bundle
└└└h	string	Transaction hash of transaction data

Notes

• Slot ID: Thes field represents the current slot being updated.
• Timestamp Fields: All timestamps are in milliseconds since the Unix epoch.