Interact with Cross Pool
Create Stake Tx
POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/tx/stake
Path Parameters
poolAddress*
String
The smart contract address of the reward pool
pid*
number
The monotonic id of the staking pool
Request Body
user*
String
The user account ($EVM Address)
amount*
String
The amount the user wants to stake (in wei)
chainId*
number
The chain id of the blockchain
{
"data": "0xe2bbb15800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000064",
"gas": 144924
} // Response
{
// Response
}Returns
data - string:The call data of the transaction can be empty for simple value transfersgas - number:The gas provided by the transaction
Postman example
Create Unstake Tx
POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/tx/unstake
Path Parameters
poolAddress*
String
The smart contract address of the reward pool
pid*
number
The monotonic id of the staking pool
Request Body
user*
String
The user account ($EVM Address)
amount*
String
The amount the user wants to stake (in wei)
chainId*
String
The chain id of the blockchain
Returns
data - string:The call data of the transaction can be empty for simple value transfersgas - number:The gas provided by the transaction
Postman example
Create Claim Tx
POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/tx/claim
Path Parameters
poolAddress*
String
The smart contract address of the reward pool
pid*
number
The monotonic id of the staking pool
Request Body
user*
String
The user account ($EVM Address)
chainId*
number
The chain id of the blockchain
Returns
data - string:The call data of the transaction can be empty for simple value transfersgas - number:The gas provided by the transaction
Postman example
Read user staked amount from the blockchain
POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/call/user-staked
Path Parameters
poolAddress*
String
The smart contract address of the reward pool
pid*
number
The monotonic id of the staking pool
Request Body
user*
String
The user account ($EVM Address)
chainId*
numer
The chain id of the blockchain
Returns
POST request will return a stringvalue of the staked amount. (in wei)
Postman example
Read user pending rewards amount from the blockchain
POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/call/pending-rewards
Path Parameters
poolAddress*
String
The smart contract address of the reward pool
pid*
number
The monotonic id of the staking pool
Request Body
user*
String
The user account ($EVM Address)
chainId*
number
The chain id of the blockchain
Returns
POST request will return a string value of the amount of the pending rewards. (in wei)
Postman example
Read total value locked of given pool contract address
GET https://api.hotcross.com/tvl/cross-pool/{poolAddress}
Path Parameters
poolAddress*
string
The smart contract address of the reward pool
Query Parameters
chain*
number
The chain tha the contract address belongs to
Responses
total - number:The total value locked in the reward poolstaking pool contract address - number:The value locked in a staking pool
Postman example
Read the total amount staked for a token in all cross pools
GET https://api.hotcross.com/tokens/{address}/staked
Path Parameters
address*
String
The address of the token to read the total amount staked for
Responses
totalStaked - string:the amount staked
Postman example
Last updated