On this page

latest contributor to this doc

Last Edit:

@smk762

orderbook_enable

Using this method, you can enable the orderbook stream for a given pair.

ParameterTypeDescription
client_idintegerThis ID can be used to access data (e.g. via http://localhost:7783/event-stream?id=1)
basestringBase currency of a pair
relstringRelated currency, also known as the "quote currency"

For this method, base and rel are essentially interchangeable, and inverting the base coin and rel coin in a request will return the same data.

POST
orderbook_enable
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "stream::orderbook::enable",
  "mmrpc": "2.0",
  "params": {
    "client_id": 1,
    "base": "DOC",
    "rel": "MARTY"
  }
}

Here is an example of the stream data you should be able to see in http://localhost:7783/event-stream?id=1 for each orderbook updated event:

data: {"_type":"ORDERBOOK_UPDATE/orbk/KMD:MATIC","message":{"order_type":"NewOrUpdatedItem","order_data":{"pubkey":"026da2fc632afabbb1b86d04a9a012db25eca74db38ba2eccd88552f27f4c0b245","base":"MATIC","rel":"KMD","price":[[1,[4249903049,3]],[1,[1410065408,2]]],"max_volume":[[1,[1477927621,23427]],[1,[1783793664,116]]],"min_volume":[[1,[1223297773,7148]],[1,[552894464,46566]]],"uuid":"b18bb3ab-8476-4a06-9cf6-9744e1bf6442","created_at":1746432644}}}