Skip to main content

​
Overview

Once an RLN node is running on Utexo Cloud, it exposes a REST JSON API that can be called directly to perform Lightning and RGB operations — channel management, asset issuance, payments, peer connections, and more.

​
Base URL

Each node has a unique endpoint URL visible on its dashboard page (/nodes/{nodeId}). Connections can be made via mTLS or API token. See Connect to RLN Node for details.

​
Example Request

curl -X POST \
  -H "Content-type: application/json" \
  -d '{"ticker": "USDT", "name": "Tether", "amounts": [666], "precision": 0}' \
  https://{userId}.thunderstack.org/nodes/{userId}/{nodeId}/issueasset

​
Available Endpoints

The node exposes the following REST endpoints, all using POST unless noted:

​
Wallet & Balances

EndpointMethodDescription
/addressPOSTGenerate a new on-chain address
/btcbalancePOSTGet BTC balance
/assetbalancePOSTGet RGB asset balance
/listunspentsPOSTList unspent outputs
/createutxosPOSTCreate UTXOs for RGB use

​
Asset Management

EndpointMethodDescription
/issueassetniaPOSTIssue a NIA (non-inflatable) asset
/issueassetcfaPOSTIssue a CFA (collectible) asset
/issueassetudaPOSTIssue a UDA (unique digital asset)
/listassetsPOSTList all RGB assets
/assetmetadataPOSTGet metadata for an asset
/getassetmediaPOSTRetrieve asset media
/postassetmediaPOSTUpload asset media
/sendassetPOSTSend an RGB asset
/listtransfersPOSTList RGB transfers
/refreshtransfersPOSTRefresh pending transfers
/failtransfersPOSTMark transfers as failed

​
Payments & Invoices

EndpointMethodDescription
/lninvoicePOSTCreate a Lightning invoice
/rgbinvoicePOSTCreate an RGB invoice
/decodelninvoicePOSTDecode a Lightning invoice
/decodergbinvoicePOSTDecode an RGB invoice
/invoicestatusPOSTCheck invoice status
/sendpaymentPOSTSend a Lightning payment
/keysendPOSTSend a keysend payment
/listpaymentsGETList all payments
/listtransactionsPOSTList on-chain transactions

​
Channels

EndpointMethodDescription
/openchannelPOSTOpen a Lightning channel
/closechannelPOSTClose a Lightning channel
/listchannelsGETList all channels
/getchannelidPOSTGet channel ID

​
Peers & Network

EndpointMethodDescription
/connectpeerPOSTConnect to a peer
/disconnectpeerPOSTDisconnect from a peer
/listpeersGETList connected peers
/networkinfoGETGet network information
/nodeinfoGETGet node information
/checkindexerurlPOSTVerify indexer URL
/checkproxyendpointPOSTVerify proxy endpoint
/estimatefeePOSTEstimate transaction fee
/signmessagePOSTSign a message with node key
/sendonionmessagePOSTSend an onion message

​
Swaps

EndpointMethodDescription
/makerinitPOSTInitialize as swap maker
/makerexecutePOSTExecute swap as maker
/takerPOSTParticipate as swap taker
/listswapsGETList all swaps

​
Node Lifecycle

EndpointMethodDescription
/initPOSTInitialize node after creation
/unlockPOSTUnlock node with password
/lockPOSTLock node
/changepasswordPOSTChange node password
/backupPOSTTrigger a node backup
/restorePOSTRestore node from backup
/syncPOSTSync node state
/shutdownPOSTShut down the node

​
Full API Reference

For complete parameter definitions and response schemas, see the OpenAPI specification and interactive Swagger UI: https://rgb-tools.github.io/rgb-lightning-node