Skip to content
Staking Products/
List Staking Products

Bitcoin Suisse API (1.5.0)

The Bitcoin Suisse API allows customers of Bitcoin Suisse to automate activities like trading, custody, staking and reporting using their own tools.

Have a look at the Developer Portal to find out how to get an API key and how authentication works.

Download OpenAPI description
BitcoinSuisseOpenApi.json
BitcoinSuisseOpenApi.yaml
Overview
URL
https://bitcoinsuisse.com
Bitcoin Suisse AG
platform@bitcoinsuisse.com
License
Copyright © Bitcoin Suisse AG - 2026
Terms of Service
Languages
Servers
Mock server
https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi
Bitcoin Suisse API
https://api.bitcoinsuisse.com
Bitcoin Suisse Sandbox API
https://sandbox-api.btcsqa.net

Customers

Operations

Accounts

Operations

HistoricalPortfolioValue

Operations

Trading Accounts

Operations

Trading Configuration

Operations

Trading Instruments

Operations

Market Data

Operations

Trading Orders

Operations

Public

Operations

Staking Orders

Operations

Staking Accounts

Operations

Staking Products

Operations

List Staking Products

Request

Query
includeProductInformationboolean
Default false
Headers
customer-numberstringrequired

Defines which customer the request is executed for. If you manage multiple customers, this is how you switch between them. Use the Customer Management API endpoints to get the customer data. Example: 'BTCS-CUS-123456'

curl -i -X GET \
  'https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/staking/v5/products?includeProductInformation=false' \
  -H 'customer-number: string'

Responses

Success

Bodyapplication/jsonArray [
idstring(uuid)

Unique identifier.

namestring

User-friendly name.

publiclyAvailableboolean

True if the product is Publicly available for all customers.

stakingAccountAssetSymbolstring

Required asset symbol on a staking account used for staking order or reward account.

tradingAccountAssetSymbolstring

Required asset symbol on a trading account used for staking order or reward account.

payoutAssetSymbolstring

Asset symbol used for payouts.

supportedPayoutAccountTypesArray of strings(AccountType)

The types of payout accounts that can be chosen if staking on this product.

Items Enum"Unknown""Trading""Staking""Vault"
minimumStakingAccountBalancenumber or null(decimal)

If not empty, new staking account balance must be 0 or at least this minimum amount.

minimumStakingAccountBalanceChfnumber or null(decimal)

If not empty, new staking account balance in CHF must be 0 or at least this minimum amount.

minimumStakingAccountBalanceMultipliernumber or null(decimal)

If not empty, new staking account balance must be a multiple of this amount.

minimumEntryStakingOrderAmountnumber or null(decimal)

If not empty, an entry order amount must be at least this minimum amount.

minimumEntryStakingOrderAmountChfnumber or null(decimal)

If not empty, anentry order amount in CHF must be at least this minimum amount.

minimumExitStakingOrderAmountnumber or null(decimal)

If not empty, an exit order amount must be at least this minimum amount.

minimumExitStakingOrderAmountChfnumber or null(decimal)

If not empty, an exit order amount in CHF must be at least this minimum amount.

maximumEntryStakingOrderAmountnumber or null(decimal)

If set, the maximum entry size of an order.

maximumExitStakingOrderAmountnumber or null(decimal)

If set, the maximum exit size of an order.

entryOrdersDisabledboolean

If set, it is not possible to place entries orders at all. If online is used, the client is informed in Online that entries are no longer offered (not even via a Relationship Manager)

entryOrdersViaRmOnlyboolean

If set, it is only possible to place entry orders via a Relationship Manager. If online is used, the client is informed in online that the Relationship Manager must be contacted for entries.

exitOrdersViaRmOnlyboolean

If set, it is only possible to place exit orders via a Relationship Manager. If Online is used, the client is informed in online that the Relationship Manager must be contacted for exits.

productInformationobject or null

Product information such as reward and locking times.

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "publiclyAvailable": true,
    "stakingAccountAssetSymbol": "string",
    "tradingAccountAssetSymbol": "string",
    "payoutAssetSymbol": "string",
    "supportedPayoutAccountTypes": [ … ],
    "minimumStakingAccountBalance": 0,
    "minimumStakingAccountBalanceChf": 0,
    "minimumStakingAccountBalanceMultiplier": 0,
    "minimumEntryStakingOrderAmount": 0,
    "minimumEntryStakingOrderAmountChf": 0,
    "minimumExitStakingOrderAmount": 0,
    "minimumExitStakingOrderAmountChf": 0,
    "maximumEntryStakingOrderAmount": 0,
    "maximumExitStakingOrderAmount": 0,
    "entryOrdersDisabled": true,
    "entryOrdersViaRmOnly": true,
    "exitOrdersViaRmOnly": true,
    "productInformation": { … }
  }
]

Staking Rewards

Operations

TradingApi

Operations

Reports

Operations

Loan Report

Operations