Stats

Liveness Check

GEThttps://factor-stats-api.fly.dev/

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Leverage Strategies

/stats/leverage

Returns statistics for all leverage strategy vaults.

GEThttps://factor-stats-api.fly.dev/stats/leverage

Response

200

success

Body

application/json

protocolstring

The lending protocol used for the leverage strategy.

marketstring

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

vaultAddressstring

The address of the strategy vault.

totalDepositUsdstring

The USD value of deposits in the strategy vault.

totalTvlUsdstring

The TVL of the strategy vault denominated in USD.

netAPYstring

The net estimated percentage returns for the strategy.

apyVotestring

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

apyVoteProjectedstring

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

voteWeightstring

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

scaleRewardPriceUsdstring

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

scaleRewardPerSecondstring

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

pairTvlstring

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

pairNamestring

The strategy name which includes the token pair.

isRestakingboolean

Indicates if the strategy is a restaking strategy.

isStakableboolean

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

stakedVaultAddressboolean

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

strategystring

The strategy type.

borrowRatestring

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

maxLeveragestring

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

assetDetailsobject

Asset token details

debtDetailsobject

Debt token details

openedPositionsarray

Array of positions which have been opened for this strategy.

apyBooststring

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

apyBoostProjectedstring

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

boostRewardTokensarray of object

isBoostedboolean

Indicates if the strategy is receiving Factor Boost incentives.

isScaledboolean

Indicates if the strategy is receiving Factor Scale incentives.

fetched_atstring

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

identifierstring

The identifier to uniquely identify the strategy.

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/stats/leverage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "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": false,
    "isStakable": false,
    "stakedVaultAddress": false,
    "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": false,
      "isDebt": false,
      "isDisabled": false,
      "ptTokenMetadata": {
        "underlyingTokenSymbol": "text",
        "expiryTimestamp": 0,
        "pendleMarketAddress": "text",
        "isExpired": false,
        "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": false,
      "isDebt": false,
      "isDisabled": false,
      "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": false,
    "isScaled": false,
    "fetched_at": "text",
    "identifier": "text"
  }
]

Yield Strategies

/stats/yield

Returns statistics for all yield strategy vaults.

GEThttps://factor-stats-api.fly.dev/stats/yield

Response

200

success

Body

application/json

vaultAddressstring

The address of the strategy vault.

vaultNamestring

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

vaultSymbolstring

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

isStaggingboolean

Indicates if the strategy is in the staging environment.

isStakableboolean

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

tvlUsdstring

The TVL of the strategy vault denominated in USD.

apyBasestring

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

apyVotestring

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

apyVoteProjectedstring

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

isScaledboolean

Indicates if the strategy is receiving Factor Scale incentives.

voteWeightstring

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

scaleRewardPerSecondstring

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

scaleRewardPriceUsdstring

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

assetAddressstring

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

assetNamestring

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

assetSymbolstring

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

assetDecimalsstring

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

assetPriceUsdstring

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

sharePriceUsdstring

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

monthlyVolumeUsdstring

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

apyBooststring

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

apyBoostProjectedstring

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

boostRewardTokensarray of object

isBoostedboolean

Indicates if the strategy is receiving Factor Boost incentives.

isRestakingboolean

Indicates if the strategy is a restaking strategy.

fetched_atstring

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

identifierstring

The identifier to uniquely identify the strategy.

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/stats/yield', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "vaultAddress": "text",
    "vaultName": "text",
    "vaultSymbol": "text",
    "isStagging": false,
    "isStakable": false,
    "tvlUsd": "text",
    "apyBase": "text",
    "apyVote": "text",
    "apyVoteProjected": "text",
    "isScaled": false,
    "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": false,
    "isRestaking": false,
    "fetched_at": "text",
    "identifier": "text"
  }
]

Protocol Counters

/stats/counters

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

GEThttps://factor-stats-api.fly.dev/stats/counters

Response

200

success

Body

application/json

totalTvlstring

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

protocolsstring

The number of integrated protocols.

pairsstring

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

leverageVaultsstring

The number of leverage strategy vaults.

yieldVaultsstring

The number of yield strategy vaults.

totalVaultsstring

The total number of strategy vaults on Factor.

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/stats/counters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

User Stats

/stats/user/{address}

Returns user strategy data.

GEThttps://factor-stats-api.fly.dev/stats/user/{address}

Path parameters

address*string

The user wallet address that is being queried.

Example: "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7"

Response

200

success

Body

application/json

userLeverageVaultsarray of object

userYieldVaultsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/stats/user/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false,
      "isStakable": false,
      "stakedVaultAddress": false,
      "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": false,
        "isDebt": false,
        "isDisabled": false,
        "ptTokenMetadata": {
          "underlyingTokenSymbol": "text",
          "expiryTimestamp": 0,
          "pendleMarketAddress": "text",
          "isExpired": false,
          "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": false,
        "isDebt": false,
        "isDisabled": false,
        "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": false,
      "isScaled": false,
      "fetched_at": "text",
      "identifier": "text"
    }
  ],
  "userYieldVaults": [
    {
      "vaultAddress": "text",
      "vaultName": "text",
      "vaultSymbol": "text",
      "isStagging": false,
      "isStakable": false,
      "tvlUsd": "text",
      "apyBase": "text",
      "apyVote": "text",
      "apyVoteProjected": "text",
      "isScaled": false,
      "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": false,
      "isRestaking": false,
      "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

Returns the FactorDAO revenues for the current cycle.

GEThttps://factor-stats-api.fly.dev/stats/dao-revenues/current

Response

200

success

Body

application/json

estimatedAPRstring

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

actualAPRstring

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

actualDividendUSDstring

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

todayIncomestring

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

veFCTRSupplystring

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

veFCTRTotalUSDstring

The USD value of all veFCTR tokens.

blockstring

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

factorPricestring

The USD price of the FCTR token.

lastDistributionUSDstring

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

fetchedAtstring

The UNIX timestamp at which the FactorDAO revenues were retrieved.

last30object

DAO revenue figures for the last 30 days.

last60object

DAO revenue figures for the last 30 days.

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/stats/dao-revenues/current', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Returns the FactorDAO revenues for the month queried.

GEThttps://factor-stats-api.fly.dev/stats/dao-revenues/{year}/{month}

Path parameters

year*string

The year which is being queried in YYYY format.

Example: "2024"

month*string

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

Example: "6"

Response

200

success

Body

application/json

breakdownobject

revenuestring

The USD value of FactorDAO revenue accrued for the day.

factorPricestring

The USD price of the FCTR token.

blockstring

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

vetoken_supplystring

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

last_distributionstring

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

daystring

The day of the month.

monthstring

The month of the year.

yearstring

The year that is queried.

fetched_Atstring

The UNIX timestamp at which the FactorDAO revenues were retrieved.

Request

JavaScriptCurlPython

const response = await fetch('https://factor-stats-api.fly.dev/stats/dao-revenues/{year}/{month}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "breakdown": {},
    "revenue": "text",
    "factorPrice": "text",
    "block": "text",
    "vetoken_supply": "text",
    "last_distribution": "text",
    "day": "text",
    "month": "text",
    "year": "text",
    "fetched_At": "text"
  }
]