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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/btcpay:btcpay-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: BTCPay Greenfield Reports API
version: v1
description: '# Introduction
The BTCPay Server Greenfield API is a REST API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
# Authentication
You can authenticate either via Basic Auth or an API key. It''s recommended to use an API key for better security. You can create an API key in the BTCPay Server UI under `Account` -> `Manage Account` -> `API keys`. You can restrict the API key for one or multiple stores and for specific permissions. For testing purposes, you can give it the ''Unrestricted access'' permission. On production you should limit the permissions to the actual endpoints you use, you can see the required permission on the API docs at the top of each endpoint under `AUTHORIZATIONS`.
If you want to simplify the process of creating API keys for your users, you can use the Authorization endpoint to predefine permissions and redirect your users to the BTCPay Server Authorization UI. You can find more information about this on the API Authorization Flow docs page.
# Usage examples
Use **Basic Auth** to read store information with cURL:
```bash
BTCPAY_INSTANCE="https://mainnet.demo.btcpayserver.org"
USER="MyTestUser@gmail.com"
PASSWORD="notverysecurepassword"
PERMISSION="btcpay.store.canmodifystoresettings"
BODY="$(echo "{}" | jq --arg "a" "$PERMISSION" ''. + {permissions:[$a]}'')"
API_KEY="$(curl -s \
-H "Content-Type: application/json" \
--user "$USER:$PASSWORD" \
-X POST \
-d "$BODY" \
"$BTCPAY_INSTANCE/api/v1/api-keys" | jq -r .apiKey)"
```
Use an **API key** to read store information with cURL:
```bash
STORE_ID="yourStoreId"
curl -s \
-H "Content-Type: application/json" \
-H "Authorization: token $API_KEY" \
-X GET \
"$BTCPAY_INSTANCE/api/v1/stores/$STORE_ID"
```
You can find more examples on our docs for different programming languages:
- cURL
- Javascript/Node.Js
- PHP'
contact:
name: BTCPay Server
url: https://btcpayserver.org
license:
name: MIT
url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: /
description: BTCPay Server Greenfield API
security:
- API_Key: []
Basic: []
tags:
- name: Reports
description: Store report operations
paths:
/api/v1/stores/{storeId}/reports:
get:
tags:
- Reports
summary: Get available reports
description: Get the names of reports currently available for the store.
operationId: Reports_GetStoreReports
parameters:
- $ref: '#/components/parameters/StoreId'
responses:
'200':
description: The available report names
content:
application/json:
schema:
type: array
items:
type: string
example:
- Credit History
- Invoices
- Payments
- Payouts
- Refunds
- Requests
- Sales
- Subscribers
- Wallets
'401':
description: Missing authorization
'403':
description: Authenticated but forbidden to view reports
security:
- API_Key:
- btcpay.store.canviewreports
Basic: []
post:
tags:
- Reports
summary: Run a report
description: 'Run an available store report over an explicit date range. The `search` value is a comma-separated list of `field:value` filters.
Required report filter:
- `view`: The report name returned by Get available reports, for example `view:Invoices`.
Date filters:
- `daterange`: A predefined range. Supported values are `alltime`, `today`, `yesterday`, `thisweek`, `lastweek`, `thismonth`, `lastmonth`, `last30d`, `thisquarter`, `lastquarter`, `thisyear`, `lastyear`, `yeartodate`, `-1d`, `-24h`, `-3d`, and `-7d`. `alltime` covers the Unix epoch through the current time.
- `startdate`: The inclusive start date or timestamp. Use this instead of `daterange` for a custom range.
- `enddate`: The inclusive end date or timestamp. It is optional when `startdate` is present and defaults to the current time. It cannot be used without `startdate`.
- `timezone`: An IANA timezone such as `America/New_York` or `Asia/Tokyo`. It is required with `daterange` and whenever `startdate` or `enddate` does not contain an explicit UTC offset.
Dates with an explicit offset use ISO 8601, for example `2026-01-01T00:00:00Z` or `2026-01-01T09:00:00+09:00`. The resolved start date must be before the resolved end date. Other search filters are accepted but ignored by the built-in report providers.'
operationId: Reports_RunStoreReport
parameters:
- $ref: '#/components/parameters/StoreId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StoreReportRequest'
responses:
'200':
description: The generated report
content:
application/json:
schema:
$ref: '#/components/schemas/StoreReportResponse'
'401':
description: Missing authorization
'403':
description: Authenticated but forbidden to view reports
'422':
description: The search string or requested report is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationProblemDetails'
'503':
description: The requested report is temporarily unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
security:
- API_Key:
- btcpay.store.canviewreports
Basic: []
components:
schemas:
StoreId:
type: string
description: Store ID of the item
example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
StoreReportRequest:
type: object
additionalProperties: false
required:
- search
properties:
search:
type: string
description: A report search string containing a report view and date range.
example: view:Invoices,daterange:thismonth,timezone:UTC
UnixTimestamp:
type: number
format: int32
example: 1592312018
description: A unix timestamp in seconds
ValidationProblemDetails:
type: array
description: An array of validation errors of the request
items:
type: object
description: A specific validation error on a json property
properties:
path:
type: string
description: The json path of the property which failed validation
message:
type: string
description: User friendly error message about the validation
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
StoreReportResponse:
type: object
additionalProperties: false
required:
- data
- fields
- from
- reportName
- to
properties:
reportName:
type: string
description: The canonical report name.
timeZone:
type: string
description: The timezone from the search string, when specified.
example: Asia/Tokyo
from:
description: The inclusive start of the effective report range.
allOf:
- $ref: '#/components/schemas/UnixTimestamp'
to:
description: The inclusive end of the effective report range.
allOf:
- $ref: '#/components/schemas/UnixTimestamp'
fields:
type: array
description: The report columns in the same order as each data row.
items:
$ref: '#/components/schemas/StoreReportField'
data:
type: array
description: The report rows. Datetime values are Unix timestamps. Amount and decimal values are strings to preserve precision.
items:
type: array
items: {}
StoreReportField:
type: object
additionalProperties: false
required:
- name
- type
properties:
name:
type: string
description: The field name.
type:
type: string
description: The report provider's field type.
parameters:
StoreId:
name: storeId
in: path
required: true
description: The store ID
schema:
$ref: '#/components/schemas/StoreId'
securitySchemes:
API_Key:
type: apiKey
description: "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `btcpay.impersonation.canimpersonate`: Can impersonate users\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n* `btcpay.user.canviewprofile`: View your profile\n* `unrestricted`: Unrestricted access\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmanageusers`: Manage users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.canviewlightninginvoiceinternalnode`: View invoices from internal lightning node\n* `btcpay.server.canviewusers`: View users\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canarchivepullpayments`: Archive your pull payments\n* `btcpay.store.canbroadcasttransactions`: Broadcast wallet transactions\n* `btcpay.store.cancanceltransactions`: Cancel wallet transactions\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.cancreatelightninginvoice`: Create invoices from the lightning nodes associated with your stores\n* `btcpay.store.cancreatenonapprovedpullpayments`: Create non-approved pull payments\n* `btcpay.store.cancreatepullpayments`: Create pull payments\n* `btcpay.store.cancreatetransactions`: Create wallet transactions\n* `btcpay.store.cancreditsubscribers`: Credit your subscribers\n* `btcpay.store.canmanageinvoicestatus`: Manage invoice status\n* `btcpay.store.canmanagelegacyaccesstokens`: Manage legacy access tokens\n* `btcpay.store.canmanagepayouts`: Manage payouts\n* `btcpay.store.canmanagepullpayments`: Manage your pull payments\n* `btcpay.store.canmanagesubscribers`: Manage your subscribers\n* `btcpay.store.canmanagewallets`: Manage wallets\n* `btcpay.store.canmanagewalletsettings`: Manage wallet settings\n* `btcpay.store.canmanagewallettransactions`: Manage wallet transactions\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifyofferings`: Modify your offerings\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.cansendstoreemails`: Send store emails\n* `btcpay.store.cansigntransactions`: Sign wallet transactions\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canviewlightninginvoice`: View the lightning invoices associated with your stores\n* `btcpay.store.canviewofferings`: View your offerings\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canviewpayouts`: View payouts\n* `btcpay.store.canviewpullpayments`: View your pull payments\n* `btcpay.store.canviewreports`: View your reports\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.canviewwallet`: View wallets\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n"
name: Authorization
in: header
Basic:
type: http
description: BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme during the first five minutes after account creation or when the user explicitly enables it. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission
scheme: Basic
externalDocs:
description: BTCPay Greenfield Plugins API
url: https://docs.btcpayserver.org/API/Greenfield/Plugins/
x-provenance:
method: harvested
publisher: BTCPay Server
source: https://docs.btcpayserver.org/API/Greenfield/v1/swagger.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)