BTCPay Server

BTCPay Server Stores (Rates) API

Stores rate information and configuration

GitHub OpenAPI

Operations 4

GET /api/v1/stores/{storeId}/rates Get rates #
GET /api/v1/stores/{storeId}/rates/configuration/{rateSource} Get store rate settings for the specified rate source #
PUT /api/v1/stores/{storeId}/rates/configuration/{rateSource} Get store rate settings for the specified rate source #
POST /api/v1/stores/{storeId}/rates/configuration/preview Preview rate configuration results #

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-stores-rates-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-stores-rates-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-stores-rates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BTCPay Greenfield Stores (Rates) 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: Stores (Rates)
  description: Stores rate information and configuration
paths:
  /api/v1/stores/{storeId}/rates:
    get:
      tags:
      - Stores (Rates)
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - name: currencyPair
        description: The currency pairs to fetch rates for
        example:
        - BTC_USD
        - BTC_EUR
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        x-position: 1
      summary: Get rates
      description: Get rates on the store
      operationId: Stores_GetStoreRates
      responses:
        '200':
          description: The settings were executed and a preview was returned
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StoreRateResult'
        '400':
          description: A list of errors that occurred when previewing the settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '403':
          description: If you are authenticated but forbidden to modify the store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
  /api/v1/stores/{storeId}/rates/configuration/{rateSource}:
    get:
      tags:
      - Stores (Rates)
      summary: Get store rate settings for the specified rate source
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/RateSource'
      description: View rate settings for the specified store and rate source (`primary` or `fallback`).
      operationId: Stores_GetStoreRateConfiguration
      responses:
        '200':
          description: specified store rate settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreRateConfiguration'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The specified store or rate source was not found
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
    put:
      tags:
      - Stores (Rates)
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/RateSource'
      summary: Get store rate settings for the specified rate source
      description: Update rate settings for the specified store and rate source (`primary` or `fallback`).
      operationId: Stores_UpdateStoreRateConfiguration
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreRateConfiguration'
        required: true
        x-position: 1
      responses:
        '200':
          description: The settings were updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreRateConfiguration'
        '400':
          description: A list of errors that occurred when updating the settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '403':
          description: If you are authenticated but forbidden to modify the store
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
  /api/v1/stores/{storeId}/rates/configuration/preview:
    post:
      tags:
      - Stores (Rates)
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - name: currencyPair
        description: The currency pairs to preview
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        x-position: 1
      summary: Preview rate configuration results
      description: Preview rate configuration results before you set it on the store
      operationId: Stores_PreviewStoreRateConfiguration
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreRateConfiguration'
        required: true
        x-position: 1
      responses:
        '200':
          description: The settings were executed and a preview was returned
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StoreRateResult'
        '400':
          description: A list of errors that occurred when previewing the settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '403':
          description: If you are authenticated but forbidden to modify the store
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
components:
  parameters:
    StoreId:
      name: storeId
      in: path
      required: true
      description: The store ID
      schema:
        $ref: '#/components/schemas/StoreId'
    RateSource:
      name: rateSource
      in: path
      required: true
      description: The rate source to configure (`primary` or `fallback`)
      schema:
        type: string
        default: primary
        example: primary
  schemas:
    StoreRateConfiguration:
      type: object
      additionalProperties: false
      properties:
        spread:
          type: string
          description: A spread applies to the rate fetched in `%`. Must be `>= 0` or `<= 100`
        preferredSource:
          type: string
          description: When `isCustomScript` is `false`, uses this source in the default `effectiveScript`. When `isCustomScript` is `true`, this field is ignored (set to `null`). See `/misc/rate-sources` for available sources.
        isCustomScript:
          type: boolean
          description: Whether to use `preferredSource` with default script or a custom `effectiveScript`.
        effectiveScript:
          type: string
          description: When `isCustomScript` is `true`, this represent the custom script used to calculate a currency pair's exchange rate. Else, it represent the script generated by the default rules and `preferredSource`.
    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
    StoreRateResult:
      type: object
      additionalProperties: false
      properties:
        currencyPair:
          type: string
          example: BTC_USD
          description: Currency pair in the format of `BTC_USD`
        errors:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Errors relating to this currency pair fetching based on your config
        rate:
          type: string
          format: decimal
          example: '64392.23'
          description: the rate fetched based on the currency pair
    StoreId:
      type: string
      description: Store ID of the item
      example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
  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/