GET

List coins available for staking

Retrieve a list of coins available for staking and additional information.

Query Params

page integer nullable

The page number for pagination.

>= 1

Defaults to 1
pageSize integer nullable

The page size for pagination.

>= 1 · <= 100

Defaults to 20
comingSoon boolean

If true, include coins that are coming soon but not yet available for staking.

Responses

200

Successful Retrieving a List of Stakeable Coins

Response Body

object

coins array of objects
coins object
- 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.
page integer
totalPages integer
totalElements integer

401

Unauthorized

Response Body

object

error string
errorName string
reqId string
context object
context object
- errorName string

500

Server Error - Transient error please try again

Response Body

object

error string
errorName string
reqId string
context object

curl --request GET \ --url 'https://app.bitgo-test.com/api/staking/v1/coins?page=1&pageSize=20&comingSoon=true' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/staking/v1/coins?page=1&pageSize=20&comingSoon=true'; 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));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/staking/v1/coins?page=1&pageSize=20&comingSoon=true") 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

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/staking/v1/coins?page=1&pageSize=20&comingSoon=true', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/staking/v1/coins?page=1&pageSize=20&comingSoon=true" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "coins": [ { "baseUnit": "wei", "comingSoon": false, "disclaimer": { "nextRewards": { "rewardCycle": 3600 }, "staking": { "info": [ "First staking action requires 2 transactions but subsequent staking only need 1 transaction" ], "minStake": "1000000000000000000", "rewardPercentageRate": "6.15", "rewardsCompounding": false, "transactionsNeeded": 2 }, "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": "TMATIC", "periodHigh": "288000", "periodLow": "288000", "type": "COOLDOWN" }, "transactionsNeeded": 2 } }, "isMultiSig": true, "isToken": true, "isTss": false, "jurisdictions": [], "l1Chain": "hteth", "symbol": "tmatic" }, { "baseUnit": "wei", "isMultiSig": true, "isToken": false, "isTss": true, "jurisdictions": [], "symbol": "gteth" } ], "page": 1, "totalElements": 2, "totalPages": 1 }