LogoLogo
Dev docs
  • Docs
  • Dev docs
Dev docs
  • Welcome
  • Guides
    • Integrate WOOFi as a liquidity source on EVM
    • Integrate WOOFi as a liquidity source on Solana
      • Rust SDK
      • TypeScript SDK
      • Architecture
    • Become a WOOFi broker
  • Resources
    • Product Docs
    • The math behind sPMM
    • Smart contract architecture
    • On-chain price feeds
  • References
    • Contract Addresses
      • Solana
      • Arbitrum one
      • Avalanche c-chain
      • Base
      • BNB smart chain
      • Ethereum
      • Linea
      • Mantle
      • OP mainnet
      • Polygon PoS
      • zkSync Era
      • Sonic
    • Data APIs
      • Swap
      • Earn & Stake
    • Audits and bounties
    • GitHub
  • Deprecated docs
    • [v1] sPMM liquidity integration
    • [v1] On-chain price feeds
    • Legacy contracts
Powered by GitBook
On this page
  • General Info
  • Staking
  • Earn

Was this helpful?

Edit on GitHub
  1. References
  2. Data APIs

Earn & Stake

PreviousSwapNextAudits and bounties

Last updated 5 months ago

Was this helpful?

General Info

  • The base endpoint is:

  • All endpoints return JSON object.

Staking

GET /stakingv2

Returns

Name
Type
Description

avg_apr

float

Average APR of all stakers

base_apr

float

Base apr based on the user's staked WOO only

Earn

GET /yield

Params

Name
Type
Description

network

String

option: bsc / avax / polygon/ arbitrum / optimism / zksync / base / mantle

Returns

Name
Type
Description

total_deposit

String

total deposited(value multiplied by10^<decimals>)(unit:USD)

auto_compounding

Object

auto-compoundedyield aggregator

Auto-Compounding Returns

Name
Type
Description

<Vault Address>

Object

deposited token's vault_address

Auto-Compounding Symbol Returns

Name
Type
Description

symbol

String

target tokensymbol

source

String

target farm(lowercase)

apy

Decimal

auto-compounded APR(unit: %)

tvl

String

total deposit of single pool(value multiplied by10^<decimals>)(unit:USD)

price

Decimal

USD price of symbol

share_price

String

net asset value per share

decimals

Integer

symbol decimals, for tvl calculation

https://fi-api.woo.org