Lightning Addresses

Register a new LN Address

Changed on

Registers an address. Returns the address details. LN Addresses are ready to receive funds through the LNURL protocol upon registration.

post/v1/lightning-addresses

Request

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

Request body

account_idstring uuid nullable

Owning account ID. Required for admin routes; account-scoped routes use the authenticated account.

allows_nostrboolean

Nostr enabled

nostr_pubkeystring nullable

Nostr public key

usernamestring required

Username such as username@domain

Example request

{
  "nostr_pubkey": "npub1m8pwckdf3..."
}

Response

LN Address Registered

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

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status