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.

BTCPay Server publishes 32 API contracts indexed on the APIs.io network, including API Keys API, Apps API, Authorization API, and 29 more. Tagged areas include Bitcoin, Cryptocurrency, Payments, Lightning Network, and Open Source.

The BTCPay Server catalog on APIs.io includes 1 Spectral governance ruleset.

BTCPay Server’s developer surface includes authentication, documentation, engineering blog, YouTube channel, changelog, support, and 17 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

38.3/100 thin ▬ flat Agent 29/100 agent ready Front door AI 1/6 silent Heartbeat 100/100 alive open core · MIT Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessFreeSelf serve⚡ Free to try

1 published contract

Bitcoin Cryptocurrency Payments Lightning Network Open Source Self-Hosted

What this lets a business do 2

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Developer Platform & API Ecosystem Management

BC-4270

Webhooks

POST /api/v1/stores/{storeId}/webhooks GET /api/v1/webhooks/{webhookId}/deliveries POST /api/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver

Subscription Lifecycle Management

BC-4240

Subscriptions

POST /api/v1/stores/{storeId}/offerings POST /api/v1/stores/{storeId}/offerings/{offeringId}/plans GET /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector} POST /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector}/suspend

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 38.3/100 · thin

Contract Quality 8.8 / 16

Developer Ergonomics 3.7 / 13

Access Clarity 0.7 / 13

Operational Transparency 3.1 / 8

Contract Governance 2.1 / 8

Discoverability 4.3 / 7

Regulatory Posture 2.3 / 15

Open Source Surface 6.0 / 10

Create-or-Update Ergonomics 2.2 / 10

Agent readiness — 29/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 0 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Open Source Surface applies to this provider. This product is open source and we read its repository directly, so Open Source Surface carries 10 points of the composite. It is scored from what the repository actually publishes — a security policy, a contribution guide, a release history, a code of conduct — read live from the provider rather than inferred from our own catalog pointers. This facet adds; nothing was taken away to make room for it. An open-source project is not excused from the commercial facets, because exemption would strip it of the points it does earn. If we have the wrong repository, or this product is not open source, say so on your provider repo and we will drop the facet rather than have you publish against it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 65 points between them, because both conditional facets apply and carry 35 points together. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 65% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/btcpay/"><img src="https://apis.io/badge/btcpay/card.svg" alt="BTCPay Server on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
Typed Event Surface +6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks

7 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 5.3 — up to +18.9 composite points
Developer Ergonomics scores 28.6 — up to +14.3 composite points
Contract Quality scores 53.9 — up to +11.5 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/btcpay/apis.yml: open an issue on github.com/api-evangelist/btcpay to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
DigitalOcean Marketplace (partner 1-click apps and SaaS add-ons)	builds-on	22.2	-	1

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

APIs 32

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 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

BTCPay Server Reports API

Store report operations

BTCPay Server Server Info API

Server Info operations

Scroll for all 32

Open Collections 31

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

BTCPay Greenfield API Keys API

OPEN COLLECTION

BTCPay Greenfield API Keys Apps API

OPEN COLLECTION

BTCPay Greenfield API Keys Authorization API

OPEN COLLECTION

BTCPay Greenfield API Keys Crowdfund API

OPEN COLLECTION

BTCPay Greenfield API Keys Files API

OPEN COLLECTION

BTCPay Greenfield API Keys Health API

OPEN COLLECTION

BTCPay Greenfield API Keys Invoices API

OPEN COLLECTION

BTCPay Greenfield API Keys Lightning address API

OPEN COLLECTION

BTCPay Greenfield API Keys Lightning (Internal Node) API

OPEN COLLECTION

BTCPay Greenfield API Keys Lightning (Store) API

OPEN COLLECTION

BTCPay Greenfield API Keys Miscelleneous API

OPEN COLLECTION

BTCPay Greenfield API Keys Notifications (Current User) API

OPEN COLLECTION

BTCPay Greenfield API Keys Payment Requests API

OPEN COLLECTION

BTCPay Greenfield API Keys Payout Processors API

OPEN COLLECTION

BTCPay Greenfield API Keys Point of Sale API

OPEN COLLECTION

BTCPay Greenfield API Keys Pull payments (Management) API

OPEN COLLECTION

BTCPay Greenfield API Keys Pull payments payout (Public) API

OPEN COLLECTION

BTCPay Greenfield API Keys Pull payments (Public) API

OPEN COLLECTION

BTCPay Greenfield API Keys ServerEmail API

OPEN COLLECTION

BTCPay Greenfield API Keys ServerInfo API

OPEN COLLECTION

BTCPay Greenfield API Keys Store (Payment Methods) API

OPEN COLLECTION

BTCPay Greenfield API Keys Store Wallet (On Chain) API

OPEN COLLECTION

BTCPay Greenfield API Keys Stores API

OPEN COLLECTION

BTCPay Greenfield API Keys Stores (Email) API

OPEN COLLECTION

BTCPay Greenfield API Keys Stores (Payout Processors) API

OPEN COLLECTION

BTCPay Greenfield API Keys Stores (Payouts) API

OPEN COLLECTION

BTCPay Greenfield API Keys Stores (Rates) API

OPEN COLLECTION

BTCPay Greenfield API Keys Stores (Users) API

OPEN COLLECTION

BTCPay Greenfield API Keys Subscriptions API

OPEN COLLECTION

BTCPay Greenfield API Keys Users API

OPEN COLLECTION

BTCPay Greenfield API Keys Webhooks API

OPEN COLLECTION

Scroll for all 31

BTCPay Server API pricing

Not yet checked against BTCPay Server's own pricing page. Compiled by API Evangelist; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
Self-Hosted (Free)	Free
Third-Party Hosted	—

Plan details, limits and sources →

Pricing Plans 1

Published pricing tiers and plan structures.

Plans

2 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Rate Limits

0 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

BTCPay Server

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Finops

FINOPS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

BTCPay Server API Rules

68 rules · 47 errors 15 warnings 6 info

SPECTRAL

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Btcpay Authentication

apiKey/http · 2 schemes

SECURITY

Btcpay Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Btcpay Agentic Access

195 operations · 102 acting · 6 human-in-the-loop

195 operations · 102 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Build 2

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

GitHubRepository

GitHubRepository

Access & Security 3

Authentication, authorization, and security posture

SecurityPolicy

SecurityPolicy

DomainSecurity

DomainSecurity

Authentication

Authentication

Learn 1

Tutorials, courses, talks, and written guidance

YouTube

YouTube

Operate 5

Status, limits, changes, and where to get help

RateLimits

IssueTracker

ChangeLog

StatusPage

Support

Commercial 4

Pricing, plans, and the legal terms of use

Plans

FinOps

License

PrivacyPolicy

Company 3

The organization behind the API

Website

Website

Blog

Blog

Twitter

Twitter

Other 3

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Mattermost

Mattermost

Contributing

Contributing

Source (apis.yml)

name: BTCPay Server
description: 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.
deliveryModel:
  model: open-core
  license: MIT
  license_evidence:
    repo: btcpayserver/btcpayserver
    spdx: MIT
    stars: 7778
  open_source: true
  commercial: true
  callable_host: false
  label: Open core · an OSS project plus a commercial hosted product
  confidence: medium
  source:
  - openapi
  - pricing
  - repository-license
  generated: '2026-09-25'
  method: derived
accessModel:
  pricing: free
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Free · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-06'
  method: derived
image: https://btcpayserver.org/images/btcpay-logo.svg
tags:
- Bitcoin
- Cryptocurrency
- Payments
- Lightning Network
- Open Source
- Self-Hosted
tags_raw:
- Bitcoin
- Cryptocurrency
- Payments
- Lightning Network
- Open Source
- Self-Hosted
- Open-Source
created: '2026-06-13'
modified: '2026-06-13'
url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/apis.yml
specificationVersion: '0.23'
apis:
- aid: btcpay:btcpay-api-keys-api
  name: BTCPay Server API Keys API
  description: API Key operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - APIKeys
  tags_raw:
  - API Keys
  properties:
  - type: OpenAPI
    url: openapi/btcpay-api-keys-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-apps-api
  name: BTCPay Server Apps API
  description: App operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Application
  tags_raw:
  - Apps
  properties:
  - type: OpenAPI
    url: openapi/btcpay-apps-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-authorization-api
  name: BTCPay Server Authorization API
  description: Authorization operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Authorization
  properties:
  - type: OpenAPI
    url: openapi/btcpay-authorization-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-crowdfund-api
  name: BTCPay Server Crowdfund API
  description: Crowdfund operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Crowdfund
  properties:
  - type: OpenAPI
    url: openapi/btcpay-crowdfund-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-files-api
  name: BTCPay Server Files API
  description: File operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - File
  tags_raw:
  - Files
  properties:
  - type: OpenAPI
    url: openapi/btcpay-files-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-health-api
  name: BTCPay Server Health API
  description: Health operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/btcpay-health-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-invoices-api
  name: BTCPay Server Invoices API
  description: Invoice operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Invoices
  properties:
  - type: OpenAPI
    url: openapi/btcpay-invoices-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-lightning-address-api
  name: BTCPay Server Lightning address API
  description: Lightning address configuration
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Lightning address
  properties:
  - type: OpenAPI
    url: openapi/btcpay-lightning-address-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-lightning-internal-node-api
  name: BTCPay Server Lightning (Internal Node) API
  description: Lightning (Internal Node) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Lightning (Internal Node)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-lightning-internal-node-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-lightning-store-api
  name: BTCPay Server Lightning (Store) API
  description: Lightning (Store) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Lightning (Store)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-lightning-store-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-miscelleneous-api
  name: BTCPay Server Miscelleneous API
  description: Miscelleneous operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Miscelleneous
  properties:
  - type: OpenAPI
    url: openapi/btcpay-miscelleneous-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-notifications-current-user-api
  name: BTCPay Server Notifications (Current User) API
  description: Notifications operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Notifications (Current User)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-notifications-current-user-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-payment-requests-api
  name: BTCPay Server Payment Requests API
  description: Payment Requests operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Payment Requests
  properties:
  - type: OpenAPI
    url: openapi/btcpay-payment-requests-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-payout-processors-api
  name: BTCPay Server Payout Processors API
  description: Payout Processors operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Payout Processors
  properties:
  - type: OpenAPI
    url: openapi/btcpay-payout-processors-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-point-of-sale-api
  name: BTCPay Server Point of Sale API
  description: Point of Sale operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Point-of-Sale
  tags_raw:
  - Point of Sale
  properties:
  - type: OpenAPI
    url: openapi/btcpay-point-of-sale-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-pull-payments-management-api
  name: BTCPay Server Pull payments (Management) API
  description: Pull payments (Management) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Pull payments (Management)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-pull-payments-management-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-pull-payments-payout-public-api
  name: BTCPay Server Pull payments payout (Public) API
  description: Pull payments payout (Public) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Pull payments payout (Public)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-pull-payments-payout-public-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-pull-payments-public-api
  name: BTCPay Server Pull payments (Public) API
  description: Pull payments (Public) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Pull payments (Public)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-pull-payments-public-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-serveremail-api
  name: BTCPay Server ServerEmail API
  description: Server Email Settings operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - ServerEmail
  properties:
  - type: OpenAPI
    url: openapi/btcpay-serveremail-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-store-payment-methods-api
  name: BTCPay Server Store (Payment Methods) API
  description: Store Payment Methods operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Store (Payment Methods)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-store-payment-methods-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-store-wallet-on-chain-api
  name: BTCPay Server Store Wallet (On Chain) API
  description: Store Wallet (On Chain) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Store Wallet (On Chain)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-store-wallet-on-chain-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-api
  name: BTCPay Server Stores API
  description: Store operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-email-api
  name: BTCPay Server Stores (Email) API
  description: Store Emails operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Email)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-email-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-payout-processors-api
  name: BTCPay Server Stores (Payout Processors) API
  description: Stores (Payout Processors) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Payout Processors)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-payout-processors-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-payouts-api
  name: BTCPay Server Stores (Payouts) API
  description: Store pull payment payout operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Payouts)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-payouts-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-rates-api
  name: BTCPay Server Stores (Rates) API
  description: Stores rate information and configuration
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Rates)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-rates-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://artifacts.apis.io/btcpay/apis.yml

BTCPay Server API — frequently asked questions

Does BTCPay Server have an API?

Yes. APIs.io lists 32 APIs from BTCPay Server, including BTCPay Server API Keys API, BTCPay Server Apps API and BTCPay Server Authorization API, and 29 more.

Is there an OpenAPI specification for the BTCPay Server API?

Yes. APIs.io indexes 32 OpenAPI specifications for BTCPay Server, each linked for download from this page.

How do I authenticate with the BTCPay Server API?

BTCPay Server uses bearer-token authentication (apiKey/http · 2 schemes). The details are profiled on APIs.io as Btcpay Authentication.

How much does the BTCPay Server API cost?

APIs.io lists 2 pricing plans for BTCPay Server, with each plan's price, limits and inclusions under Pricing on this page.

Is the BTCPay Server API ready for AI agents?

BTCPay Server has a Kin Score of 38.3 out of 100 (thin) and an Agent Readiness score of 29.2 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/btcpay"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/btcpay/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/btcpay/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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