Enable Transaction History Streaming
stream::tx_history::enable
Using this method, you can enable transaction history events streaming for a specific coin.
This method is only compatible with the following coin types: UTXO, BCH/SLP, TENDERMINT, QTUM, ZHTLC.
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| coin | string | ✓ | Ticker of the coin to activate streaming for. The coin must be activated first. | |
| client_id | integer | – | 0 | This ID can be used to access data via http://localhost:7783/event-stream?id=1 |
Response Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| streamer_id | string | – | An identifier for the data stream. This can be used later to disable streaming for the event with stream::disable. |
📌 Examples
{
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::tx_history::enable",
"mmrpc": "2.0",
"params": {
"client_id": 1,
"coin": "DOC"
}
}curl --url "http://127.0.0.1:7783" --data '{
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::tx_history::enable",
"mmrpc": "2.0",
"params": {
"client_id": 1,
"coin": "DOC"
}
}'import requests
import json
url = "http://127.0.0.1:7783"
payload = {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::tx_history::enable",
"mmrpc": "2.0",
"params": {
"client_id": 1,
"coin": "DOC"
}
}
response = requests.post(url, json=payload)
print(json.dumps(response.json(), indent=2))const payload = {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::tx_history::enable",
"mmrpc": "2.0",
"params": {
"client_id": 1,
"coin": "DOC"
}
};
const response = await fetch("http://127.0.0.1:7783", {
method: "POST",
body: JSON.stringify(payload),
});
console.log(await response.json());<?php
$payload = <<<'JSON'
{
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::tx_history::enable",
"mmrpc": "2.0",
"params": {
"client_id": 1,
"coin": "DOC"
}
}
JSON;
$ch = curl_init("http://127.0.0.1:7783");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{"userpass":"RPC_UserP@SSW0RD","method":"stream::tx_history::enable","mmrpc":"2.0","params":{"client_id":1,"coin":"DOC"}}`)
resp, err := http.Post("http://127.0.0.1:7783", "application/json", bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
require 'uri'
uri = URI("http://127.0.0.1:7783")
payload = {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::tx_history::enable",
"mmrpc": "2.0",
"params": {
"client_id": 1,
"coin": "DOC"
}
}
response = Net::HTTP.post(uri, payload.to_json, 'Content-Type' => 'application/json')
puts JSON.pretty_generate(JSON.parse(response.body))Show Response
{
"mmrpc": "2.0",
"result": {
"streamer_id": "TX_HISTORY:DOC"
},
"id": null
}Here is an example of the stream data you should be able to see in http://localhost:7783/event-stream?id=1 for each transaction event:
data: {"_type":"TX_HISTORY:KMD","message":{"tx_hex":"0400008085202f89015c649b8da32385ec58802385d179018db8e791d752a2cdf8d7fbf9247049bb81010000006a4730440220224c598d9af09684a848435bded40f9b24cc664d129d2dff5d0c094e6919cf1a0220143d896e7c42d13f57c98fb7eabfdeee27386ece324ec84a18308c106f1cf16301210295546acd9bdd19ec68093fef17e76b098fff5ff9815bb2adbfc2a618f41a74c6ffffffff0200a3e111000000001976a91482a6b17e64687148f4922b1385a11e6221bf5f5988aca0a0548c9c0100001976a914d92154e3a7a6da1b0cc1a4f84bc97fff24a79a3588acb66f1868000000000000000000000000000000","tx_hash":"05e9b6f5c96c71af3435cab55dbb807da47ed93ef1b84fc0a5fa867956e9ce9d","from":["RV5Ge4dLvRHGiYCanRBBEDM1eMR3wHDNLs"],"to":["RMC1cWXngQf2117apEKoLh3x27NoG88yzd","RV5Ge4dLvRHGiYCanRBBEDM1eMR3wHDNLs"],"total_amount":"17721.80883336","spent_by_me":"0","received_by_me":"3","my_balance_change":"3","block_height":0,"timestamp":0,"fee_details":{"type":"Utxo","coin":"KMD","amount":"0.00001"},"coin":"KMD","internal_id":"05e9b6f5c96c71af3435cab55dbb807da47ed93ef1b84fc0a5fa867956e9ce9d","transaction_type":"StandardTransfer","memo":null}}
Error Types
| Parameter | Type | Required | Description |
|---|---|---|---|
| CoinNotFound | string | – | The specified coin was not found or is not activated yet |
| UnknownClient | string | – | No client has an open connection using this client_id |
| ClientAlreadyListening | string | – | The requested events are already being sent to the client_id |
| CoinNotSupported | string | – | The coin type is not supported for this stream |
Show Error Responses
Error Response (Coin Not Found)
{
"mmrpc": "2.0",
"error": "CoinNotFound",
"error_path": "tx_history",
"error_trace": "tx_history:42]",
"error_type": "CoinNotFound",
"id": null
}Error (Unknown Client)
{
"mmrpc": "2.0",
"error": "UnknownClient",
"error_path": "tx_history",
"error_trace": "tx_history:75]",
"error_type": "EnableError",
"error_data": "UnknownClient",
"id": null
}Error (Client Already Listening)
{
"mmrpc": "2.0",
"error": "ClientAlreadyListening",
"error_path": "tx_history",
"error_trace": "tx_history:75]",
"error_type": "EnableError",
"error_data": "ClientAlreadyListening",
"id": null
}Error (Coin Not Supported)
{
"mmrpc": "2.0",
"error": "CoinNotSupported",
"error_path": "tx_history",
"error_trace": "tx_history:70]",
"error_type": "CoinNotSupported",
"id": null
}