Account

Get information regarding the user's account.

Get value4value information

Scope needed: account:read

Returns the user's Lightning Address and keysend information.

GET https://api.getalby.com/user/value4value

Returns the user's Lightning Address and keysend information

200: OK

{
  "keysend_pubkey": "02740d5d0e3b2d4d9e313423587a01e8122f9c6e8717e36ff388a170bdcb8c1e7e",
  "keysend_custom_key": "696969",
  "keysend_custom_value": "01wDdDkTsaRuNTAJzXiW",
  "lightning_address": "[e-mail] (if the user has a lightning address configured)"
}

Get account balance

Scope needed: balance:read

Returns the balance of the user's wallet.

GET https://api.getalby.com/balance

Returns the balance of the user's wallet.

200: OK

{
   "balance": 1000,
   "currency": "BTC",
   "unit": "sat"
}

400: Bad Request

{
  "code": 0,
  "error": true,
  "message": "string"
}

Get account summary

Scope needed: balance:read

Returns the balance, incoming/outgoing transaction count, boostagram count

GET https://api.getalby.com/user/summary

Returns the balance, incoming/outgoing transaction count, boostagram count

200: OK

{
    "balance": 10000,
    "boostagrams_count": 8,
    "currency": "BTC",
    "invoices_count": 9,
    "last_invoice_at": "2022-06-02T08:40:08.000Z",
    "transactions_count": 33,
    "unit": "sat"
}

Get personal information

Get the user's e-mail address, display name, avatar, nostr pubkey, and value4value information.

GET https://api.getalby.com/user/me

Get the user's e-mail address, display name, avatar, nostr pubkey, and value4value information.

200: OK

{
    "identifier": "LlzljZKnMATJxC6z9t19",
    "email": "[e-mail]",
    "name": "Kwinten",
    "avatar": "https://fra1.digitaloceanspaces.com/getalbycom/uploads/lightning_address/avatar/28/thumb_signal-2022-05-15-17-19-02-995.jpg",
    "keysend_custom_key": "696969",
    "keysend_custom_value": "LlzljZKnMATJxC6z9t19",
    "keysend_pubkey": "030a58b8653d32b99200a2334cfe913e51dc7d155aa0116c176657a4f1722677a3",
    "lightning_address": "[e-mail]",
    "nostr_pubkey": "npub13sajvl5ak6cpz4ycesl0e5v869r5sey5pt50l9mcy6uas0fqtpmscth4np"
}