Factor Docs
  • 🏭Introduction to Factor
  • Getting Started
    • đŸ•šī¸Quickstart
    • 🔗Supported Protocols
    • 🔐Strategy Cheatsheet
      • Swaps Cheatsheet
        • Conditional Market Order
        • Automated Market Order
        • Multi Swap
        • Automated Swap & Earn
        • Automated Scale Order
        • Scale Order Partial Fill Yield
        • Interest On Pending Trades
        • Leverage Trade
        • Leverage DCA
      • Lending Cheatsheet
        • Lending Pool Zap
        • Multi Lend
        • Market Making To Lending Switch
        • Earn Negative Interest
        • Carry Trade
        • Leveraged Staking Yields
        • Leveraged Fixed Yields
      • Borrowing Cheatsheet
        • Collateralized Borrow
        • Collateralized Borrow Zap
        • Multi Borrow
        • Debt Switching
        • Automated Debt Readjustments
        • Debt Refinancing
        • Asset Switching
      • Liquidity Provision Cheatsheet
        • Liquidity Pool Zap
        • Yield Farm Zap
        • Automated LP Adjustments
        • Yield Farm Adjustments
      • Flash Loan Cheatsheet
    • 🧠Strategy Explainers
      • Leverage
        • Leverage Performance Modelling
        • Leverage Long Simulation
        • Leverage Short Simulation
      • Yield
        • Yield Performance Modelling
      • PT Strategies
        • Leverage Long PT Simulation
      • Delta Neutral Yields
        • Levered USD & ETH Carry
    • 📖Glossary
  • Factor Discover
    • 🔍Factor Discover
      • Public Strategies User Guides
        • Deposit Into User Created Strategies
        • Withdraw From User Created Strategies
      • Leverage User Guides
        • Create A Leveraged Position
        • Adjust Position Leverage
        • Add Collateral To Position
        • Withdraw Collateral From Position
        • Repay Position Debt
      • Yield User Guides
        • Auto-compound Your Yields
      • PT User Guides
        • Redeem Your PT
      • APY Calculations
    • âš™ī¸Factor Operated Strategies
      • Yield Type Strategies
        • Additional rETH Yields On USDC Lend
        • Amplified rETH Yields On USDC Lend
        • Additional Liquid Staked ETH Yields On USDC Lend
        • Additional Liquid Restaked ETH Yields On USDC Lend
      • Trading Type Strategies
        • WBTC Base Switch On rETH For ETH & USDC Yields
      • Delta Neutral Type Strategies
        • Delta Neutral ETH With rETH & USDC Yields
  • Factor Studio
    • 🎨Factor Studio
      • Automated Strategies
      • Conditional Strategies
    • 🏠Private Strategies
      • User Guide
        • Private Strategy Creation
    • đŸ‘ĨPublic Strategies
      • User Guide
        • Public Strategy Creation
        • Create An Exit Strategy
        • Making Your Strategy Public
        • Strategy Execution
      • Security
      • Exit Strategy
    • đŸ—ī¸Strategy Builder
      • Building Blocks User Guide
        • Lend
        • Borrow
        • Swap
        • Flash Loan
    • 📜Studio Contracts
      • Leverage
        • FactorLeverageDescriptor.sol
        • FactorLeverageVault.sol
        • WrapperFactorLeverageVault.sol
      • LP Management
        • FactorLPVault.sol
        • FactorLPDescriptor.sol
  • Factor SDK
    • đŸ“ĻFactor SDK
    • â†”ī¸REST APIs
      • Utility APIs
        • Pricing
        • Stats
  • Factor Building Blocks
    • 🧱Factor Building Blocks
    • âžĄī¸Lend
    • âŦ…ī¸Borrow
    • 🔄Leverage
      • Concepts
        • Collateralized Lending & Borrowing
        • Looping
      • Leverage Dev Guides
        • Create Leveraged Position
        • Add Leverage To Position
      • Strategy Contracts
        • AAVEV3LeverageStrategy.sol
        • CompoundLeverageStrategy.sol
        • LodeStarLeverageStrategy.sol
        • RadiantLeverageStrategy.sol
        • SiloLeverageStrategy.sol
        • SiloYieldTokenStrategy.sol
        • TenderLeverageStrategy.sol
      • FAQ - Leverage Building Block
    • 💰Yield
      • Concepts
        • Yield Farming
        • Yield Aggregators
      • ⚡Zap
    • 🌊LP Management
      • Concepts
        • Automated Market Maker
        • Concentrated Liquidity
    • đŸĨŠStake
    • 🔀Swap
      • Concepts
        • Market Orders
        • DEX Aggregators
    • đŸĒ„Flash Loan
      • Concepts
        • Uncollateralized Lending & Borrowing
        • Flash Loan
  • Factor Adapters
    • 🔌Factor Adapters
    • 📜Adapter Contracts
      • Leverage
      • Yield
      • Swap
      • Flash Loan
  • Governance
    • đŸ›ī¸FactorDAO
      • Factor Flywheel
      • Factor Participants
      • Governance Incentive Calculations
        • FactorDAO Incentives Model (LTIPP)
      • User Guides
        • Stake FCTR
        • Governance Migration
      • Contracts
        • FactorDAO Contract Addresses
      • FactorDAO Multisig Addresses
      • Platform Fees
    • đŸĒ™FCTR Token
      • Staking and Governance
      • Tokenomics
      • Contract Addresses
      • FAQ - Tokenomics
    • âš–ī¸Factor Scale
      • Arbitrum Foundation LTIPP
      • Emission Multiplier Calculations
        • Emissions Multiplier Model
      • User Guides
        • Stake FCTR
        • Vote On Emissions Distribution
      • Contracts
        • Factor Scale Contract Addresses
      • ❔FAQ - Factor Scale
    • 🚀Factor Boost
      • Contracts
        • Factor Boost Contract Addresses
    • đŸ’ŧFactor Bribes
      • Contracts
        • Factor Bribes Contracts
  • Security
    • đŸ›Ąī¸Security
    • 📋Audits
      • PeckShield
        • Leverage Vault Wrapper
        • Silo Yield
        • Silo Leverage
        • Penpie
        • Factor Boost
      • SourceHat
        • FactorDAO Vaults
        • FCTR & Voting Escrow
  • Reference
    • Discover Pro dApp
    • Studio dApp
    • Discover dApp
    • Official Website
    • Press Kit
    • Partnership Form
    • Media Kit
    • Geo Restrictions
  • Community
    • Factor Contributors
    • X
    • Discord
    • Telegram
    • Medium
    • Email Enquiries
Powered by GitBook
On this page

Was this helpful?

  1. Factor SDK
  2. REST APIs
  3. Utility APIs

Stats

PreviousPricingNextFactor Building Blocks

Last updated 10 months ago

Was this helpful?

Liveness Check

Leverage Strategies

/stats/leverage

Yield Strategies

/stats/yield

Protocol Counters

/stats/counters

User Stats

/stats/user/{address}

FactorDAO Revenues

/stats/dao-revenues/current

/stats/dao-revenues/{year}/{month}

â†”ī¸
get
Responses
200Success
get
GET / HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200Success

No content

get

Returns statistics for all leverage strategy vaults.

Responses
200
success
application/json
get
GET /stats/leverage HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200

success

[
  {
    "protocol": "text",
    "market": "text",
    "vaultAddress": "text",
    "totalDepositUsd": "text",
    "totalTvlUsd": "text",
    "netAPY": "text",
    "apyVote": "text",
    "apyVoteProjected": "text",
    "voteWeight": "text",
    "scaleRewardPriceUsd": "text",
    "scaleRewardPerSecond": "text",
    "pairTvl": "text",
    "pairName": "text",
    "isRestaking": true,
    "isStakable": true,
    "stakedVaultAddress": true,
    "strategy": "text",
    "borrowRate": "text",
    "maxLeverage": "text",
    "assetDetails": {
      "priceUsd": "text",
      "symbol": "text",
      "address": "text",
      "supplyApy": "text",
      "borrowApr": "text",
      "additionalSupplyApy": [
        {
          "label": "text",
          "apy": "text"
        }
      ],
      "additionalBorrowApy": [
        {
          "label": "text",
          "apy": "text"
        }
      ],
      "totalSupplyApy": "text",
      "totalBorrowApy": "text",
      "loanToValue": "text",
      "threshold": "text",
      "maxLeverage": "text",
      "minHealthFactor": "text",
      "isAsset": true,
      "isDebt": true,
      "isDisabled": true,
      "ptTokenMetadata": {
        "underlyingTokenSymbol": "text",
        "expiryTimestamp": 1,
        "pendleMarketAddress": "text",
        "isExpired": true,
        "underlyingTokenAddress": "text"
      },
      "market": "text",
      "protocol": "text",
      "vaultAddress": "text"
    },
    "debtDetails": {
      "priceUsd": "text",
      "symbol": "text",
      "address": "text",
      "supplyApy": "text",
      "borrowApr": "text",
      "additionalSupplyApy": [
        {
          "label": "text",
          "apy": "text"
        }
      ],
      "additionalBorrowApy": [
        {
          "label": "text",
          "apy": "text"
        }
      ],
      "totalSupplyApy": "text",
      "totalBorrowApy": "text",
      "loanToValue": "text",
      "threshold": "text",
      "maxLeverage": "text",
      "minHealthFactor": "text",
      "isAsset": true,
      "isDebt": true,
      "isDisabled": true,
      "market": "text",
      "protocol": "text",
      "vaultAddress": "text"
    },
    "openedPositions": [],
    "apyBoost": "text",
    "apyBoostProjected": "text",
    "boostRewardTokens": [
      {
        "vaultAddress": "text",
        "tokenAddress": "text",
        "tokenSymbol": "text",
        "minAmount": "text",
        "minAmountFmt": "text",
        "totalRewardAmount": "text",
        "totalRewardAmountFmt": "text",
        "lastUpdateTime": "text",
        "periodFinish": "text",
        "rewardPerTokenStored": "text",
        "rewardPerTokenStoredFmt": "text",
        "rewardRate": "text",
        "rewardRateFmt": "text",
        "tokenDecimal": "text",
        "priceUsd": "text",
        "apy": "text"
      }
    ],
    "isBoosted": true,
    "isScaled": true,
    "fetched_at": "text",
    "identifier": "text"
  }
]
get

Returns statistics for all yield strategy vaults.

Responses
200
success
application/json
get
GET /stats/yield HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200

success

[
  {
    "vaultAddress": "text",
    "vaultName": "text",
    "vaultSymbol": "text",
    "isStagging": true,
    "isStakable": true,
    "tvlUsd": "text",
    "apyBase": "text",
    "apyVote": "text",
    "apyVoteProjected": "text",
    "isScaled": true,
    "voteWeight": "text",
    "scaleRewardPerSecond": "text",
    "scaleRewardPriceUsd": "text",
    "assetAddress": "text",
    "assetName": "text",
    "assetSymbol": "text",
    "assetDecimals": "text",
    "assetPriceUsd": "text",
    "sharePriceUsd": "text",
    "monthlyVolumeUsd": "text",
    "apyBoost": "text",
    "apyBoostProjected": "text",
    "boostRewardTokens": [
      {
        "vaultAddress": "text",
        "tokenAddress": "text",
        "tokenSymbol": "text",
        "minAmount": "text",
        "minAmountFmt": "text",
        "totalRewardAmount": "text",
        "totalRewardAmountFmt": "text",
        "lastUpdateTime": "text",
        "periodFinish": "text",
        "rewardPerTokenStored": "text",
        "rewardPerTokenStoredFmt": "text",
        "rewardRate": "text",
        "rewardRateFmt": "text",
        "tokenDecimal": "text",
        "priceUsd": "text",
        "apy": "text"
      }
    ],
    "isBoosted": true,
    "isRestaking": true,
    "fetched_at": "text",
    "identifier": "text"
  }
]
get

Returns various counts which includes platform TVL, integrations, and strategies.

Responses
200
success
application/json
get
GET /stats/counters HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200

success

{
  "totalTvl": "text",
  "protocols": "text",
  "pairs": "text",
  "leverageVaults": "text",
  "yieldVaults": "text",
  "totalVaults": "text"
}
get

Returns user strategy data.

Path parameters
addressstringRequired

The user wallet address that is being queried.

Example: 0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7
Responses
200
success
application/json
get
GET /stats/user/{address} HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200

success

{
  "userLeverageVaults": [
    {
      "protocol": "text",
      "market": "text",
      "vaultAddress": "text",
      "totalDepositUsd": "text",
      "totalTvlUsd": "text",
      "netAPY": "text",
      "apyVote": "text",
      "apyVoteProjected": "text",
      "voteWeight": "text",
      "scaleRewardPriceUsd": "text",
      "scaleRewardPerSecond": "text",
      "pairTvl": "text",
      "pairName": "text",
      "isRestaking": true,
      "isStakable": true,
      "stakedVaultAddress": true,
      "strategy": "text",
      "borrowRate": "text",
      "maxLeverage": "text",
      "assetDetails": {
        "priceUsd": "text",
        "symbol": "text",
        "address": "text",
        "supplyApy": "text",
        "borrowApr": "text",
        "additionalSupplyApy": [
          {
            "label": "text",
            "apy": "text"
          }
        ],
        "additionalBorrowApy": [
          {
            "label": "text",
            "apy": "text"
          }
        ],
        "totalSupplyApy": "text",
        "totalBorrowApy": "text",
        "loanToValue": "text",
        "threshold": "text",
        "maxLeverage": "text",
        "minHealthFactor": "text",
        "isAsset": true,
        "isDebt": true,
        "isDisabled": true,
        "ptTokenMetadata": {
          "underlyingTokenSymbol": "text",
          "expiryTimestamp": 1,
          "pendleMarketAddress": "text",
          "isExpired": true,
          "underlyingTokenAddress": "text"
        },
        "market": "text",
        "protocol": "text",
        "vaultAddress": "text"
      },
      "debtDetails": {
        "priceUsd": "text",
        "symbol": "text",
        "address": "text",
        "supplyApy": "text",
        "borrowApr": "text",
        "additionalSupplyApy": [
          {
            "label": "text",
            "apy": "text"
          }
        ],
        "additionalBorrowApy": [
          {
            "label": "text",
            "apy": "text"
          }
        ],
        "totalSupplyApy": "text",
        "totalBorrowApy": "text",
        "loanToValue": "text",
        "threshold": "text",
        "maxLeverage": "text",
        "minHealthFactor": "text",
        "isAsset": true,
        "isDebt": true,
        "isDisabled": true,
        "market": "text",
        "protocol": "text",
        "vaultAddress": "text"
      },
      "openedPositions": [
        {
          "id": "text",
          "address": "text",
          "asset": {
            "address": "text",
            "amount": "text",
            "amountFmt": "text",
            "amountUsd": "text"
          },
          "debt": {
            "address": "text",
            "amount": "text",
            "amountFmt": "text",
            "amountUsd": "text"
          },
          "netValueUsd": "text",
          "tvlUsd": "text"
        }
      ],
      "apyBoost": "text",
      "apyBoostProjected": "text",
      "boostRewardTokens": [
        {
          "vaultAddress": "text",
          "tokenAddress": "text",
          "tokenSymbol": "text",
          "minAmount": "text",
          "minAmountFmt": "text",
          "totalRewardAmount": "text",
          "totalRewardAmountFmt": "text",
          "lastUpdateTime": "text",
          "periodFinish": "text",
          "rewardPerTokenStored": "text",
          "rewardPerTokenStoredFmt": "text",
          "rewardRate": "text",
          "rewardRateFmt": "text",
          "tokenDecimal": "text",
          "priceUsd": "text",
          "apy": "text"
        }
      ],
      "isBoosted": true,
      "isScaled": true,
      "fetched_at": "text",
      "identifier": "text"
    }
  ],
  "userYieldVaults": [
    {
      "vaultAddress": "text",
      "vaultName": "text",
      "vaultSymbol": "text",
      "isStagging": true,
      "isStakable": true,
      "tvlUsd": "text",
      "apyBase": "text",
      "apyVote": "text",
      "apyVoteProjected": "text",
      "isScaled": true,
      "voteWeight": "text",
      "scaleRewardPerSecond": "text",
      "scaleRewardPriceUsd": "text",
      "assetAddress": "text",
      "assetName": "text",
      "assetSymbol": "text",
      "assetDecimals": "text",
      "assetPriceUsd": "text",
      "sharePriceUsd": "text",
      "monthlyVolumeUsd": "text",
      "apyBoost": "text",
      "apyBoostProjected": "text",
      "boostRewardTokens": [
        {
          "vaultAddress": "text",
          "tokenAddress": "text",
          "tokenSymbol": "text",
          "minAmount": "text",
          "minAmountFmt": "text",
          "totalRewardAmount": "text",
          "totalRewardAmountFmt": "text",
          "lastUpdateTime": "text",
          "periodFinish": "text",
          "rewardPerTokenStored": "text",
          "rewardPerTokenStoredFmt": "text",
          "rewardRate": "text",
          "rewardRateFmt": "text",
          "tokenDecimal": "text",
          "priceUsd": "text",
          "apy": "text"
        }
      ],
      "isBoosted": true,
      "isRestaking": true,
      "fetched_at": "text",
      "identifier": "text",
      "userData": {
        "asset": {
          "balance": "text",
          "balanceFmt": "text",
          "balanceUsd": "text"
        },
        "share": {
          "balance": "text",
          "balanceFmt": "text",
          "balanceUsd": "text"
        },
        "pnl": {
          "assetAddress": "text",
          "pnlAsset": "text",
          "pnlAssetFmt": "text",
          "pnlUsd": "text",
          "pnlPercentage": "text"
        }
      },
      "stakedUserData": {
        "asset": {
          "balance": "text",
          "balanceFmt": "text",
          "balanceUsd": "text"
        },
        "share": {
          "balance": "text",
          "balanceFmt": "text",
          "balanceUsd": "text"
        },
        "pnl": {
          "assetAddress": "text",
          "pnlAsset": "text",
          "pnlAssetFmt": "text",
          "pnlUsd": "text",
          "pnlPercentage": "text"
        }
      }
    }
  ]
}
get

Returns the FactorDAO revenues for the current cycle.

Responses
200
success
application/json
get
GET /stats/dao-revenues/current HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200

success

{
  "estimatedAPR": "text",
  "actualAPR": "text",
  "actualDividendUSD": "text",
  "todayIncome": "text",
  "veFCTRSupply": "text",
  "veFCTRTotalUSD": "text",
  "block": "text",
  "factorPrice": "text",
  "lastDistributionUSD": "text",
  "fetchedAt": "text",
  "last30": {
    "averageAPR": "text",
    "totalDividends": "text",
    "dailyAverageDividends": "text"
  },
  "last60": {
    "averageAPR": "text",
    "totalDividends": "text",
    "dailyAverageDividends": "text"
  }
}
get

Returns the FactorDAO revenues for the month queried.

Path parameters
yearstringRequired

The year which is being queried in YYYY format.

Example: 2024
monthstringRequired

The month which is being queried in MM format with no leading zeroes.

Example: 6
Responses
200
success
application/json
get
GET /stats/dao-revenues/{year}/{month} HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*
200

success

[
  {
    "breakdown": {},
    "revenue": "text",
    "factorPrice": "text",
    "block": "text",
    "vetoken_supply": "text",
    "last_distribution": "text",
    "day": "text",
    "month": "text",
    "year": "text",
    "fetched_At": "text"
  }
]
  • Liveness Check
  • GET/
  • Leverage Strategies
  • /stats/leverage
  • GET/stats/leverage
  • Yield Strategies
  • /stats/yield
  • GET/stats/yield
  • Protocol Counters
  • /stats/counters
  • GET/stats/counters
  • User Stats
  • /stats/user/{address}
  • GET/stats/user/{address}
  • FactorDAO Revenues
  • /stats/dao-revenues/current
  • GET/stats/dao-revenues/current
  • /stats/dao-revenues/{year}/{month}
  • GET/stats/dao-revenues/{year}/{month}