Quick Reference

Every LNbits API endpoint in one scannable table. Click any endpoint path to jump to its full documentation.

All paths are relative to your instance base URL (e.g. https://your-lnbits.com).

Auth levels: Admin = Admin key, Invoice = Invoice key, Bearer = JWT Bearer token, Super = Super User, None = no auth required.

Core - Wallets

Method	Endpoint	Auth	Description
GET	/api/v1/wallet	Invoice	Get wallet details and balance
GET	/api/v1/wallets	Bearer	List all wallets for user
GET	/api/v1/wallet/paginated	Bearer	List wallets with pagination
PUT	/api/v1/wallet	Admin	Update wallet name or currency
DELETE	/api/v1/wallet	Admin	Delete wallet permanently
PUT	/api/v1/wallet/share/invite	Admin	Invite user to share wallet
PUT	/api/v1/wallet/share	Bearer	Accept a wallet share invite
DELETE	/api/v1/wallet/share/invite/{id}	Bearer	Reject a wallet share invite

Core - Payments

Method	Endpoint	Auth	Description
POST	/api/v1/payments	Invoice	Create a Lightning invoice
POST	/api/v1/payments	Admin	Pay a Lightning invoice
GET	/api/v1/payments/{checking_id}	Invoice	Check payment status
GET	/api/v1/payments	Invoice	List payments
GET	/api/v1/payments/paginated	Invoice	List payments with pagination
GET	/api/v1/payments/history	Invoice	Payment history by time group
GET	/api/v1/payments/stats/count	Invoice	Payment count by tag
GET	/api/v1/payments/stats/wallets	Bearer	Per-wallet payment stats
GET	/api/v1/payments/stats/daily	Invoice	Daily payment stats
PUT	/api/v1/payments/{checking_id}	Admin	Settle a hold invoice
DELETE	/api/v1/payments/{checking_id}	Admin	Cancel a hold invoice

Core - Users & Accounts

Method	Endpoint	Auth	Description
POST	/api/v1/auth	None	Login with username & password
POST	/api/v1/auth/usr	None	Login with user ID (legacy)
POST	/api/v1/auth/nostr	None	Login with Nostr (NIP-98)
POST	/api/v1/auth/{provider}/token	None	OAuth login (Google, GitHub, Keycloak)
GET	/api/v1/auth	Bearer	Get current user profile
POST	/api/v1/auth/register	None	Register new account
PUT	/api/v1/auth/me	Bearer	Update profile
PUT	/api/v1/auth/update-password	Bearer	Change password
POST	/api/v1/auth/reset-password	None	Request password reset
DELETE	/api/v1/auth/me	Bearer	Delete account
GET	/api/v1/auth/acls	Bearer	List ACLs
POST	/api/v1/auth/acls	Bearer	Create ACL
PUT	/api/v1/auth/acls/{acl_id}	Bearer	Update ACL
DELETE	/api/v1/auth/acls/{acl_id}	Bearer	Delete ACL
POST	/api/v1/auth/acls/{acl_id}/tokens	Bearer	Generate ACL token
DELETE	/api/v1/auth/acls/{acl_id}/tokens/{token_id}	Bearer	Revoke ACL token

Core - Extensions

Method	Endpoint	Auth	Description
POST	/api/v1/extension	Bearer	Install extension
GET	/api/v1/extension/{ext_id}/releases	Bearer	List available releases
GET	/api/v1/extension/{ext_id}/details	Bearer	Get extension details
PUT	/api/v1/extension/{ext_id}	Bearer	Activate or deactivate
DELETE	/api/v1/extension/{ext_id}	Bearer	Uninstall extension
POST	/api/v1/extension/{ext_id}/reviews	Bearer	Submit review

Core - LNURL

Method	Endpoint	Auth	Description
GET	/api/v1/lnurlscan/{code}	Invoice	Parse LNURL / Lightning Address
POST	/api/v1/payments/lnurl	Admin	Pay via LNURL-pay flow
POST	/api/v1/lnurlauth	Admin	Perform LNURL-auth login

Core - Fiat & Rates

Method	Endpoint	Auth	Description
GET	/api/v1/rate/{currency}	None	Get BTC exchange rate
GET	/api/v1/currencies	None	List supported currencies
GET	/api/v1/rate/history	None	Historical exchange rates
POST	/api/v1/conversion	None	Convert between units

Core - TinyURL

Method	Endpoint	Auth	Description
POST	/api/v1/tinyurl	Invoice	Create a short URL
GET	/api/v1/tinyurl/{tinyurl_id}	Invoice	Get TinyURL details
DELETE	/api/v1/tinyurl/{tinyurl_id}	Admin	Delete a TinyURL

Core - WebSockets

Method	Endpoint	Auth	Description
WS	/api/v1/ws/{wallet_id}	None	Real-time payment events

Admin - Settings

Method	Endpoint	Auth	Description
GET	/api/v1/admin/settings	Super	Get server settings
PUT	/api/v1/admin/settings	Super	Update server settings

Admin - Users

Method	Endpoint	Auth	Description
GET	/users/api/v1/user	Admin	List all users
GET	/users/api/v1/user/{user_id}	Admin	Get user details
POST	/users/api/v1/user	Admin	Create user
PUT	/users/api/v1/user/{user_id}	Admin	Update user
DELETE	/users/api/v1/user/{user_id}	Super	Delete user
PUT	/users/api/v1/user/{user_id}/balance	Admin	Adjust user balance

Admin - Top-up

Method	Endpoint	Auth	Description
PUT	/api/v1/admin/topup	Super	Add balance to wallet

Admin - Extensions

Method	Endpoint	Auth	Description
GET	/api/v1/admin/extensions	Admin	List all extensions
POST	/api/v1/admin/extensions	Admin	Enable or disable extension
POST	/api/v1/admin/extensions/install	Super	Install from manifest URL

Related Pages

• API Reference
• Authentication
• Interactive API Docs

Interactive API Docs

Every LNbits instance serves auto-generated interactive API documentation:

• Swagger UI - https://your-lnbits.com/docs
• ReDoc - https://your-lnbits.com/redoc

Use these to browse endpoints and test them directly from your browser.