Skip to content
/
List Onchain Information

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

Get Account

Request

Get a single account by its account ID

Security
api-key and nonce and timestamp and version and signature
Path
accountIdinteger(int64)required
Headers
customer-numberstring

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/custody/v1/Accounts/{accountId}' \
  -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
idinteger(int64)
assetSymbolstring or null
statestring(CustodyAccountState)
Enum"Unknown""Active""Inactive""Closed""Invalid"
typestring(CustodyAccountType)
Enum"Unknown""Trading""Staking""Vault""VaultStaking""Loan"
subTypestring(CustodyAccountSubType)
Enum"Unknown""Normal""Collateral""Advisory""AdvisoryPassive"
flagsArray of strings or null(CustodyAccountFlag)
Enum"Unknown""Dormant""CashWithdrawalsBlocked""CashInpaymentsBlocked""DebitsAndCashInpaymentBlocked""NotBookable""Blocked""DebitFreeze""CreditFreeze""Active"
balancenumber(decimal)
availablenumber(decimal)
reservednumber(decimal)
disposablenumber(decimal)
creditLinenumber(decimal)
namestring or null
Response
application/json
{
  "id": 0,
  "assetSymbol": "string",
  "state": "Unknown",
  "type": "Unknown",
  "subType": "Unknown",
  "flags": [
    "Unknown"
  ],
  "balance": 0,
  "available": 0,
  "reserved": 0,
  "disposable": 0,
  "creditLine": 0,
  "name": "string"
}

List Onchain Information

Request

List all onchain information associated with the accounts of the customer selected using the customer-number header

Note: the blockchain addresses provided in the API response are for informational purposes only. Do not deposit directly to them. For making deposits, please use the deposit instructions provided through your Bitcoin Suisse Online Account

Security
api-key and nonce and timestamp and version and signature
Headers
customer-numberstring

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/custody/v1/Accounts/OnchainInfo \
  -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 [
accountIdinteger(int64)
assetSymbolstring or null
balancenumber(decimal)
onchainInfoArray of objects or null(OnchainInfo)
]
Response
application/json
[
  {
    "accountId": 0,
    "assetSymbol": "string",
    "balance": 0,
    "onchainInfo": [ … ]
  }
]

Get Onchain Information For Account

Request

Get onchain information for a single account by its account ID

Note: the blockchain addresses provided in the API response are for informational purposes only. Do not deposit directly to them. For making deposits, please use the deposit instructions provided through your Bitcoin Suisse Online Account

Security
api-key and nonce and timestamp and version and signature
Path
accountIdinteger(int64)required
Headers
customer-numberstring

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/custody/v1/Accounts/OnchainInfo/{accountId}' \
  -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
accountIdinteger(int64)
assetSymbolstring or null
balancenumber(decimal)
onchainInfoArray of objects or null(OnchainInfo)
Response
application/json
{
  "accountId": 0,
  "assetSymbol": "string",
  "balance": 0,
  "onchainInfo": [
    { … }
  ]
}

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