User Information

Getting claimed rewards and staked amounts for an address in all pools v1

GET https://api.hotcross.com/users/{account}

Path Parameters

Name	Type	Description
account*	String	The address of the user

Query Parameters

Name	Type	Description
chain*	String	The chain id of the blockchain we want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

[
  {
    "rewardsClaimed": {
      "*": {
        "pid": "string"
      }
    },
    "userStaked": {
      "*": {
        "pid": "string"
      }
    },
    "hasClaimableRewards": {
      "*": {
        "pid": true
      }
    }
  }
]

500: Internal Server Error Internal server error

{
    // Response
}

Responses:

• rewardsClaimed - object:

  • *-string: the reward pool's address

    • pid - string: the amount of rewards claimed by the address

• userStaked - object:

  • *-string: the reward pool's address

  • pid - string: the amount of tokens staked by the address

• hasClaimableRewards - object:

  • *-string: the reward pool's address

  • pid - string: a flag indicates that the address has claimable tokens or not

Postman example

For API version 2, add /v2/ into the path: api.hotcross.com/v2/users/{account}

The parameters and responses should be the same. For more detail, please check out Cross API Swagger.