On this page

  2. Komodo Defi Framework
  3. Api
  4. V20
  5. Streaming
  6. Disable
latest contributor to this doc

Last Edit:

@gcharang↗

Disable Streaming

API-v2stream::disable

stream::disable

Using this method, you can disable specific streaming events.

Request Parameters

Parameter* = requiredTypeDescription
client_id*
integer
This ID can be used to access data (e.g. via http://localhost:7783/event-stream?id=1)
streamer_id*
string
An identifier for the data stream to disable.

Response Parameters

Parameter* = requiredTypeDescription
result
string
Optional. Success message confirming the stream was disabled

📌 Examples

stream::disable

POST
stream::disable
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "stream::disable",
  "mmrpc": "2.0",
  "params": {
    "client_id": 1,
    "streamer_id": "BALANCE:MATIC"
  }
}

  {
      "mmrpc": "2.0",
      "result": {
          "result": "Success"
      },
      "id": null
  }

Error Types

Parameter* = requiredTypeDescription
StreamerNotFound
string
Optional. The specified streamer_id was not found
UnknownClient
string
Optional. No client has an open connection using this client_id
Error Response (Streamer Not Found)
  {
      "mmrpc": "2.0",
      "error": "StreamerNotFound",
      "error_path": "disable",
      "error_trace": "disable:48]",
      "error_type": "DisableError",
      "error_data": "StreamerNotFound",
      "id": null
  }
Error (Unknown Client)
  {
      "mmrpc": "2.0",
      "error": "UnknownClient",
      "error_path": "disable",
      "error_trace": "disable:48]",
      "error_type": "DisableError",
      "error_data": "UnknownClient",
      "id": null
  }