Stats

Liveness Check

get

Responses

200Success

No content

get

/

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: factor-stats-api.fly.dev
Accept: */*

200Success

No content

Leverage Strategies

/stats/leverage

get

Returns statistics for all leverage strategy vaults.

Responses

200

success

application/json

protocolstringOptional

The lending protocol used for the leverage strategy.

marketstringOptional

The lending protocol market that is utilized for the leverage strategy.

vaultAddressstringOptional

The address of the strategy vault.

totalDepositUsdstringOptional

The USD value of deposits in the strategy vault.

totalTvlUsdstringOptional

The TVL of the strategy vault denominated in USD.

netAPYstringOptional

The net estimated percentage returns for the strategy.

apyVotestringOptional

The APY from Factor Scale incentives allocated to this vault based on current vault deposits.

apyVoteProjectedstringOptional

The estimated APY from Factor Scale incentives allocated to this vault.

voteWeightstringOptional

The Factor Scale weight modifier applied to each vote fot this strategy.

scaleRewardPriceUsdstringOptional

The USD value of the incentive token distributed via Factor Scale.

scaleRewardPerSecondstringOptional

The USD value per second of Factor Scale incentives which is being distributed to depositors in this strategy.

pairTvlstringOptional

The USD value of the tokens that are deposited in the strategy.

pairNamestringOptional

The strategy name which includes the token pair.

isRestakingbooleanOptional

Indicates if the strategy is a restaking strategy.

isStakablebooleanOptional

Indicates if the strategy can be staked to be eligible for FactorDAO rewards.

stakedVaultAddressbooleanOptional

The address of the staked vault. Factor implements a governance wrapper that enables the strategy to receive FactorDAO incentives.

strategystringOptional

The strategy type.

borrowRatestringOptional

The interest rate that is charged for borrowing the debt token.

maxLeveragestringOptional

The maximum amount of leverage allowable for the strategy. This is determined by the underlying lending pool.

openedPositionsarrayOptional

Array of positions which have been opened for this strategy.

apyBooststringOptional

The APY of incentives allocated to this strategy via Factor Boost based on current deposits.

apyBoostProjectedstringOptional

The estimated APY of Factor Boost incentives allocated to this strategy.

isBoostedbooleanOptional

Indicates if the strategy is receiving Factor Boost incentives.

isScaledbooleanOptional

Indicates if the strategy is receiving Factor Scale incentives.

fetched_atstringOptional

The UNIX timestamp at which the data for this strategy was retrieved.

identifierstringOptional

The identifier to uniquely identify the strategy.

get

/stats/leverage

HTTPcURLJavaScriptPython

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"
  }
]

Yield Strategies

/stats/yield

get

Returns statistics for all yield strategy vaults.

Responses

200

success

application/json

An array of objects, each representing a yield strategy vault.

vaultAddressstringOptional

The address of the strategy vault.

vaultNamestringOptional

The strategy name which includes the underlying token as well as the lending protocol.

vaultSymbolstringOptional

The symbol of the yield vault which is a concatenation of protocol, token, and auto-compounder strategy type.

isStaggingbooleanOptional

Indicates if the strategy is in the staging environment.

isStakablebooleanOptional

Indicates if the strategy can be staked to be eligible for FactorDAO rewards.

tvlUsdstringOptional

The TVL of the strategy vault denominated in USD.

apyBasestringOptional

The base Annual Percentage Yield that is accrued by the strategy.

apyVotestringOptional

The APY from Factor Scale incentives allocated to this vault based on current vault deposits.

apyVoteProjectedstringOptional

The estimated APY from Factor Scale incentives allocated to this vault.

isScaledbooleanOptional

Indicates if the strategy is receiving Factor Scale incentives.

voteWeightstringOptional

The Factor Scale weight modifier applied to each vote fot this strategy.

scaleRewardPerSecondstringOptional

The USD value per second of Factor Scale incentives which is being distributed to depositors in this strategy.

scaleRewardPriceUsdstringOptional

The USD value of the incentive token distributed via Factor Scale.

assetAddressstringOptional

The contract address of the underlying token (i.e. asset) of the yield strategy vault.

assetNamestringOptional

The name of the underlying token (i.e. asset) of the yield strategy vault.

assetSymbolstringOptional

The symbol of the underlying token (i.e. asset) of the yield strategy vault.

assetDecimalsstringOptional

The number of decimals of the underlying token (i.e. asset) of the yield strategy vault.

assetPriceUsdstringOptional

The USD value of the underlying token (i.e. asset) of the yield strategy vault.

sharePriceUsdstringOptional

The USD value of each of the yield strategy vault's share.

monthlyVolumeUsdstringOptional

The USD value of the volume of tokens that is facilitated by this yield strategy.

apyBooststringOptional

The APY of incentives allocated to this strategy via Factor Boost based on current deposits.

apyBoostProjectedstringOptional

The estimated APY of Factor Boost incentives allocated to this strategy.

isBoostedbooleanOptional

Indicates if the strategy is receiving Factor Boost incentives.

isRestakingbooleanOptional

Indicates if the strategy is a restaking strategy.

fetched_atstringOptional

The UNIX timestamp at which the data for this strategy was retrieved.

identifierstringOptional

The identifier to uniquely identify the strategy.

get

/stats/yield

HTTPcURLJavaScriptPython

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"
  }
]

Protocol Counters

/stats/counters

get

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

Responses

200

success

application/json

totalTvlstringOptional

The TVL of all deposits on Factor vaults denominated in USD.

protocolsstringOptional

The number of integrated protocols.

pairsstringOptional

The number of token pairs/markets which are available on Factor.

leverageVaultsstringOptional

The number of leverage strategy vaults.

yieldVaultsstringOptional

The number of yield strategy vaults.

totalVaultsstringOptional

The total number of strategy vaults on Factor.

get

/stats/counters

HTTPcURLJavaScriptPython

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"
}

User Stats

/stats/user/{address}

get

Returns user strategy data.

Path parameters

addressstringRequired

The user wallet address that is being queried.

Example: 0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7

Responses

200

success

application/json

get

/stats/user/{address}

HTTPcURLJavaScriptPython

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"
        }
      }
    }
  ]
}

FactorDAO Revenues

/stats/dao-revenues/current

get

Returns the FactorDAO revenues for the current cycle.

Responses

200

success

application/json

estimatedAPRstringOptional

The estimated APR that a FCTR staker can expect to receive at the next revenue share distribution.

actualAPRstringOptional

The actual APR that a FCTR staker will receive on revenue share distribution based on FactorDAO's month-to-date revenue.

actualDividendUSDstringOptional

The month-to-date revenue share accrued by FactorDAO that will distributed at the next cycle.

todayIncomestringOptional

The income generated by the FactorDAO for today, denominated in USD.

veFCTRSupplystringOptional

The total supply of veFCTR tokens (i.e. staked FCTR tokens adjusted for stake duration).

veFCTRTotalUSDstringOptional

The USD value of all veFCTR tokens.

blockstringOptional

The current block count (i.e. block height).

factorPricestringOptional

The USD price of the FCTR token.

lastDistributionUSDstringOptional

The USD value of all revenue share amounts that were distributed in the last cycle.

fetchedAtstringOptional

The UNIX timestamp at which the FactorDAO revenues were retrieved.

get

/stats/dao-revenues/current

HTTPcURLJavaScriptPython

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"
  }
}

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

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

An array of FactorDAO daily revenues for the month queried.

breakdownobjectOptional

revenuestringOptional

The USD value of FactorDAO revenue accrued for the day.

factorPricestringOptional

The USD price of the FCTR token.

blockstringOptional

The current block count (i.e. block height).

vetoken_supplystringOptional

The total supply of veFCTR tokens (i.e. staked FCTR tokens adjusted for stake duration).

last_distributionstringOptional

The amount of USDC tokens (in wei) distributed in the last cycle.

daystringOptional

The day of the month.

monthstringOptional

The month of the year.

yearstringOptional

The year that is queried.

fetched_AtstringOptional

The UNIX timestamp at which the FactorDAO revenues were retrieved.

get

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

HTTPcURLJavaScriptPython

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"
  }
]