Ctrl+K

Get list of stake-able coins

get/api/staking/v1/enterprises/{enterpriseId}/coins

Returns a paginated list of stake-able coins for the given enterprise with basic attributes.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise ID.

Query Parameters

  • pageintegerDefault: 1
    The page number for pagination.
    Minimum: >= 1
  • pageSizeintegerDefault: 20
    The page size for pagination.
    Minimum: >= 1
    Maximum: <= 100
  • stakedboolean
    Filter by whether the coin is currently staked.

200 Response

enterpriseStakingInfo array[object]
A paginated list of staking information for the enterprise, grouped by coin.
enterpriseId string
The ID of the enterprise where the staking request was created from.
coin string
The staking asset.
delegated string
The delegated staked amount in base units.
rewards string
The reward accrual amount in base units.
apy string
Reward accrual annual percentage rate. Estimated yearly based on the last 7 days. Same methodology as leading beacon chain validator aggregators (e.g. https://beaconcha.in/validators).
pendingStake string
The pending stake amount in base units.
pendingUnstake string
The pending unstake amount in base units.
pendingClaimRewards string
The pending claimable rewards in base units.
baseUnit string
The coin base unit (e.g., wei for ETH).
isToken boolean
True if the staking asset is a token.
isTss boolean
True if the staking wallet uses threshold signatures (TSS).
isMultiSig boolean
True if the staking wallet uses multisig.
l1Chain
string or null
The underlying L1 chain if the staking asset is on a different chain (e.g., ETH for L2 assets).
comingSoon boolean
True if the staking feature for this asset is marked as coming soon.
disclaimer object
Spendable disclaimer attributes for a staking wallet.
walletCount integer
The number of wallets with delegations in this enterprise for the given coin.
rewardCoin
string or null
The coin used for rewards (if different from the staked asset).
rewardPairs array[object]
Reward pairs associated with the staking asset.
page integer
The page number for paging purposes.
totalPages integer
The total number of pages for paging purposes.
totalElements integer
The number of elements per page used for paging purposes.

400 Response

error string
errorName string
reqId string
context object

401 Response

error string
errorName string
reqId string
context object

403 Response

error string
errorName string
reqId string
context object

404 Response

error string
errorName string
reqId string
context object

500 Response

error string
errorName string
reqId string
context object