Staking Overview

​

Introduction

​

How Staking Works

1. Browse Available Products - Query available staking types to see supported cryptocurrencies, APY rates, and terms
2. Create Stake - Lock your cryptocurrency into a staking position
3. Earn Yield - Your position accumulates yield over time based on the APY
4. Redeem Position - Unlock your staked amount plus accumulated yield

​

Staking Modes

​

Variable Staking

• Flexible duration with no fixed lock-up period
• Variable APY that may change over time
• Can be redeemed at any time (check redeemableAt field)
• Ideal for users who want liquidity flexibility

​

Fixed Staking

• Fixed duration specified in days (durationDays)
• Fixed APY guaranteed for the entire duration
• Can only be redeemed after the lock-up period ends
• Higher APY rates in exchange for commitment

​

Key Concepts

​

Staking Types

• currencyId - The cryptocurrency that can be staked (e.g., BTC, ETH, USDT)
• mode - Either VARIABLE or FIXED
• apy - Annual Percentage Yield as a decimal string
• minAmount - Minimum amount required to stake
• durationDays - Lock-up period in days (only for FIXED mode)

​

Staking Operations

• Operation ID and timestamps (openedAt, updatedAt, closedAt)
• Status (Active or Redeemed)
• Owner and creator information

​

Yield Calculation

• yield - Current accumulated yield
• estRedeemYield - Estimated yield at redemption time
• initialAPY - APY at time of stake creation
• apy - Current APY (may differ for variable products)

​

API Endpoints

​

Typical Workflow

// 1. Fetch available staking types
const stakingTypes = await fetch(EP_STAKING_TYPE);
const btcStaking = stakingTypes.find(t => t.currencyId === 'BTC' && t.mode === 'FIXED');

// 2. Create a stake
await fetch(EP_STAKING, {
  method: 'POST',
  body: JSON.stringify({
    typeId: btcStaking.id,
    amount: '0.5' // 0.5 BTC
  })
});

// 3. Monitor active positions
const activeStakes = await fetch(`${EP_STAKING_ACTIVE}?page=0&size=10`);

// 4. Redeem when ready
const opId = activeStakes.data[0].operation.id;
await fetch(EP_STAKING_REDEEM.replace('%OPID', opId), {
  method: 'POST'
});

​

Response Format

{
  data: T,        // Response data (array or object)
  status: number  // HTTP status code
}

​

Error Handling

• Insufficient balance for the staking amount
• Amount below minAmount threshold
• Attempting to redeem before redeemableAt date
• Invalid typeId or opId

​

Next Steps