BTCPay Server Greenfield API
The Greenfield API is BTCPay Server's primary REST API, providing programmatic access to stores, invoices, wallets, Lightning Network nodes, payment requests, pull payments, payouts, webhooks, notifications, users, API keys, apps, files, reports, server health, and server configuration. Authentication is via API keys or HTTP Basic Auth. The OpenAPI 3.0 specification is served at /swagger/v1/swagger.json on any BTCPay Server instance.
Documentation
Documentation
https://docs.btcpayserver.org/API/Greenfield/v1/
Authentication
https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
RateLimits
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
Specifications
OpenAPI
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/openapi/openapi.json
OpenAPI
https://{btcpay-host}/swagger/v1/swagger.json
SDKs
Other Resources
JSONLd
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
Vocabulary
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
Plans
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
FinOps
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml