Skip to main content

Commands

subscribe​

Subscribe to one or multiple topics

{
    "op": "subscribe",
    "args": [
        {
            "channel": "preconfMarketUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "candlestickUpdate",
            "marketType": "wholeBlock"
        },
        {
            "channel": "recentTradeUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "orderBookUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "tickerUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "inclusionPreconfSaleUpdate"
        },
        {
            "channel": "blockBuilderUpdate"
        }
    ]
}

unsubscribe​

Unsubscribe from one or multiple topics

{
    "op": "unsubscribe",
    "args": [
        {
            "channel": "preconfMarketUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "candlestickUpdate",
            "marketType": "wholeBlock"
        },
        {
            "channel": "recentTradeUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "orderBookUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "tickerUpdate",
            "marketType": "inclusionPreconf"
        },
        {
            "channel": "inclusionPreconfSaleUpdate"
        },
        {
            "channel": "blockBuilderUpdate"
        }
    ]
}

query​

Query data from a topic

Example​

{
    "op": "query",
    "args": [
        {
            "queryType": "currentSlot"
        },
        {
            "queryType": "preconfMarkets"
        },
        {
            "queryType": "orderBook"
        }
    ]
}

See Public Queries and Private Queries for available query types.

login​

Login to the streaming server for accessing private channels and queries.

Example Request​

{
    "op": "login",
    "args": [
        {
            "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
        }
    ]
}

Example Response​

{
    "event": "login",
    "code": 0,
    "msg": "",
    "connId": "25f9ee2c"
}