How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BTCPay Server

BTCPay Server Lightning (Store) API

Lightning (Store) operations

Documentation Provider Profile APIs.io OpenAPI GitHub

BTCPay Server Lightning (Store) API is one of 31 APIs that BTCPay Server publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lightning (Store). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, authentication docs, and rate-limit docs.

This API exposes 13 operations across 11 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://{btcpay-host}.

13 operations 11 paths 20 schemas 8 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://{btcpay-host}/api/v1
Authentication
API Key, HTTP Basic
Contact
BTCPay Server
License
MIT
Resource Areas
1

Authentication & Security 2

BTCPay Server Lightning (Store) API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_Key). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • API_Key — BTCPay Server API key. Format: 'token {apiKey}'
  • Basic — HTTP Basic Authentication with email and password

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 8 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Lightning (Store) 13

Lightning (Store) operations

GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/info
Get node information
StoreLightningNodeApi_GetInfo 2 params → 200503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/balance
Get node balance
StoreLightningNodeApi_GetBalance 2 params → 200503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/histogram
Get node balance histogram
StoreLightningNodeApi_GetHistogram 2 params → 200503404
POST
/api/v1/stores/{storeId}/lightning/{cryptoCode}/connect
Connect to lightning node
StoreLightningNodeApi_ConnectToNode 2 params body → 200422400503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/channels
Get channels
StoreLightningNodeApi_GetChannels 2 params → 200404
POST
/api/v1/stores/{storeId}/lightning/{cryptoCode}/channels
Open channel
StoreLightningNodeApi_OpenChannel 2 params body → 200422400503404
POST
/api/v1/stores/{storeId}/lightning/{cryptoCode}/address
Get deposit address
StoreLightningNodeApi_GetDepositAddress 2 params → 200503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash}
Get payment
StoreLightningNodeApi_GetPayment 3 params → 200503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/{id}
Get invoice
StoreLightningNodeApi_GetInvoice 3 params → 200503404
POST
/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/pay
Pay Lightning Invoice
StoreLightningNodeApi_PayInvoice 2 params body → 200202422400503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices
Get invoices
StoreLightningNodeApi_GetInvoices 4 params → 200401503default
POST
/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices
Create lightning invoice
StoreLightningNodeApi_CreateInvoice 2 params body → 200400503404
GET
/api/v1/stores/{storeId}/lightning/{cryptoCode}/payments
Get payments
StoreLightningNodeApi_GetPayments 4 params → 200401503default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are LightningInvoiceData (10 properties), LightningNodeInformationData (9 properties), LightningPaymentData (8 properties), LightningChannelData (6 properties). Each schema is shown below with its type and property counts.

LightningInvoiceStatus
string
LightningPaymentStatus
string
LightningPaymentData
object
8 properties
LightningInvoiceData
object
10 properties
ConnectToNodeRequest
object
1 property
TimeSpanSeconds
A span of times in seconds
LightningNodeInformationData
object
9 properties
LightningChannelData
object
6 properties
CreateLightningInvoiceRequest
object
5 properties
OffchainBalanceData
object
4 properties
LightningNodeBalanceData
object
2 properties
UnixTimestamp
number
A unix timestamp in seconds
PayLightningInvoiceRequest
object
5 properties
ProblemDetails
object
Description of an error happening during processing of the request
2 properties
TimeSpan
number
OpenLightningChannelRequest
object
3 properties
OnchainBalanceData
object
3 properties
HistogramData
object
Histogram data for wallet balances over time
4 properties
StoreId
string
Store ID of the item
ValidationProblemDetails
array
An array of validation errors of the request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

btcpay-lightning-store-api-openapi.yml Raw ↑

Other APIs BTCPay Server publishes across the network.

BTCPay Server API Keys API
AE Profile APIs.io
BTCPay Server Apps API
AE Profile APIs.io
BTCPay Server Authorization API
AE Profile APIs.io
BTCPay Server Crowdfund API
AE Profile APIs.io
BTCPay Server Files API
AE Profile APIs.io
BTCPay Server Health API
AE Profile APIs.io
BTCPay Server Invoices API
AE Profile APIs.io
BTCPay Server Lightning address API
AE Profile APIs.io
BTCPay Server Lightning (Internal Node) API
AE Profile APIs.io
BTCPay Server Miscelleneous API
AE Profile APIs.io
BTCPay Server Notifications (Current User) API
AE Profile APIs.io
BTCPay Server Payment Requests API
AE Profile APIs.io
#Lightning (Store)
← Back to B APIs
API Details
ID
btcpay:btcpay-lightning-store-api
Base URL
https://{btcpay-host}/api/v1
Docs
https://docs.btcpayserver.org/API/Greenfield/v1/
Provider
BTCPay Server
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=btcpay-lightning-store-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/btcpay-lightning-store-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BTCPay Server Lightning (Store) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.