BTCPay Server

BTCPay Server Health API

Health operations

GitHub OpenAPI

Operations 1

GET /api/v1/health Get health status #

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/btcpay-health-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/btcpayserver/btcpayserver

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

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/btcpay-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

btcpay-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BTCPay Greenfield Health API
  version: v1
  description: '# Introduction


    The BTCPay Server Greenfield API is a REST API.'
  contact:
    name: BTCPay Server
    url: https://btcpayserver.org
  license:
    name: MIT
    url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: https://{btcpay-host}
  description: Your BTCPay Server instance
  variables:
    btcpay-host:
      default: mainnet.demo.btcpayserver.org
      description: The hostname of your BTCPay Server instance
security:
- API_Key: []
  Basic: []
tags:
- name: Health
  description: Health operations
paths:
  /api/v1/health:
    get:
      tags:
      - Health
      summary: Get health status
      description: Check the instance health status
      operationId: Health_GetHealth
      responses:
        '200':
          description: Instance is up
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationHealthData'
        '403':
          description: If you are authenticated but forbidden to get the data
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security: []
components:
  schemas:
    ApplicationHealthData:
      type: object
      additionalProperties: false
      properties:
        synchronized:
          type: boolean
          description: True if the instance is fully synchronized, according to NBXplorer
    ProblemDetails:
      type: object
      description: Description of an error happening during processing of the request
      properties:
        code:
          type: string
          description: An error code describing the error
        message:
          type: string
          description: User friendly error message about the error
  securitySchemes:
    API_Key:
      type: apiKey
      in: header
      name: Authorization
      description: 'BTCPay Server API key. Format: ''token {apiKey}'''
    Basic:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with email and password
externalDocs:
  description: Check out our examples on how to use the API
  url: https://docs.btcpayserver.org/Development/GreenFieldExample/