Skip to content
/
Create Guarantee Statemen...

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

Staking Rewards

Operations

TradingApi

Operations

Reports

Operations

Get Exchange Rates Statement

Request

Gets Exchange Rates Statement. Provides overview of exchange rates.

Security
api-key and nonce and timestamp and version and signature
Path
reportIdstring(uuid)required
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/reporting/api/v1/exchangeratesstatement/{reportId}' \
  -H 'X-Auth: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Nonce: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Signature: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Timestamp: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Version: YOUR_API_KEY_HERE' \
  -H 'customer-number: string'

Responses

Success

Bodyapplication/json
statestring(ReportState)required
Enum"Processing""Succeeded""Failed"
reportDataobject(ExchangeRatesStatement)
Response
application/json
{
  "state": "Processing",
  "reportData": {
    "dateTime": "2019-08-24T14:15:22Z",
    "referenceCurrency": "string",
    "items": [ … ]
  }
}

Create Guarantee Statement

Request

Starts Guarantee Statement creation. Informs on funds backed by bank guarantee and segregated custody.

Security
api-key and nonce and timestamp and version and signature
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'

Body
object(GuaranteeStatementRequest)
curl -i -X POST \
  https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/reporting/api/v1/guaranteestatement \
  -H 'Content-Type: application/json' \
  -H 'X-Auth: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Nonce: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Signature: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Timestamp: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Version: YOUR_API_KEY_HERE' \
  -H 'customer-number: string' \
  -d '{}'

Responses

Success

Bodyapplication/json
reportIdstring(uuid)
Response
application/json
{
  "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9"
}

Get Guarantee Statement

Request

Gets Guarantee Statement. Informs on funds backed by bank guarantee and segregated custody.

Security
api-key and nonce and timestamp and version and signature
Path
reportIdstring(uuid)required
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/reporting/api/v1/guaranteestatement/{reportId}' \
  -H 'X-Auth: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Nonce: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Signature: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Timestamp: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Version: YOUR_API_KEY_HERE' \
  -H 'customer-number: string'

Responses

Success

Bodyapplication/json
statestring(ReportState)required
Enum"Processing""Succeeded""Failed"
reportDataobject(GuaranteeStatement)
Response
application/json
{
  "state": "Processing",
  "reportData": {
    "totalCryptoAssets": 0.1,
    "cryptoSeparatedAssets": 0.1,
    "cryptoSeparatedAssetsHasCollateral": true,
    "cryptoCollectiveAssets": 0.1,
    "totalFiatAssets": 0.1,
    "totalOngoingTrading": 0.1,
    "ongoingCryptoTrading": 0.1,
    "ongoingFiatTrading": 0.1,
    "totalGuaranteeClaim": 0.1,
    "snapshotDate": "2019-08-24T14:15:22Z",
    "currency": "string",
    "externalBankName": "string",
    "externalBankAddress": "string",
    "externalBankZip": "string",
    "externalBankCity": "string",
    "externalBankCountry": "string"
  }
}

Loan Report

Operations