Get lightning balance

get/api/v2/wallet/{walletId}/lightning/balance

Get the custodial lightning balance for the wallet.

Path Parameters

  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

200 Response

balance number
The lightning balance for the wallet in satoshis
Example: 25000000
availableBalance number
The available lightning balance in satoshis minus holds for pending payments or withdrawals.
Example: 24000000

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code