Ctrl+K

List staking details by enterprise tokens

get/api/staking/v1/{coin}/enterprises/{enterpriseId}/tokens

Retrieve staking information at the enterprise and token level.

Path Parameters

  • coinstringRequired
    The staking asset.
    Enum: ADA ASI ATOM AVAXC AVAXP BABY BERA BLD BSC BTC COREDAO COREUM CRONOS CSPR DOT EIGEN ETH HASH INJECTIVE MATIC NEAR OSMO POL POLYX RETH-ROCKET SEI SOMI SOL STORY STX SUI SUI:WAL TAO TIA TON TRX WETH WCT WFLR ZETA
  • enterpriseIdstringRequired
    The enterprise ID.

200 Response

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.
staking object
Disclaimer information specific to staking.
unstaking object
Disclaimer information specific to unstaking.
claimRewards object
Disclaimer information for claiming rewards.
nextRewards object
Information about the next rewards cycle.
switchValidator object
Disclaimer information for switching validators.
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.
tokenAddress
string or null
The optional token address.
amount string required
The total amount of the reward pair in base units.
activeAmount string required
The currently active amount in base units.
coin
string or null
The optional coin for this reward pair.

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

409 Response

error string
errorName string
reqId string
context object

500 Response

error string
errorName string
reqId string
context object