BTCPay Server
BTCPay Server is a self-hosted, open-source Bitcoin and cryptocurrency payment processor with a comprehensive REST API (Greenfield API v1) for managing stores, invoices, wallets, Lightning Network nodes, payment requests, pull payments, webhooks, users, and server configuration. It operates with zero fees, no third-party dependency, and is released under the MIT license.
Limited machine-readable signal and partial portal coverage — documentation a human can read, but little a machine or agent can consume without scraping.
API Evangelist profiles BTCPay Server the way a machine reads it — 37 machine-readable artifacts across 31 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — BTCPay Server scores 41.3/100 (thin), with a separate agent-readiness read of 48/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
How we profile BTCPay Server
Each block below is one kind of artifact we hold for BTCPay Server. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 31
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
BTCPay Server API Keys API
API Key operations
BTCPay Server Apps API
App operations
BTCPay Server Authorization API
Authorization operations
BTCPay Server Crowdfund API
Crowdfund operations
BTCPay Server Files API
File operations
BTCPay Server Health API
Health operations
BTCPay Server Invoices API
Invoice operations
BTCPay Server Lightning address API
Lightning address configuration
BTCPay Server Lightning (Internal Node) API
Lightning (Internal Node) operations
BTCPay Server Lightning (Store) API
Lightning (Store) operations
BTCPay Server Miscelleneous API
Miscelleneous operations
BTCPay Server Notifications (Current User) API
Notifications operations
BTCPay Server Payment Requests API
Payment Requests operations
BTCPay Server Payout Processors API
Payout Processors operations
BTCPay Server Point of Sale API
Point of Sale operations
BTCPay Server Pull payments (Management) API
Pull payments (Management) operations
BTCPay Server Pull payments payout (Public) API
Pull payments payout (Public) operations
BTCPay Server Pull payments (Public) API
Pull payments (Public) operations
BTCPay Server ServerEmail API
Server Email Settings operations
BTCPay Server ServerInfo API
Server Info operations
BTCPay Server Store (Payment Methods) API
Store Payment Methods operations
BTCPay Server Store Wallet (On Chain) API
Store Wallet (On Chain) operations
BTCPay Server Stores API
Store operations
BTCPay Server Stores (Email) API
Store Emails operations
BTCPay Server Stores (Payout Processors) API
Stores (Payout Processors) operations
BTCPay Server Stores (Payouts) API
Store pull payment payout operations
BTCPay Server Stores (Rates) API
Stores rate information and configuration
BTCPay Server Stores (Users) API
Store Users operations
BTCPay Server Subscriptions API
Subscription operations
BTCPay Server Users API
User operations
BTCPay Server Webhooks API
Webhook operations
Scroll within the panel for all 31 ·
Pricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Plans
PLANSRate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Finops
FINOPSSecurity Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for BTCPay Server — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Documentation 1
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Build 2
SDKs, sample code, and the tooling you integrate with
Access & Security 2
Authentication, authorization, and security posture
Learn 1
Tutorials, courses, talks, and written guidance
Operate 3
Status, limits, changes, and where to get help
Commercial 2
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Other 2
Properties that don't map to a standard resource type
← All providers · Data indexed from github.com/api-evangelist/btcpay · machine-readable index on apis.io