GET

List coins available to enterprise for staking

Retrieve a list of coins available for staking.

Path Params

enterpriseId string required

The enterprise ID.

Responses

200

Successful Retrieving a List of Stakeable Coins

Response Body

array of objects

symbol string
baseUnit string
isToken boolean
isTss boolean
isMultiSig boolean
l1Chain string
comingSoon boolean
disclaimer object

Disclaimer information specific to staking.
disclaimer object
- stakeWarmupPeriodDesc string nullable
  
  Optional description of the staking warmup period.
- rewardPercentageRate string decimal nullable
  
  Optional reward percentage rate for staking.
- apyMarginOfError string decimal nullable
  
  Optional margin of error for the APY rate.
- rewardsCompounding boolean
  
  True if rewards are compounded.
- period object
  
  Estimation period details for staking.
  period object
  - periodLow string
    
    Lower bound of the period in seconds or blocks.
  - periodHigh string
    
    Upper bound of the period in seconds or blocks.
  - coin string
    
    Coin associated with the period.
  - type string enum
    
    Type of period (WARMUP, EXIT, COOLDOWN).
    
    WARMUPEXITCOOLDOWN
- minStake string
  
  Minimum amount required to stake.
- minStakeMore string nullable
  
  Minimum additional amount to add to an active stake.
- stakingSubTypes array of objects nullable
  
  Optional list of staking sub-types with their own disclaimers.
  stakingSubTypes object
  - type string
    
    Sub-type identifier.
  - name string
    
    Sub-type display name.
  - info array of strings
    
    List of disclaimer messages for the sub-type.
  - transactionsNeeded integer
    
    Number of transactions required for the sub-type.
  - rewardsCompounding boolean
    
    True if rewards are compounded for this sub-type.
  - period object
    
    Estimation period details for staking.
    
    period object
    
    Same shape as EstimationPeriodAttributes.
  - minStake string
    
    Minimum staking amount for this sub-type.
  - minStakeMore string nullable
    
    Optional minimum additional stake required for this sub-type.
  - url string nullable
    
    Optional URL for more information about this sub-type.
  - iconName string nullable
    
    Optional icon name for UI representation.
  - defaultApy string decimal nullable
    
    Optional default APY for this sub-type.
  - stakeWarmupPeriodDesc string nullable
    
    Optional description of the staking warmup period for this sub-type.
  - rewardPercentageRate string decimal nullable
    
    Optional reward percentage rate for this sub-type.
  - apyMarginOfError string decimal nullable
    
    Optional margin of error for the APY rate for this sub-type.
  - rewardCycle integer nullable
    
    Optional time in seconds between reward distributions for this staking subtype. When present, this value overrides the base-level nextRewards.rewardCycle for this specific staking method.
- info array of strings
  
  List of disclaimer messages.
- transactionsNeeded integer
  
  Number of transactions required.
jurisdictions array of strings

List of jurisdictions where staking is available for this coin.

400

Bad Request

Response Body

object

error string
errorName string
reqId string
context object

401

Unauthorized

Response Body

object

error string
errorName string
reqId string
context object

403

Forbidden

Response Body

object

error string
errorName string
reqId string
context object

404

Not Found

Response Body

object

error string
errorName string
reqId string
context object

500

Server Error - Transient error please try again

Response Body

object

error string
errorName string
reqId string
context object

Language

Credentials

Bearer

Request

curl --request GET \
     --url 'https://app.bitgo-test.com/api/staking/v1/enterprises/enterpriseId/stakeable-coins' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Request

const url = 'https://app.bitgo-test.com/api/staking/v1/enterprises/enterpriseId/stakeable-coins';
const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/staking/v1/enterprises/enterpriseId/stakeable-coins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.bitgo-test.com/api/staking/v1/enterprises/enterpriseId/stakeable-coins', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/staking/v1/enterprises/enterpriseId/stakeable-coins"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)

print(response.text)

Response

[
  {
    "baseUnit": "lamport",
    "comingSoon": false,
    "disclaimer": {
      "nextRewards": {
        "rewardCycle": 172800
      },
      "staking": {
        "info": [
          "Staking has 1 transaction but takes on average 1 epoch (~36 hours) to activate the stake account and start earning rewards"
        ],
        "minStake": "1000",
        "period": {
          "coin": "TSOL",
          "periodHigh": "172800",
          "periodLow": "172800",
          "type": "WARMUP"
        },
        "rewardPercentageRate": "6.50153",
        "rewardsCompounding": false,
        "stakeWarmupPeriodDesc": "3 to 6 days",
        "stakingSubTypes": [
          {
            "defaultApy": "8.83",
            "info": [
              "Stake your SOL with Marinade Finance.",
              "Your staking position will be automatically managed and delegated to the best-performing validators while you retain full custody of your assets."
            ],
            "minStake": "1100000000",
            "name": "Marinade Staking",
            "rewardsCompounding": false,
            "transactionsNeeded": 1,
            "type": "MARINADE"
          },
          {
            "defaultApy": "8.18",
            "info": [
              "Stake your SOL with Marinade Select.",
              "Your staking position will be automatically managed and delegated through a curated set of validators with verified identity and zero tolerance for malicious MEV by Marinade.",
              "Marinade does not take custody of the keys to withdraw unstaked SOL."
            ],
            "minStake": "1100000000",
            "name": "Marinade Select Staking",
            "rewardsCompounding": false,
            "transactionsNeeded": 1,
            "type": "MARINADE_SELECT"
          },
          {
            "defaultApy": "7.27",
            "info": [
              "Stake your SOL with JitoSOL."
            ],
            "minStake": "0",
            "name": "JITO Staking",
            "rewardsCompounding": false,
            "transactionsNeeded": 1,
            "type": "JITO"
          }
        ],
        "transactionsNeeded": 1
      },
      "unstaking": {
        "info": [
          "Unstaking broadcasts 2 transactions: the transaction to unstake and the transaction to claim your reward. The network has to confirm the unstaking transaction then the claim transaction will be automatically created."
        ],
        "period": {
          "coin": "TSOL",
          "periodHigh": "172800",
          "periodLow": "172800",
          "type": "COOLDOWN"
        },
        "transactionsNeeded": 2,
        "unStakeCooldownPeriodDesc": "3 to 6 days"
      }
    },
    "isMultiSig": false,
    "isToken": false,
    "isTss": true,
    "jurisdictions": [],
    "symbol": "tsol"
  },
  {
    "baseUnit": "mist",
    "comingSoon": false,
    "disclaimer": {
      "nextRewards": {
        "rewardCycle": 86400
      },
      "staking": {
        "info": [
          "Pending requests can take up to 24 hours to process. Please await the next epoch."
        ],
        "minStake": "1000000000",
        "period": {
          "coin": "TSUI",
          "periodHigh": "86400",
          "periodLow": "86400",
          "type": "WARMUP"
        },
        "rewardPercentageRate": "2.10",
        "rewardsCompounding": true,
        "stakeWarmupPeriodDesc": "1 epoch (1 day)",
        "transactionsNeeded": 1
      },
      "unstaking": {
        "info": [
          "Unstaking requires 1 transaction to unstake. Rewards are claimed when user unstakes only. The unbonding period is 1 epoch (~1 day)."
        ],
        "period": {
          "coin": "TSUI",
          "periodHigh": "86400",
          "periodLow": "86400",
          "type": "COOLDOWN"
        },
        "transactionsNeeded": 1,
        "unStakeCooldownPeriodDesc": "1 epoch (1 day)"
      }
    },
    "isMultiSig": false,
    "isToken": false,
    "isTss": true,
    "symbol": "tsui"
  }
]

{
  "error": "Bad Request",
  "errorName": "BadRequest",
  "reqId": "some-id"
}

{
  "error": "Unauthorized",
  "errorName": "Unauthorized",
  "reqId": "some-id"
}

{
  "error": "Staking license not added for enterprise",
  "errorName": "AccessDenied",
  "reqId": "some-id"
}

{
  "error": "Wallet not found",
  "errorName": "NotFound",
  "reqId": "some-id"
}

{
  "error": "Database is down",
  "errorName": "Internal_Server_Error",
  "reqId": "some-id"
}