Hot Cross Documentation
ApplicationAuditsTwitterUpdates
Search
⌃K
Links
Comment on page

Ecosystem Information

get
https://api.hotcross.com
/tvl
Read total value locked across Hot Cross products

Responses:

  • bridgeTvl - number: total value locked of all bridges.
  • poolTvl - number: total value locked of Cross Pool.
  • yieldTvl - number: total value locked of Cross Yield.
  • total - number: total value locked of all Hot Cross products.
Postman example
get
https://api.hotcross.com/
v2/pools
Getting the list of all V2 pools

Responses:

an array of the RewardPool, each RewardPool object will be structured as below:
  • version - number: API version
  • address - string: the smart contract address of the reward pool
  • name - string: the reward pool name
  • decimals: number: the decimal points of the reward token
  • subtitle: string: the subtitle of the reward pool
  • keywords: array: a list of keywords to search
  • completedAPR:
    • "0": string: the last APR value of the first pool
    • "1": string: the last APR of the second pool
  • description: string: the description of the project
  • image: string: the image URL for the reward token
  • links:
    • website:
      • label - string: the name of the link
      • url - string: the url of the social media account
    • twitter:
      • label - string: the name of the link
      • url - string: the url of the social media account
    • telegram:
      • label - string: the name of the link
      • url - string: the url of the social media account
  • chaindata:
    • rewardPerBlock - [string]: the amount of reward tokens available for reward per block for each reward token
    • startBlock - string: the block that the reward pool starts distributing rewards
    • endBlock - string: the block that the reward pool stops distributing rewards
    • claimDelay - string: the block that the reward pool starts allowing users to claim their rewards
    • unstakeDelayDuration - string: the number of blocks after each stake that the stake tokens are locked
    • totalAllocationPoints - string: the total number of allocation points in the RewardPool
    • rewardVault - string: the address of the contract that keeps the reward tokens.
    • rewardToken - [string]: the reward token addresses
    • farmingPeriod - string: the number of days that the reward pool will be active for
    • totalReward - [string]: the total amount of reward tokens that will be distributed to users
    • stakingPools - array: information about each staking pool
      • stakingToken - string: the smart contract address of the staking token
      • allocationPoints - string: the allocation points assigned to this staking pool
      • pid - number: the monotonic id of the staking pool
      • swapPath - array: swap path for compound pool
      • decimals - string: the decimals of the staking token
      • depositCap - string: the max value user is allowed to deposit in the pool
      • capValidUntilBlock - string: the block after the deposit cap is no longer valid
      • totalStaked - string: the total tokens (in wei) staked into the pool
      • participants - string: the total number of users that have staked tokens into the pool
      • apr - number: the annual percentage rate
    • compoundEnabled - boolean: a flag that indicates with the pools support compounding rewards
    • latestUnstakeDelayBlock - string: the block after the unstake delay is no longer valid
    • fees:
      • feeManager - string: the address of the contract that keeps the fees.
      • protocolFee - number: the number of protocol fee
      • withdrawPenaltyFee - number: the number of withdraw penalty fee
      • withdrawPenaltyBlock - number: the block that the penalty withdraw fee will be applied
    • minimumAllocationPoint - number:
    • timeLock - string: the block that user is allowed to unstake
  • startBlockDuration - number: the duration until the startBlock is reached
  • endBlockDuration - number: the duration until the endBlock is reached
  • timeLockDuration - number:
Postman example
get
https://api.hotcross.com/
bridges
Getting the list of all bridges
Responses:
an array of the bridge model
  • ticker - string: the token ticker
  • symbol - string: the token symbol
  • name - string: the token name
  • ethBridgeAddress - string: the bridge contract address on Ethereum
  • bscBridgeAddress - string: the bridge contract address on BNB smart chain
  • erc20 - string: the token address on Ethereum
  • bep20 - string: the token address on BNB smart chain
  • decimals - number: the token decimals
Postman example
Products - Previous
Cross API
Next
Supply Information for $HOTCROSS
Last modified 1yr ago