Sign in
Lightning Addresses

List LN Addresses

Changed on

Returns all the addresses given a filter

get/v1/lightning-addresses

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger nullable

Total amount of results to return

offsetinteger nullable

Offset where to start returning results

idsstring[] nullable

List of IDs

account_idstring uuid nullable

Owning account ID

wallet_idstring uuid nullable

Receiving wallet ID

usernamestring nullable

Username

activeboolean nullable

Active

order_direction'Asc' | 'Desc'

Direction of result ordering for list endpoints.

Direction of the ordering of results

Response

Success

account_idstring uuid required

Owning account ID

activeboolean required

Active status. Inactive addresses cannot receive funds

allows_nostrboolean required

Nostr enabled

created_atstring date-time required

Date of creation in database

idstring uuid required

Internal ID

nostr_pubkeystring nullable

Nostr Public key

updated_atstring date-time nullable

Date of update in database

usernamestring required

Username

wallet_idstring uuid required

Wallet that receives invoices generated for this address

Example response

[
  {
    "nostr_pubkey": "d9c2ec59a98c..."
  }
]

Changes

  • 44b172644309Revision changes
    • info

      added the new optional query request parameter account_id

    • info

      added the required property / to the response with the status