Skip to content
/
List Staking Orders

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

List Staking Orders

Request

The purpose of this endpoint is to return a status regarding the customer's active staking orders, i.e. how much money is waiting to stake, how much is currently staking and how much is in the process of exiting staking.

Query
accountNumberstring^[0-9]{12}$

Filter on account number.

externalReferencestring^[0-9A-Z]{10}$

Filter on external reference.

orderTypestring

Filter on order type.

Enum"Unknown""Entry""Exit"
statesArray of strings(StakingOrderState)

Filter on order states

Items Enum"Open""Processing""Completed""Cancelled"
pageinteger(int32)

Page.

Default 1
pageSizeinteger(int32)

Page size. Default: 10.

Default 10
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/stakingOrders?accountNumber=string&externalReference=string&orderType=Unknown&states=Open&page=1&pageSize=10' \
  -H 'customer-number: string'

Responses

Success

Bodyapplication/json
countinteger(int32)
pageinteger(int32)
totalCountinteger(int32)
pageSizeinteger or null(int32)
itemsArray of objects(StakingOrder)
Response
application/json
{
  "count": 0,
  "page": 0,
  "totalCount": 0,
  "pageSize": 0,
  "items": [
    { … }
  ]
}

Create Staking Order

Request

Path
idstring(uuid)required

Unique identifier.

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
fromAccountNumberstring^[0-9]{12}$

Account that is debited.

toAccountNumberstring or null^[0-9]{12}$

Account that is credited.

productIdstring or null(uuid)

Id of product to stake for. Required if ToAccountNumber is null. If ToAccountNumber is set, it uses the product of the staking account

  • in that case ProductId cannot be input.
amountnumber(decimal)

Amount to move from debit to credit account.

externalReferencestring or null<= 50 characters^[0-9A-Z]{10}$

External reference (not unique, not required) to allow the source system to correlate external events within the Staking system.

curl -i -X PUT \
  'https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/staking/v5/stakingOrders/{id}' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'customer-number: string' \
  -d '{
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
    "amount": 0,
    "externalReference": "string"
  }'

Responses

Success

Response
No content

Get Staking Order

Request

Path
idstringrequired

Order ID or number.

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/stakingOrders/{id}' \
  -H 'customer-number: string'

Responses

Success

Bodyapplication/json
idstring(uuid)

Unique identifier.

amountnumber(decimal)

Amount to move from debit to credit account.

assetSymbolstring

Symbol corresponding to the TokenMaster asset.

orderNumberstring

User-friendly, uniquely assigned order number. Can be found as an external reference for staking order in other systems.

fromAccountNumberstring

Account that is credited.

toAccountNumberstring or null

Account that is credited.

customerNumberinteger(int32)

Customer that owns the accounts.

createdOnstring(date-time)

Timestamp for when the order was stored in the database.

estimatedEffectuatedTimestring or null(date-time)

Timestamp for when no-reward (entries) or reward period (exits) has ended.

estimatedCompletedTimestring or null(date-time)

Timestamp for when locking has ended.

effectuatedboolean

True if internal state is Effectuated or Released.

statestring

State of the order.

Enum"Open""Processing""Completed""Cancelled"
typestring

Type: Entrance or exit.

Enum"Unknown""Entry""Exit"
externalCommentstring or null

External comment.

transactionReferencestring or null

Transaction reference.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "amount": 0,
  "assetSymbol": "string",
  "orderNumber": "string",
  "fromAccountNumber": "string",
  "toAccountNumber": "string",
  "customerNumber": 0,
  "createdOn": "2019-08-24T14:15:22Z",
  "estimatedEffectuatedTime": "2019-08-24T14:15:22Z",
  "estimatedCompletedTime": "2019-08-24T14:15:22Z",
  "effectuated": true,
  "state": "Open",
  "type": "Unknown",
  "externalComment": "string",
  "transactionReference": "string"
}

Staking Accounts

Operations

Staking Products

Operations

Staking Rewards

Operations

TradingApi

Operations

Reports

Operations

Loan Report

Operations