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
{
"bridgeTvl": 41920013.3568667,
"poolTvl": 12956208.992478373,
"yieldTvl": 5378040.4249534095,
"total": 60254262.77429848
}
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
[
{
"version": 2,
"address": "0x15AEF019093b924C716846C8d3Bc8BCF1d019317",
"name": "HOTDOG+HOTCROSS",
"decimals": 18,
"priority": 2000,
"keywords": [
"hotcross",
"hotdog"
],
"completedAPR": {
"0": "0",
"1": "0"
},
"subtitle": "Hot Cross is an extensive multi-chain and cross-chain tool suite.",
"description": "Hot Cross is an extensive multi-chain and cross-chain tool suite that enables blockchain teams and their communities to thrive. At its core, Hot Cross aims to be the best toolbox for ETH and EVM networks.",
"images": [
"https://hotcross-public.s3.ap-southeast-1.amazonaws.com/images/hot-dog.png",
"https://media.githubusercontent.com/media/hotcrosscom/brand/main/token/200w/token.png"
],
"links": {
"website": {
"label": "Website",
"url": "http://www.hotcross.com/"
},
"twitter": {
"label": "Twitter",
"url": "https://twitter.com/hotcrosscom"
},
"telegram": {
"label": "Telegram",
"url": "https://t.me/HotCross"
},
"pancakeSwap": {
"label": "PancakeSwap",
"url": "https://pancakeswap.finance/swap?outputCurrency=0x4fa7163e153419e0e1064e418dd7a99314ed27b6"
}
},
"chaindata": {
"startBlock": "16135015",
"endBlock": "16538214",
"claimDelay": "16137895",
"unstakeDelayDuration": "201600",
"totalAllocationPoints": "1000",
"farmingPeriod": 14,
"rewardTokens": [
"0xd6aB096eCE76789620A6aCdC34f8dADD04627DC5",
"0x4FA7163E153419E0E1064e418dd7A99314Ed27b6"
],
"rewardDecimals": [
"18",
"18"
],
"rewardsPerBlock": [
"892859357290072644",
"347223083390583806"
],
"totalReward": [
"359999999999999999988156",
"139999999999999999995394"
],
"rewardProcessor": "0x2c14fb0a90e2C27f4104a493A29B8b1638C7997F",
"rewardVault": "0x6Ff9718c035821E0FDF67cfEAf15A23Ed7bA94Be",
"stakingPools": [
{
"stakingToken": "0xd6aB096eCE76789620A6aCdC34f8dADD04627DC5",
"allocationPoints": 750,
"pid": 0,
"swapPath": [],
"decimals": "18",
"depositCap": "100000000000000000000000",
"capValidUntilBlock": "16192615",
"totalStaked": "4410340867165522000000000",
"participants": "733",
"apr": 245.38834891096485
},
{
"stakingToken": "0x4FA7163E153419E0E1064e418dd7A99314Ed27b6",
"allocationPoints": 250,
"pid": 1,
"swapPath": [],
"decimals": "18",
"depositCap": "100000000000000000000000",
"capValidUntilBlock": "16192615",
"totalStaked": "8318431146344565000000000",
"participants": "609",
"apr": 47.32864094903803
}
],
"compoundEnabled": false,
"latestUnstakeDelayBlock": "16480614",
"fees": {
"feeManager": "0x99Dd53DCb232BB5BF507eBF728b6E1b168B0556F",
"protocolFee": 2,
"withdrawPenaltyFee": 500,
"withdrawPenaltyBlock": 16423015
},
"currentBlock": 16298136,
"minimumAllocationPoint": 250,
"timeLock": "16137895"
},
"startBlockDuration": 489363000,
"endBlockDuration": 720234000,
"timeLockDuration": 0
}
]
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
[
{
"stakingToken": "string",
"allocationPoints": "string",
"pid": 0,
"totalStaked": "string",
"stakeTokenDecimals": 0,
"apr": 0,
"participants": "string"
}
]
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