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 — 69 machine-readable artifacts across 1 API, 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 39.0/100 (thin), with a separate agent-readiness read of 30/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. Every facet and dimension name is a link: it opens that measurement's page on APIs.io, where the rating runs across the whole catalog — the exact checks that feed it, how every profiled provider distributes on it, and who is at the top of it.
Kin Score
How this is scored →scored 2026-09-10 · rubric v0.20.0
Put this on your own site. The badge is drawn live from BTCPay Server's current Kin Score — paste it once and it updates itself every time the score is recomputed. It follows your visitor's light or dark setting, and it links back here so anyone who sees it can read the full breakdown.
<!-- Kin Score · API Evangelist -->
<a href="https://providers.apievangelist.com/providers/btcpay/"
title="BTCPay Server on API Evangelist — API profile and Kin Score">
<img src="https://apis.io/badge/btcpay.svg"
alt="BTCPay Server Kin Score — API readiness rating by API Evangelist" width="150" height="150" loading="lazy">
</a>[](https://providers.apievangelist.com/providers/btcpay/)<!-- Kin Score · API Evangelist -->
<a href="https://providers.apievangelist.com/providers/btcpay/"
title="BTCPay Server on API Evangelist — API profile and Kin Score">
<img src="https://apis.io/badge/btcpay/card.svg"
alt="BTCPay Server Kin Score — API readiness rating by API Evangelist" width="340" height="120" loading="lazy">
</a>More shapes, themes and sizes → · Score as JSON · How badges work
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 ·
Open Collections 32
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
API Collection
OPEN COLLECTIONBTCPay Greenfield API Keys API
OPEN COLLECTIONBTCPay Greenfield API Keys Apps API
OPEN COLLECTIONBTCPay Greenfield API Keys Authorization API
OPEN COLLECTIONBTCPay Greenfield API Keys Crowdfund API
OPEN COLLECTIONBTCPay Greenfield API Keys Files API
OPEN COLLECTIONBTCPay Greenfield API Keys Health API
OPEN COLLECTIONBTCPay Greenfield API Keys Invoices API
OPEN COLLECTIONBTCPay Greenfield API Keys Lightning address API
OPEN COLLECTIONBTCPay Greenfield API Keys Lightning (Internal Node) API
OPEN COLLECTIONBTCPay Greenfield API Keys Lightning (Store) API
OPEN COLLECTIONBTCPay Greenfield API Keys Miscelleneous API
OPEN COLLECTIONBTCPay Greenfield API Keys Notifications (Current User) API
OPEN COLLECTIONBTCPay Greenfield API Keys Payment Requests API
OPEN COLLECTIONBTCPay Greenfield API Keys Payout Processors API
OPEN COLLECTIONBTCPay Greenfield API Keys Point of Sale API
OPEN COLLECTIONBTCPay Greenfield API Keys Pull payments (Management) API
OPEN COLLECTIONBTCPay Greenfield API Keys Pull payments payout (Public) API
OPEN COLLECTIONBTCPay Greenfield API Keys Pull payments (Public) API
OPEN COLLECTIONBTCPay Greenfield API Keys ServerEmail API
OPEN COLLECTIONBTCPay Greenfield API Keys ServerInfo API
OPEN COLLECTIONBTCPay Greenfield API Keys Store (Payment Methods) API
OPEN COLLECTIONBTCPay Greenfield API Keys Store Wallet (On Chain) API
OPEN COLLECTIONBTCPay Greenfield API Keys Stores API
OPEN COLLECTIONBTCPay Greenfield API Keys Stores (Email) API
OPEN COLLECTIONBTCPay Greenfield API Keys Stores (Payout Processors) API
OPEN COLLECTIONBTCPay Greenfield API Keys Stores (Payouts) API
OPEN COLLECTIONBTCPay Greenfield API Keys Stores (Rates) API
OPEN COLLECTIONBTCPay Greenfield API Keys Stores (Users) API
OPEN COLLECTIONBTCPay Greenfield API Keys Subscriptions API
OPEN COLLECTIONBTCPay Greenfield API Keys Users API
OPEN COLLECTIONBTCPay Greenfield API Keys Webhooks API
OPEN COLLECTIONScroll within the panel for all 32 ·
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 things the Kin Score reads for access clarity — renamed from commercial clarity in rubric 0.12, because a free statutory interface has access terms and no commercial ones.
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 3
Authentication, authorization, and security posture
Learn 1
Tutorials, courses, talks, and written guidance
Operate 4
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 3
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
This is an independent, third-party profile of BTCPay Server, 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.