sFOX API
Sign InOpen Account
sFOX API
sFOX API
  • Introduction
    • Welcome
    • Getting Started
    • Systems & Operations
    • Rate Limits
  • REST API
    • REST Endpoints
    • Authentication
    • Rate Limits
    • Account Management
      • Get All Balances
      • Get All Currencies
      • Get All Currency Pairs
      • Get All Transactions
      • Get Fees
    • Orders
      • Order Types
      • Create Order
      • Cancel Order
      • Cancel Multiple Orders
      • Cancel All Orders
      • Amend Order
      • Get Single Order
      • Get All Open Orders
      • Get All Done Orders
      • Get All Trades
    • Request for Quote (RFQ)
    • Post-Trade Settlement (PTS)
      • Get Account Risk Metrics
      • Get All Positions
      • Get All Funding Transactions
      • Get All Funding Rates
      • Get All Risk Modes
      • Create Transfer
    • Shorting
      • Get Account Risk Metrics
      • Get All Positions
    • Transfers
      • Get All Deposit Addresses
      • Get Single Deposit Address
      • Create Deposit Address
      • Deposit From Bank Account
      • Withdraw From Account
      • Get Single Withdrawal Fee
      • Create Transfer
    • Custody (sFOX SAFE)
      • Get Whitelisted Addresses
      • Add Whitelisted Address
      • Delete Whitelisted Address
      • Get Approval Rules
      • Create Approval Rule
      • Edit Approval Rule
      • Get Approval Requests
      • Respond to Approval Request
    • Staking
      • Get Staking Currencies
      • Get All Staking Transactions
      • Create Stake
      • Cancel Stake
      • Unstake
    • Market Data
      • Get Candlesticks
      • Get Volume Analytics
      • Get Order Estimate
      • Get Order Book
    • Reporting
      • Get Orders Report
      • Get Monthly Summary
      • Get Portfolio Valuation
      • Get All Transactions
  • WebSocket API
    • Introduction
    • Connecting
    • Rate Limits
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • Market Data
      • Order Book
      • Trades
      • Ticker
    • Orders & Account Data
      • Orders
      • Trades
      • Balances
      • Post-Trade Settlement
  • FIX API
    • FIX Order Entry
    • FIX Market Data
    • QuickFIX Guide
  • Errors
    • Error Codes
Powered by GitBook
  1. REST API
  2. Staking

Get Staking Currencies

GET https://api.sfox.com/v1/staking/currencies

Retrieve a list staking-enabled assets along with the staking terms for that asset including the minimum amount, staking period, bonding, and unbonding period.

Response Body

Key
Description

currency

The digital asset that may be staked

min_stake_amount

The minimum amount of this asset that may be staked in a given request

min_stake_period_minutes

The default period, in minutes, that the asset will be staking

stake_bonding_period_minutes

The amount of time, in minutes, after a staking request has been processed until the stake will begin accruing rewards

stake_unbonding_period_minutes

The amount of time, in minutes, that a completed stake of this asset will remain unavailable and not accruing rewards

Responses

200
{
    "data": [
        {
            "currency": "avax",
            "min_stake_amount": "25",
            "min_stake_period_minutes": 20160,
            "stake_bonding_period_minutes": 0,
            "stake_unbonding_period_minutes": 0
        }
    ]
}

Example Requests

curl -H 'Authorization: Bearer <API_TOKEN>' 
'https://api.sfox.com/v1/staking/currencies'
const axios = require('axios');

axios({
  method: 'get',
  url: 'https://api.sfox.com/v1/staking/currencies',
  headers: {
    'Authorization': 'Bearer <API_KEY>'
  }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});
import requests

data = requests.get(
  "https://api.sfox.com/v1/staking/currencies",
  headers={
    "Authorization": "Bearer <API_KEY>",
  }
)
print(data)
PreviousStakingNextGet All Staking Transactions

Last updated 1 year ago