Utility API methods

Returns the current API version

GET https://api.hotcross.com/version

{
  "version": "string"
}

Responses:

  • version - string: The API version

Postman example

Read the USD value of an LP token

GET https://api.hotcross.com/lp

Query Parameters

NameTypeDescription

lptoken*

String

The smart contract address of the LP token

amount*

String

The amount of LP tokens

{
  "*": {
    "usd": 0
  }
}

Responses:

  • "*": The address of the LP token

  • usd - string: The USD value of the LP token

Postman example

Read the token the metadata json that contains all tokens used in Hot Cross platform

GET https://api.hotcross.com/tokens

Query Parameters

NameTypeDescription

chain*

number

The chain id of the blockchain we want to read the TokensMetadata from

{
  "*": {
    "image": "string",
    "name": "string",
    "decimals": 0,
    "symbol": "string"
  }
}

Responses:

  • *: The smart contract address of the token

    • image - string: The token's image link

    • name - string: The token's name

    • symbol - string: The token's symbol

    • decimals - number: The token's decimals

Postman example

Last updated