On this page

latest contributor to this doc

Last Edit:

@smk762

Enable Swap Status Streaming

API-v2stream::swap_status::enable

Using this method, you can enable the swap status stream.

ParameterTypeRequiredDescription
client_idintegerThis ID can be used to access data (e.g. via http://localhost:7783/event-stream?id=1)

ParameterTypeDescription
streamer_idstringAn identifier for the data stream. This can be used later to disable streaming for the event with stream::disable.

swap_status_enable

POST
swap_status_enable
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "stream::swap_status::enable",
  "mmrpc": "2.0",
  "params": {
    "client_id": 1
  }
}

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

data: {"_type":"SWAP_STATUS","message":{"swap_type":"TakerV1","swap_data":{"uuid":"4bfe3af7-dd62-4dbe-9c16-68697c4aa24d","event":{"timestamp":1746432461259,"event":{"type":"TakerPaymentInstructionsReceived","data":null}}}}}

ParameterTypeDescription
UnknownClientstringNo client has an open connection using this client_id
ClientAlreadyListeningstringThe requested events are already being sent to the client_id