Ecosystem Information
Read total value locked across Hot Cross products
GET
https://api.hotcross.com/tvl
Query Parameters
platform*
String
Available values : all, cross-bridge, cross-pool
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

Getting the list of all V2 pools
GET
https://api.hotcross.com/v2/pools
Query Parameters
chain*
String
The chain id of the blockchain you want to read the pools from
Ethereum: 1
BNB Smart Chain: 56
Avalanche C-Chain: 43114
Responses:
an array of the RewardPool, each RewardPool object will be structured as below:
version - number:
API versionaddress - string:
the smart contract address of the reward poolname - string:
the reward pool namedecimals: number:
the decimal points of the reward tokensubtitle: string:
the subtitle of the reward poolkeywords: array:
a list of keywords to searchcompletedAPR:
"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 projectimage: string:
the image URL for the reward tokenlinks:
website:
label - string:
the name of the linkurl - string:
the url of the social media account
twitter:
label - string
: the name of the linkurl - string:
the url of the social media account
telegram:
label - string:
the name of the linkurl - string:
the url of the social media account
chaindata:
rewardPerBlock - [string]:
the amount of reward tokens available for reward per block for each reward tokenstartBlock - string:
the block that the reward pool starts distributing rewardsendBlock - string:
the block that the reward pool stops distributing rewardsclaimDelay - string:
the block that the reward pool starts allowing users to claim their rewardsunstakeDelayDuration - string:
the number of blocks after each stake that the stake tokens are lockedtotalAllocationPoints - string:
the total number of allocation points in the RewardPoolrewardVault - string:
the address of the contract that keeps the reward tokens.rewardToken - [string]:
the reward token addressesfarmingPeriod - string:
the number of days that the reward pool will be active fortotalReward - [string]:
the total amount of reward tokens that will be distributed to usersstakingPools - array:
information about each staking poolstakingToken - string:
the smart contract address of the staking tokenallocationPoints - string:
the allocation points assigned to this staking poolpid - number:
the monotonic id of the staking poolswapPath - array:
swap path for compound pooldecimals - string:
the decimals of the staking tokendepositCap - string:
the max value user is allowed to deposit in the poolcapValidUntilBlock - string:
the block after the deposit cap is no longer validtotalStaked - string:
the total tokens (in wei) staked into the poolparticipants - string:
the total number of users that have staked tokens into the poolapr - number:
the annual percentage rate
compoundEnabled - boolean:
a flag that indicates with the pools support compounding rewardslatestUnstakeDelayBlock - string:
the block after the unstake delay is no longer validfees:
feeManager - string:
the address of the contract that keeps the fees.protocolFee - number:
the number of protocol feewithdrawPenaltyFee - number:
the number of withdraw penalty feewithdrawPenaltyBlock - 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 reachedendBlockDuration - number
: the duration until the endBlock is reachedtimeLockDuration - number:
Postman example

Getting the list of all bridges
GET
https://api.hotcross.com/bridges
Responses:
an array of the bridge model
ticker - string:
the token tickersymbol - string:
the token symbolname - string:
the token nameethBridgeAddress - string:
the bridge contract address on EthereumbscBridgeAddress - string:
the bridge contract address on BNB smart chainerc20 - string:
the token address on Ethereumbep20 - string:
the token address on BNB smart chaindecimals - number:
the token decimals
Postman example

Last updated