NWC Provider API

API endpoints for the NWC Provider extension.

Live API Explorer

If you have a running LNbits instance, the interactive API docs are the fastest way to explore and test:

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

These are auto-generated from your running version and always up to date.

Base URL

https://your-lnbits.com/nwcprovider/api/v1/

Authentication

Key Type	Header	Access
Admin key	X-Api-Key	Full access (create, update, delete)
Invoice key	X-Api-Key	Read-only access (list, get)

Endpoints

Method	Path	Auth	Description
GET	/nwcprovider/api/v1/	Invoice	List all items
GET	/nwcprovider/api/v1/{id}	Invoice	Get a specific item
POST	/nwcprovider/api/v1/	Admin	Create a new item
PUT	/nwcprovider/api/v1/{id}	Admin	Update an item
DELETE	/nwcprovider/api/v1/{id}	Admin	Delete an item

Note

This is the standard CRUD pattern. The actual resource names and additional endpoints may vary. Check the Swagger UI on your instance for the exact paths and request/response schemas.

Example

# List items
curl https://your-lnbits.com/nwcprovider/api/v1/ \
  -H "X-Api-Key: YOUR_INVOICE_KEY"

# Create item
curl -X POST https://your-lnbits.com/nwcprovider/api/v1/ \
  -H "X-Api-Key: YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "example"}'

For AI Agents

Fetch the full OpenAPI spec from any running instance:

GET https://your-lnbits.com/openapi.json

Filter for paths starting with /nwcprovider/ to isolate this extension's endpoints.

Related Pages

• NWC Provider Overview: Extension features and setup guide
• API Authentication: API key types and usage
• Quick Reference: All core LNbits endpoints
• All Extensions: Browse the full extension catalog