LN Markets Docs

Private · account:deposits:read · 7 fields

Topic wallet/deposit

Wallet deposit events

Authentication required. Your API key must have permission account:deposits:read. Subscribe after sending authenticate; private events delivered before auth are dropped.

Subscribe by calling the subscribe method with this topic.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "subscribe",
  "params": {
    "topics": [
      "wallet/deposit"
    ]
  }
}

Payload

Each notification carries the fields below in params.data.

currency*string

btc

network*string

lightningbitcoin

id*string

amount*number

balance*number

status*string

txId*string

Example notification

The server pushes the JSON-RPC notification below for every event on this topic.

Notification

{
  "jsonrpc": "2.0",
  "method": "subscription",
  "params": {
    "topic": "wallet/deposit",
    "data": {
      "currency": "btc",
      "network": "lightning",
      "id": "string",
      "amount": 0,
      "balance": 0,
      "status": "string",
      "txId": "string"
    }
  }
}

Deposit

Subscribe

Payload

Example notification