Skip to content

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

Loan Report

Operations

List Borrowing Reports

Request

Get list of loan reports where specified client is borrower

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'

curl -i -X GET \
  https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/loans/v1/report/borrow \
  -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/jsonArray [
portfolioIdstring or null
serviceFeenumber(decimal)
collateralizationnumber(decimal)
currentLtvnumber(decimal)
smLtvnumber(decimal)
hmLtvnumber(decimal)
loansArray of objects or null(LoanReport)
collateralsArray of objects or null(CollateralReport)
]
Response
application/json
[
  {
    "portfolioId": "string",
    "serviceFee": 0,
    "collateralization": 0,
    "currentLtv": 0,
    "smLtv": 0,
    "hmLtv": 0,
    "loans": [ … ],
    "collaterals": [ … ]
  }
]

List Lending Reports

Request

Get list of loan reports where specified client is lender

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'

curl -i -X GET \
  https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/loans/v1/report/lend \
  -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/jsonArray [
portfolioIdstring or null
serviceFeenumber(decimal)
collateralizationnumber(decimal)
currentLtvnumber(decimal)
smLtvnumber(decimal)
hmLtvnumber(decimal)
loansArray of objects or null(LoanReport)
collateralsArray of objects or null(CollateralReport)
]
Response
application/json
[
  {
    "portfolioId": "string",
    "serviceFee": 0,
    "collateralization": 0,
    "currentLtv": 0,
    "smLtv": 0,
    "hmLtv": 0,
    "loans": [ … ],
    "collaterals": [ … ]
  }
]