Gas pump

Check whether the gas pump address with a specified index is activated

/v3/gas-pump/activated/{chain}/{owner}/{index}

1 credit per API call

Check whether the gas pump address with a specified index is activated and can send funds to other addresses.

You can use this API when a customer initiates a fund transfer and you need to check whether their gas pump address is allowed to send funds.

This API is supported for the following blockchains:

  • BNB Smart Chain
  • Celo
  • Ethereum
  • Harmony
  • Klaytn
  • Polygon
  • TRON
get/v3/gas-pump/activated/{chain}/{owner}/{index}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/gas-pump/activated/{chain}/{owner}/{index}
  • Auth
    API key in header x-api-key

Path parameters

chain'BSC' | 'CELO' | 'ETH' | 'MATIC' | 'KLAY' | 'ONE' | 'TRON' required
Example:ETH

The blockchain to work with

ownerstring required

The blockchain address that owns the gas pump address to check; can be referred to as "master address"

indexnumber required

The index of the gas pump address to check

Response

OK

activatedboolean

If set to "true", the gas pump address has been activated

Example response

{
  "activated": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.