Tatum API v1 (1.0.0)

Download OpenAPI specification:Download

Welcome to the Tatum API Reference!

What is Tatum?

Tatum is a developer tool that makes it easy to build blockchain applications without any previous blockchain experience. Whether you're a seasoned developer or just starting out, Tatum can help you build blockchain applications quickly and easily. With support for multiple chains, you can choose the blockchain that best fits your needs and get started right away. Plus, Tatum has a strong Discord community where you can connect with other developers and get help when you need it.

Are you interested in building blockchain applications but don't know where to start? Tatum is the perfect tool for you! With Tatum, you don't need any previous blockchain experience. You can choose from multiple chains, including Ethereum, Bitcoin, and many others, and start building your application right away. Plus, Tatum's user-friendly interface makes it easy to navigate and get started quickly.

At Tatum, we believe that community is key to building great blockchain applications. That's why we have a strong Discord community where you can connect with other developers, share ideas, and get help when you need it. Whether you're stuck on a problem or just want to chat with other developers, our community is always there to support you. So why wait? Join the Tatum community today and start building amazing blockchain applications!

Authentication

When using the Tatum API, you authenticate yourself with an API key.

X-API-Key

The API key represents your pricing plan and defines how many API calls you can make per second and what the total number of API calls per month is available for you.

One API key must be used by only one person.

Choose one of the following authentication methods:

  • Provide the API key in each API call.

    To obtain the API key, create a Tatum account. Once you are logged in, you are automatically assigned the Free plan.

    With the Free plan:

    • You get two API keys, one tied to the testnet of a blockchain and the other to the mainnet.
    • You can make up to five API calls per second.

    When making an API call, provide the appropriate API key (testnet or mainnet) as either an HTTP header.

    If you ever need your API keys, you can find them in your Tatum account.

  • Get an auto-generated API key attached to API calls.

    Make an API call without any API key provided. The API key will be generated and tied to your IP address. This API key is stored within the Tatum platform and is automatically attached to all your API calls.

    With the auto-generated API key:

    • You can make up to five API calls per second.

    These limits are applied to both the testnet and mainnet.

    By default, API calls with the auto-generated API key are executed against the mainnet. To make an API call to the testnet, add the type query parameter set to testnet to the endpoint URL, for example:

    https://api.tatum.com/v1/subscription?type=testnet

Security Scheme Type: API Key
Header parameter name: x-api-key

Notification subscriptions

The API section of Notification subscriptions allows you to create, retrieve, and delete subscriptions to the blockchain webhook service. This service enables you to monitor various events on the blockchain, such as incoming transactions and NFT transfers. With the API, you can easily manage your subscriptions and receive real-time notifications whenever the specified events occur. This can help you stay informed about important activities on the blockchain and take action accordingly.

Create a subscription

Please expand below notification types to see more details.


ADDRESS_EVENT

Monitoring blockchain addresses can be a challenging and resource-intensive task, especially when you need to track balance updates across multiple token types and currencies. However, with Tatum's ADDRESS_EVENT notification type, you can stay up-to-date with real-time balance updates, allowing you to streamline your operations and enhance the user experience.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Bitcoin Network.BITCOIN Network.BITCOIN_TESTNET
Litecoin Network.LITECOIN Network.LITECOIN_TESTNET
Dogecoin Network.DOGECOIN Network.DOGECOIN_TESTNET
Bitcoin Cash Network.BITCOIN_CASH Network.BITCOIN_CASH_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tezos Network.TEZOS -
Tron Network.TRON Network.TRON_SHASTA
XRP Network.XRP Network.XRP_TESTNET

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "amount": "0.001",
  "asset": "ETH",
  "blockNumber": 2913059,
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "type": "native",
  "chain": "ethereum-mainnet",
  "subscriptionType": "ADDRESS_EVENT"
}

INCOMING_NATIVE_TX

In the world of blockchain, staying updated with incoming transactions is crucial for ensuring smooth operations and an optimal user experience. Tatum's INCOMING_NATIVE_TX notification type is designed to help you do just that – by sending webhook notifications every time there's an incoming native balance update on a monitored address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Bitcoin Network.BITCOIN Network.BITCOIN_TESTNET
Litecoin Network.LITECOIN Network.LITECOIN_TESTNET
Dogecoin Network.DOGECOIN Network.DOGECOIN_TESTNET
Bitcoin Cash Network.BITCOIN_CASH Network.BITCOIN_CASH_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tezos Network.TEZOS -
Tron Network.TRON Network.TRON_SHASTA
XRP Network.XRP Network.XRP_TESTNET

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "amount": "0.001",
  "blockNumber": 2913059,
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "chain": "ethereum-mainnet"
}

OUTGOING_NATIVE_TX

Monitoring outgoing transactions is essential for maintaining a secure and efficient blockchain platform. Tatum's OUTGOING_NATIVE_TX notification type offers a powerful solution to help you stay informed about outgoing native balance updates on a monitored address, simplifying your operations and enhancing user experience.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Bitcoin Network.BITCOIN Network.BITCOIN_TESTNET
Litecoin Network.LITECOIN Network.LITECOIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tezos Network.TEZOS -
Tron Network.TRON Network.TRON_SHASTA
XRP Network.XRP Network.XRP_TESTNET

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "amount": "-0.001",
  "blockNumber": 2913059,
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "chain": "ethereum-mainnet"
}

INCOMING_INTERNAL_TX

In the dynamic world of blockchain, staying updated with transactions involving smart contracts is essential for maintaining a secure and efficient platform. Tatum's INCOMING_INTERNAL_TX notification type offers a powerful solution to help you track incoming native balance updates on a monitored address, which originated from smart contracts.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Celo Network.CELO Network.CELO_ALFAJORES
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "amount": "0.001",
  "blockNumber": 2913059,
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "chain": "ethereum-mainnet"
}

OUTGOING_INTERNAL_TX

In the dynamic world of blockchain, staying updated with transactions involving smart contracts is essential for maintaining a secure and efficient platform. Tatum's OUTGOING_INTERNAL_TX notification type offers a powerful solution to help you track outgoing native balance updates on a monitored smart contract.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Celo Network.CELO Network.CELO_ALFAJORES
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "amount": "-0.001",
  "blockNumber": 2913059,
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "chain": "ethereum-mainnet"
}

OUTGOING_FAILED_TX

In the fast-paced world of blockchain, keeping track of failed transactions is crucial for maintaining a secure and efficient platform. Tatum's OUTGOING_FAILED_TX notification type provides an invaluable tool to help you stay informed about transactions from monitored addresses that fail to be included in a block.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "amount": "-0.001",
  "blockNumber": 2913059,
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "chain": "ethereum-mainnet"
}

FAILED_TXS_PER_BLOCK

In the fast-paced world of blockchain, keeping track of failed transactions is crucial for maintaining a secure and efficient platform. Tatum's FAILED_TXS_PER_BLOCK notification type provides an invaluable tool to help you stay informed about all transactions in a block that fail to be included in a block.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "txId": "2rdy3YCZHSwvpWtuDom1d4Jjy5UU9STLxF3ffXau6GToReDkfw8wEgX541fvzvh6btVC5D8iNapcKTXfPsoDBk7A",
  "blockNumber": 110827114,
  "chain": "ethereum-mainnet"
}

PAID_FEE

In the complex world of blockchain, keeping track of transaction fees is crucial for maintaining a transparent and efficient platform. Tatum's PAID_FEE notification type provides a valuable tool to help you stay informed about fees paid as part of transactions involving a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "txId": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "blockNumber": 110827114,
  "amount": "1",
  "mempool": true,
  "chain": "ethereum-mainnet"
}

INCOMING_FUNGIBLE_TX

In the ever-evolving world of blockchain, keeping track of fungible token transactions is essential for maintaining a secure and efficient platform. Tatum's INCOMING_FUNGIBLE_TX notification type offers a powerful solution to help you stay informed about incoming fungible token transactions (e.g., ERC-20 transfers) involving a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Bitcoin Cash Network.BITCOIN_CASH Network.BITCOIN_CASH_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tron Network.TRON Network.TRON_SHASTA
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "blockNumber": 110827114,
  "amount": "1",
  "chain": "ethereum-mainnet",
  "contractAddress": "0x7D3Dda0430471Fe460C07b1ecaB35670eF4ce85b"
}

OUTGOING_FUNGIBLE_TX

In the dynamic world of blockchain, staying updated with fungible token transactions is vital for maintaining a secure and efficient platform. Tatum's OUTGOING_FUNGIBLE_TX notification type offers a powerful solution to help you track outgoing fungible token transactions (e.g., ERC-20 / SPL transfers) from a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tron Network.TRON Network.TRON_SHASTA
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "blockNumber": 110827114,
  "amount": "1",
  "chain": "ethereum-mainnet",
  "contractAddress": "0x7D3Dda0430471Fe460C07b1ecaB35670eF4ce85b"
}

INCOMING_NFT_TX

In the ever-expanding world of blockchain, keeping track of non-fungible token (NFT) transactions is crucial for maintaining a secure and efficient platform. Tatum's INCOMING_NFT_TX notification type offers a powerful solution to help you stay informed about incoming non-fungible token transactions (e.g., ERC-721 / SPL transfers) involving a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tron Network.TRON Network.TRON_SHASTA
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0xe118976ba31815f81301341b4e211825bce1393cac1c4215075177b0a6b98930",
  "blockNumber": 110827114,
  "amount": "1",
  "chain": "ethereum-mainnet",
  "contractAddress": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "tokenId": "1450000023306",
  "metadataURI": "https://touhao.bj.bcebos.com/nft/metadata/1450000023306.json"
}

OUTGOING_NFT_TX

In the fast-paced world of blockchain, keeping track of non-fungible token (NFT) transactions is essential for maintaining a secure and efficient platform. Tatum's OUTGOING_NFT_TX notification type offers a powerful solution to help you stay informed about outgoing non-fungible token transactions (e.g., ERC-721 / SPL transfers) from a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Solana Network.SOLANA Network.SOLANA_DEVNET
Tron Network.TRON Network.TRON_SHASTA
Tezos Network.TEZOS -

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0xe118976ba31815f81301341b4e211825bce1393cac1c4215075177b0a6b98930",
  "blockNumber": 110827114,
  "amount": "1",
  "chain": "ethereum-mainnet",
  "contractAddress": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "tokenId": "1450000023306",
  "metadataURI": "https://touhao.bj.bcebos.com/nft/metadata/1450000023306.json"
}

INCOMING_MULTITOKEN_TX

In the dynamic world of blockchain, keeping track of multi-token transactions is crucial for maintaining a secure and efficient platform. Tatum's INCOMING_MULTITOKEN_TX notification type offers a powerful solution to help you stay informed about incoming multi-token transactions (e.g., ERC-1155 transfers) involving a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0xe118976ba31815f81301341b4e211825bce1393cac1c4215075177b0a6b98930",
  "blockNumber": 110827114,
  "amount": "1",
  "chain": "ethereum-mainnet",
  "contractAddress": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "tokenId": "1450000023306",
  "metadataURI": "https://touhao.bj.bcebos.com/nft/metadata/1450000023306.json"
}

OUTGOING_MULTITOKEN_TX

In the rapidly evolving world of blockchain, keeping track of multi-token transactions is essential for maintaining a secure and efficient platform. Tatum's OUTGOING_MULTITOKEN_TX notification type offers a powerful solution to help you stay informed about outgoing multi-token transactions (e.g., ERC-1155 transfers) from a specific address.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

{
  "address": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "counterAddress": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "txId": "0xe118976ba31815f81301341b4e211825bce1393cac1c4215075177b0a6b98930",
  "blockNumber": 110827114,
  "amount": "1",
  "chain": "ethereum-mainnet",
  "contractAddress": "0x7d3dda0430471fe460c07b1ecab35670ef4ce85b",
  "tokenId": "1450000023306",
  "metadataURI": "https://touhao.bj.bcebos.com/nft/metadata/1450000023306.json"
}

CONTRACT_ADDRESS_LOG_EVENT

In the fast-paced world of blockchain, keeping track of contract events is essential for maintaining a secure and efficient platform. Tatum's CONTRACT_ADDRESS_LOG_EVENT notification type offers a powerful solution to help you stay informed about nft mints, transfers or any other contract events.

Which blockchain networks are supported?

Blockchain Mainnet Testnet
Ethereum Network.ETHEREUM Network.ETHEREUM_SEPOLIA,Network.ETHEREUM_GOERLI
Polygon Network.POLYGON Network.POLYGON_MUMBAI
Binance Smart Chain Network.BINANCE_SMART_CHAIN Network.BINANCE_SMART_CHAIN_TESTNET
Celo Network.CELO Network.CELO_ALFAJORES
Klaytn Network.KLAYTN Network.KLATN_BAOBAB
Tezos Network.TEZOS N/A

What does the fired webhook look like?

The fired notification webhook you will receive in your webhook listener will have the following format.

Example for EVM chains:

{
  "events": [
    {
      "txId": "0xbcf42229dbd97a7c1554f0451a8d4ba6653593de06d4ea62691ce314d036d19e",
      "logIndex": 3,
      "timestamp": 1696945197000,
      "address": "0xeb0a4ee3cdfffe0ef29f967a34137dea3b529c89",
      "topic_0": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
      "topic_1": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "topic_2": "0x000000000000000000000000cacdddf3c123b133cb36b0ee17925c7a70a1ea93",
      "topic_3": "0x0000000000000000000000000000000000000000000000000000000000000002",
      "data": "0x"
    }
  ],
  "blockNumber": 20312334,
  "chain": "celo-testnet",
  "subscriptionType": "CONTRACT_ADDRESS_LOG_EVENT"
}

Example for Tezos. The tag and payload in the event object depend on what the contract emits:

{
  "events": [
    {
      "txId": "op6Hu4iUV9bRxxGkc5qVexN1NXFYENpKEovyh41cC3W9a9voX2k",
      "tag": "swap",
      "payload": [
        {
          "int": "130"
        },
        {
          "int": "0"
        },
        {
          "int": "67034"
        },
        {
          "int": "118138"
        }
      ],
      "address": "KT1V5XKmeypanMS9pR65REpqmVejWBZURuuT"
    }
  ],
  "blockNumber": 4376363,
  "chain": "tezos-mainnet",
  "subscriptionType": "CONTRACT_ADDRESS_LOG_EVENT"
}
SecurityX-API-Key
Request
query Parameters
testnetType
string
Default: "ethereum-sepolia"

Type of Ethereum testnet. Defaults to ethereum-sepolia.

Enum: "ethereum-sepolia" "ethereum-goerli" "ethereum-holesky"
Request Body schema: application/json
required
One of:
type
required
string

Type of the subscription.

Enum: "ADDRESS_EVENT" "INCOMING_NATIVE_TX" "OUTGOING_NATIVE_TX" "OUTGOING_FAILED_TX" "PAID_FEE" "INCOMING_INTERNAL_TX" "OUTGOING_INTERNAL_TX" "INCOMING_FUNGIBLE_TX" "OUTGOING_FUNGIBLE_TX" "INCOMING_NFT_TX" "OUTGOING_NFT_TX" "INCOMING_MULTITOKEN_TX" "OUTGOING_MULTITOKEN_TX" "CONTRACT_ADDRESS_LOG_EVENT"
required
object

Additional attributes based on the subscription type.

address
required
string [ 13 .. 128 ] characters

Blockchain address to watch.

chain
required
string

Blockchain of the address.

Enum: "SOL" "ETH" "MATIC" "CELO" "KLAY" "BTC" "LTC" "BCH" "DOGE" "TRON" "BSC" "TEZOS"
url
required
string <= 500 characters

URL of the endpoint, where HTTP POST request will be sent, when transaction is detected on the address.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v1/subscription
Request samples
application/json
{}
Response samples
application/json
{
  • "id": "5e68c66581f2ee32bc354087"
}

List all active subscriptions

1 credit per API call.


List all active subscriptions.

SecurityX-API-Key
Request
query Parameters
pageSize
required
number [ 1 .. 50 ]

Max number of items per page is 50.

Example: pageSize=10
offset
number

Offset to obtain next page of the data.

Example: offset=0
address
string

Value for filtering by address

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

get/v1/subscription
Request samples
Response samples
application/json
[
  • {
    }
]

Update subscription url

1 credit for API call


Update subscription url.

SecurityX-API-Key
Request
path Parameters
id
required
string

Subscription ID

Example: 5e68c66581f2ee32bc354087
Request Body schema: application/json
required
url
required
string

New webhook url

Responses
204

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

put/v1/subscription/{id}
Request samples
application/json
Response samples
application/json
{
  • "errorCode": "validation.failed",
  • "message": "Request validation failed. Please see data for additional information.",
  • "statusCode": 400,
  • "data": [
    ]
}

Cancel existing subscription

1 credit for API call


Cancel existing subscription.

SecurityX-API-Key
Request
path Parameters
id
required
string

Subscription ID

Example: 5e68c66581f2ee32bc354087
Responses
204

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

delete/v1/subscription/{id}
Request samples
Response samples
application/json
{
  • "errorCode": "validation.failed",
  • "message": "Request validation failed. Please see data for additional information.",
  • "statusCode": 400,
  • "data": [
    ]
}

List all executed webhooks

1 credit per API call.


List all webhooks.

SecurityX-API-Key
Request
query Parameters
pageSize
required
number [ 1 .. 50 ]

Max number of items per page is 50.

Example: pageSize=10
offset
number

Offset to obtain the next page of data.

Example: offset=0
direction
string

Direction of sorting

Enum: "asc" "desc"
Example: direction=asc
failed
boolean

Flag indicating whether the webhook was successful or not

Example: failed=false
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

get/v1/subscription/webhook
Request samples
Response samples
application/json
[
  • {
    }
]

Data API

The Data API is a powerful tool that enables you to read information from various blockchains. This includes information such as wallet balances, NFT balances, address history, and smart contract events. By accessing this information, you can gain valuable insights into blockchain activity and make informed decisions about your investments or transactions. The Data API provides a simple and efficient way to retrieve blockchain data, making it a popular choice for developers and businesses alike. The Data API offers a wide range of features that make it a valuable tool for blockchain data retrieval. Some of the key features include:

  • Multi-chain support: The Data API supports multiple blockchains, including Ethereum, Bitcoin, and many others.
  • Real-time data retrieval: With the Data API, you can access real-time data on blockchain activity, ensuring that you always have the latest information.
  • Customizable data queries: The API allows you to customize your data queries to retrieve only the information you need. This helps to minimize data transfer and reduce costs.
  • Comprehensive data coverage: The Data API covers a wide range of blockchain data, including wallet balances, NFT balances, transaction history, and more. This makes it a valuable tool for a variety of use cases, from investment analysis to fraud detection.
  • Scalability: The Data API is designed to be highly scalable, making it suitable for both small and large-scale applications. Whether you need to retrieve data for a single user or millions of users, the API can handle your requests efficiently.

Get tokens from a collection

10 credits per API call

Get all NFTs (ERC-721 and ERC-1155) and multitokens (ERC-1155 only) of your favorite collections! Our API lets you search for all tokens on:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet
  • Tezos - tezos-mainnet

To get started:

  • Provide a chain name and comma-separated list of collection addresses. Our API will return relevant information about each token, including its name, description, image, and more.
  • Aside from relevant information about each token, the response also contains metadata (they can, however, be excluded by setting excludeMetadata to true).
  • If not specified, the API returns results for all supported types of tokens (nft, multitokens), but you can also choose to filter only one tokenType.
  • For Tezos blockchain query parameters excludeMetadata and tokenType won't have any effect on filtering data.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
collectionAddresses
required
string (TokenAddress)

The blockchain addresses of the collections. It is possible to enter list of up to 10 addresses as a comma separated string.

Example: collectionAddresses=0xba30E5F9Bb24caa003E9f2f0497Ad287FDF95623
tokenTypes
string

The option to select only specific token types. It is possible to enter list of multiple types as a comma separated string. Use nft (includes ERC-721 and ERC-1155) or multitoken (ERC-1155 only).

Enum: "nft" "multitoken"
Example: tokenTypes=nft
excludeMetadata
boolean (ExcludeMetadata)

The option to exclude metadata from the response.

Example: excludeMetadata=false
pageSize
number (PageSize) [ 1 .. 50 ]

The number of items per page (default is 50).

Example: pageSize=10
offset
number (Offset)

The offset to obtain next page of the data.

Example: offset=0
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/collections
Request samples
Response samples
application/json
[
  • {
    }
]

Get token metadata

5 credits per API call

Get metadata of NFTs (ERC-721 and ERC-1155) or multitokens (ERC-1155 only) by IDs for a given token address! Our API lets you search for all tokens on:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • Provide a chain name, token address and comma-separated list of IDs. Our API will return relevant metadata about each specified token, including its name, description, image, and more.
  • Aside from the metadata information, the response also contains token types and metadata url minted in each token.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
tokenAddress
required
string (TokenAddress)

The blockchain address of the NFT to get metadata for.

Example: tokenAddress=0xba30E5F9Bb24caa003E9f2f0497Ad287FDF95623
tokenIds
required
string <uint256> (TokenIds) <= 78 characters

The IDs of the tokens to get metadata for. It is possible to enter list of multiple IDs as a comma separated string.

Example: tokenIds=3,4
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/metadata
Request samples
Response samples
application/json
[
  • {
    }
]

Get balances of addresses

50 credits per API call

Get balances of fungible tokens (ERC-20), NFTs (ERC-721 and ERC-1155) or multitokens (ERC-1155 only) for a specific wallet address on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Tezos - tezos-mainnet
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • Provide a chain name and comma-separated list of addresses. Our API will return balances of each token along with further information such as its type, id, and more.
  • Aside from relevant information about each token and its balance, the response also contains metadata (they can, however, be excluded by setting excludeMetadata to true).
  • If not specified, the API returns balances for all supported types of tokens (fungible tokens, nft, multitokens), but you can also choose to filter specific tokenTypes.
  • For Tezos blockchain, the API returns balance of any tokens including native token (XTZ) for specified wallet addresses. Following query parameters won't have any effect on filtering data excludeMetadata.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnumExtended)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "tezos" "eon" "chiliz"
Example: chain=ethereum
addresses
required
string

The blockchain public wallet addresses. It is possible to enter list of up to 10 addresses as a comma separated string.

Example: addresses=0x80d8bac9a6901698b3749fe336bbd1385c1f98f2,0xAe680Ed83baF08a8028118Bd19859F8a0E744cc6
tokenTypes
string

The option to select only specific token types. It is possible to enter list of multiple types as a comma separated string. Use fungible (ERC-20), nft (includes ERC-721 and ERC-1155) or multitoken (ERC-1155 only).

Enum: "nft" "multitoken" "fungible"
Example: tokenTypes=nft,multitoken
excludeMetadata
boolean (ExcludeMetadata)

The option to exclude metadata from the response.

Example: excludeMetadata=false
pageSize
number (PageSize) [ 1 .. 50 ]

The number of items per page (default is 50).

Example: pageSize=10
offset
number (Offset)

The offset to obtain next page of the data.

Example: offset=0
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/balances
Request samples
Response samples
application/json
{
  • "result": [
    ],
  • "prevPage": "",
  • "nextPage": ""
}

Get owners of a token

20 credits per API call

Get all addresses that own your favorite token (ERC-20, ERC-721 or ERC-1155)! Our API lets you search for all token owners on:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • Provide a chain name and address of any fungible token, NFT or multitoken collection. Our API will return a list of addresses of all of their owners.
  • You can also get an owner of a specific NFT by specifying tokenId. In case of multitoken, result is an array of addresses.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
tokenAddress
required
string (TokenAddress)

The blockchain address of the token (NFT collection or any fungible token).

Example: tokenAddress=0xba30E5F9Bb24caa003E9f2f0497Ad287FDF95623
tokenId
string <uint256> (TokenId) <= 78 characters

The ID of a specific NFT token.

Example: tokenId=3
pageSize
number (PageSize) [ 1 .. 50 ]

The number of items per page (default is 50).

Example: pageSize=10
offset
number (Offset)

The offset to obtain next page of the data.

Example: offset=0
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/owners
Request samples
Response samples
application/json
[
  • "0x0bbf9f25c863fdf19e645c96280004d24f43cb38",
  • "0x0bd1b3b12db943f2310a4e53481ae97f8b6c2a75",
  • "0x281f4727081ab4a066f321fd6fc8dd0dc063e9fd",
  • "0x681cbae1c41e5eec8411dd8e009fa71f81d03f7f",
  • "0x7b49a05c15702bbe1db534058ebcc9e950c474ca"
]

Check owner of token

1 credit per API call

Check if wallet address owns any specified token (ERC-20, ERC-721 or ERC-1155) on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • Provide a chain name, wallet address and address of any fungible token, NFT or multitoken collection. Our API will return true if provided wallet address owns them.
  • If wallet address does not own the specific token, response body is false and status code is 200.
  • It is also possible to check if wallet address owns a specific NFT by specifying a tokenId.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
address
required
string

The blockchain address of the wallet.

Example: address=0x2474a7227877f2b65185f09468af7c6577fa207c
tokenAddress
required
string (TokenAddress)

The blockchain address of the token (NFT collection or any fungible token).

Example: tokenAddress=0xba30E5F9Bb24caa003E9f2f0497Ad287FDF95623
tokenId
string <uint256> (TokenId) <= 78 characters

The ID of a specific NFT token.

Example: tokenId=3
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/owners/address
Request samples
Response samples
application/json
true

Get transactions

20 credits per API call

Get transactions on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Tezos - tezos-mainnet
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • Provide a chain name and comma-separated list of addresses. Our API will return all of their transactions along with further information such as their block number, ID of involved token, and more.
  • If not specified, the API returns transactions of various types (fungible, nft, multitoken, native), but you can also choose to filter specific transactionTypes and even transactionSubtype (incoming, outgoing, zero-transfer).
  • On top of that, you can add further filters such as specifying block range where the transactions should have occurred, or address and ID of involved tokens.
  • For Tezos blockchain, the API accepts only one wallet address in addresses query parameter. Following query parameters won't have any effect on filtering data: transactionTypes, transactionSubtype, tokenId, blockTo.
  • When querying Tezos transactions for a specified wallet or contract address, pagination is supported via pageSize and offset query parameters.
  • When querying Tezos transactions for a specified block, pagination is supported via cursor query parameter, by filling in the value from prevPage or nextPage field in the response body.
  • When you are filtering data using blockFrom and not using blockTo, query might take longer time to finish. It is always recommended to use both filters blockFrom and blockTo.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnumExtended)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "tezos" "eon" "chiliz"
Example: chain=ethereum
addresses
string

The blockchain public wallet addresses. It is possible to enter list of up to 10 addresses as a comma separated string.

Example: addresses=0x2474a7227877f2b65185f09468af7c6577fa207c
transactionTypes
string

The option to filter transaction based on types. It is possible to enter list of multiple types as a comma separated string. Use fungible (ERC-20), nft (ERC-721 and ERC-1155), multitoken (ERC-1155) or native.

Enum: "fungible" "nft" "multitoken" "native"
Example: transactionTypes=fungible,nft
transactionSubtype
string

The option to filter transaction based on subtype.

Enum: "incoming" "outgoing" "zero-transfer"
Example: transactionSubtype=incoming
tokenAddress
string (TokenAddress)

Address of a token (smart contract).

Example: tokenAddress=0xba30E5F9Bb24caa003E9f2f0497Ad287FDF95623
tokenId
string <uint256> (TokenId) <= 78 characters

ID of a token.

Example: tokenId=3
blockFrom
number (BlockNumber) >= 0

Transactions from this block onwards will be included.

Example: blockFrom=16499510
blockTo
number (BlockNumberTo) >= 0

Transactions up to this block will be included.

Example: blockTo=16779230
pageSize
number (PageSize) [ 1 .. 50 ]

The number of items per page (default is 50).

Example: pageSize=10
offset
number (Offset)

The offset to obtain next page of the data.

Example: offset=0
cursor
string (Cursor)

The cursor to obtain previous page or next page of the data. Available only for Tezos blockchain.

Example: cursor=MzYxNTQ3MHwyNDV8cHJldg==
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/transactions
Request samples
Response samples
application/json
{
  • "result": [
    ],
  • "prevPage": "KtYxNTQ3MHwyNDV8cHJldgs=",
  • "nextPage": "MzYxNTQ3MHwyNDV8cHJldg=="
}

Get transactions by hash

5 credits per API call

Get transactions by hash on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Tezos - tezos-mainnet
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • Provide a chain name and transaction hash, and our API will return a list of transactions with that hash.
  • The response will contain all the relevant information about specified transactions such as their block number, IDs of involved token, and more.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnumExtended)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "tezos" "eon" "chiliz"
Example: chain=ethereum
hash
required
string

Hash of the transaction.

Example: hash=0xd49f8d6544f2822522886a02f4787a56ea93bbd636bfdf81d6795a10553d7118
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/transactions/hash
Request samples
Response samples
application/json
[
  • {
    },
  • {
    }
]

Get specified events

20 credits per API call

Get all events on given addresses and / or in the requested block range on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started:

  • To improve response times and obtain specific data, it is recommended to use proper filtering techniques. Please provide a chain name and a combination of filters that will accomplish this (at least block range or contract addresses must be specified).
  • It is possible to specify multiple contract addresses at once by passing them as a comma separated string.
  • If block range is not specified, the API attempts to go through all available blocks, which may result in a timeout error.
  • It is recommended to filter only one specific type of events, which comes with built-in decoding for all the supported types.
  • It is, however, also possible to filter by signature hashes, which can be passed together as a comma separated string.

As noted above, aside from general info and hashed event data, the API also decodes them for you in case you filter by one of the following supported event types:

  • tokenTransfer: All transfers of fungible tokens (including stablecoins) and NFTs as per ERC-20 and ERC-721 standard.
  • multitokenTransfer: All transfers of multitokens (both single transfers and batch transfers) as per ERC-1155 standard.
  • stablecoinTransfer: Refers to the transfer of specific stablecoins on the mainnet. Typically, the top 10 to 16 stablecoins on each chain according to CoinMarketCap are included. If the contractAddresses parameter is also used in the filter combination, any tokens specified in it will also be included in the list.
  • uniswapTrade: Provides all swap events that occur on both Uniswap V2 and V3. In some cases, it may not be possible to map the swapped amounts to specific tokens. As a result, certain decoded data such as token amounts might be missing or in the original big number format. This will be indicated by the response parameter partiallyRaw: true.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
contractAddresses
required
string

The blockchain addresses of the contracts where requested events were emitted. It is possible to enter list of up to 10 addresses as a comma separated string.

Example: contractAddresses=0x95ad61b0a150d79219dcf64e1e6cc01f0b64c4ce
blockFrom
required
number (BlockNumber) >= 0

First block to start from (including this one).

Example: blockFrom=16499510
blockTo
required
number (BlockNumberTo) >= 0

Last block to finish on (including this one).

Example: blockTo=16779230
eventType
required
string

The type of events that should be returned, which comes with decoded data in the response (cannot be used together with signatures).

Enum: "tokenTransfer" "multitokenTransfer" "stablecoinTransfer" "uniswapTrade"
Example: eventType=tokenTransfer
signatures
string

The types of events that should be returned, specified by hashed signature (cannot be used together with eventType). It is possible to enter list of multiple signatures as a comma separated string.

Example: signatures=0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef
pageSize
number (PageSize) [ 1 .. 50 ]

The number of items per page (default is 50).

Example: pageSize=10
offset
number (Offset)

The offset to obtain next page of the data.

Example: offset=0
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/events
Request samples
Response samples
application/json
{
  • "chain": "ethereum",
  • "address": "string",
  • "blockNumber": 0,
  • "timestamp": 0,
  • "decoded": {
    },
  • "raw": {
    },
  • "txHash": "string",
  • "txIndex": 0,
  • "logIndex": 0
}

Get specified blocks

10 credits per API call

Get information about blocks (when they were added, how many NFTs and events were ingested and list of transaction hashes that were processed within them) on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started, provide a chain and specify one of the filters listed below (combination of these filters is not allowed):

  • List of block numbers separated by comma
  • Range of block numbers
  • Date range when blocks were processed
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
blockIds
Array of integers >= 0

List of block numbers, separated by comma.

Example: blockIds=1,2,4,400
blockFrom
number (BlockNumber) >= 0

Range of block numbers. Both blockFrom and blockTo need to be specified.

Example: blockFrom=16499510
blockTo
number (BlockNumber) >= 0

Range of block numbers. Both blockFrom and blockTo need to be specified.

Example: blockTo=16499510
timeFrom
string

Date range when blocks were processed. Both timeFrom and timeTo need to be specified.

Example: timeFrom=2022-12-24T00:10
timeTo
string

Date range when blocks were processed. Both timeFrom and timeTo need to be specified.

Example: timeTo=2022-12-24T00:20
pageSize
number (PageSize) [ 1 .. 50 ]

The number of items per page (default is 50).

Example: pageSize=10
offset
number (Offset)

The offset to obtain next page of the data.

Example: offset=0
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/blocks
Request samples
Response samples
application/json
[
  • {
    },
  • {
    }
]

Get latest block

1 credit per API call

Get information about latest added block on the following blockchains:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet

To get started, you can just provide a chain.

SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/blocks/latest
Request samples
Response samples
application/json
{
  • "blockNumber": 10,
  • "blockTimestamp": 1598671520000,
  • "hash": "0xec1a2d906f34e1981b2b1a15dbe5e10cf640e8b4b27dc056ebb65c0409b5a9af",
  • "eventIngestedSize": 0,
  • "nftIngestedSize": 0,
  • "txHashes": [
    ]
}

Get information about collection or token

1 credit per API call

Get information about your favorite token! Our API lets you search for all tokens on:

  • Celo - celo / celo-testnet
  • Ethereum - ethereum / ethereum-sepolia
  • BNB (Binance) Smart Chain - bsc / bsc-testnet
  • Polygon - polygon / polygon-mumbai
  • Horizen EON - eon-mainnet
  • Chiliz - chiliz-mainnet
  • Tezos - tezos-mainnet

To get started:

  • Provide a chain and address of any fungible token, NFT or multitoken collection. If available, our API will return information about them such as their name, symbol, supply, and more.
  • You can also get extra infomation (such as metadata) of a specific NFT or multitoken by passing tokenId as a query parameter.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainEnum)

The blockchain to work with.

Enum: "ethereum" "ethereum-sepolia" "celo" "celo-testnet" "bsc" "bsc-testnet" "polygon" "polygon-mumbai" "eon" "chiliz"
Example: chain=ethereum
tokenAddress
required
string (TokenAddress)

The blockchain address of the token (NFT collection or any fungible token).

Example: tokenAddress=0xba30E5F9Bb24caa003E9f2f0497Ad287FDF95623
tokenId
string <uint256> (TokenId) <= 78 characters

The ID of a specific NFT token.

Example: tokenId=3
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

404

Collection or token not found.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/tokens
Request samples
Response samples
application/json
{
  • "symbol": "RareItem",
  • "name": "BeefyCollectibles",
  • "supply": "13",
  • "decimals": 6,
  • "tokenType": "nft",
  • "cap": "2000000000",
  • "metadataURI": "QmYrUYv3kCXsrbs8YGguwZkyyMgGkgdQpbse8dZrDaruy5",
  • "metadata": {
    }
}

Get unspent UTXOs for an address

100 credits per API call

Get unspent UTXOs for a specific address up to a specific total amount. If you want to prepare a transaction on UTXO-based chains like Bitcoin, you need to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` as a total, our API will return a list of UTXOs that will be enough to cover the transaction.

Our API lets you get the unpenst UTXOs for a specific address on:

  • Bitcoin - bitcoin / bitcoin-testnet
  • Litecoin - litecoin / litecoin-testnet
  • Dogecoin - doge / doge-testnet
  • Cardano - cardano / cardano-preprod

To get started:

  • Provide a chain and address you want to list unspent UTXOs for. If available, our API will return information about the unspent UTXOs for a specific address. API traverses latest 200k incoming transactions.
SecurityX-API-Key
Request
query Parameters
chain
required
string (ChainUtxoEnum)

The blockchain to work with.

Enum: "bitcoin" "bitcoin-mainnet" "bitcoin-testnet" "litecoin" "litecoin-mainnet" "litecoin-testnet" "doge" "doge-mainnet" "doge-testnet" "cardano" "cardano-mainnet" "cardano-preprod"
Example: chain=bitcoin
address
required
string

The blockchain address.

Example: address=bc1qmfp2r68cde646jv5ns7x2qvah8v5qtfw8gznj2
totalValue
required
number >= 0

The total amount of transaction you want to send. Only UTXOs up to this amount will be returned, so you will not spend more than you need.

Example: totalValue=0.0001
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

get/v1/data/utxos
Request samples
Response samples
application/json
[
  • {
    }
]

Get unspent UTXOs for a batch of addresses

100 credits per address for each API call.

Retrieve unspent UTXOs for each provided address, up to a specified total amount. If you want to prepare a transaction on UTXO-based chains like Bitcoin, you need to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` as a total, our API will return a list of UTXOs that will be enough to cover the transaction.

Our API lets you get the unpenst UTXOs for a specific address on:

  • Bitcoin - bitcoin / bitcoin-testnet
  • Litecoin - litecoin / litecoin-testnet
  • Dogecoin - doge / doge-testnet
  • Cardano - cardano / cardano-preprod

To get started:

  • Provide a chain and addresses you want to list unspent UTXOs for. If available, our API will return information about the unspent UTXOs for each address. API traverses latest 200k incoming transactions.
SecurityX-API-Key
Request
Request Body schema: application/json
required
chain
string (ChainUtxoEnum)

The blockchain to work with.

Enum: "bitcoin" "bitcoin-mainnet" "bitcoin-testnet" "litecoin" "litecoin-mainnet" "litecoin-testnet" "doge" "doge-mainnet" "doge-testnet" "cardano" "cardano-mainnet" "cardano-preprod"
addresses
required
Array of strings [ 1 .. 50 ] items

Addresses

totalValue
required
number >= 0

The total amount of transaction you want to send. Only UTXOs up to this amount will be returned, so you will not spend more than you need.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server during the processing of the request.

post/v1/data/utxos/batch
Request samples
application/json
{
  • "chain": "bitcoin",
  • "addresses": [
    ],
  • "totalValue": 0.0001
}
Response samples
application/json
[
  • {
    }
]

Smart Contract interactions

Engaging with blockchain ecosystems traditionally necessitates the use of private keys, owning cryptocurrency assets, and interacting with Solidity, particularly when deploying and interacting with smart contracts. However, the API we present here abstracts away these complexities, facilitating seamless smart contract deployment and interactions across a variety of networks, namely Ethereum, Polygon, Binance Smart Chain, and Celo.

Key Features

Smart Contract Deployment

Deploying custom smart contracts is now possible using our API, which supports ERC20, ERC721, and ERC1155 standards. The choice of standards allows developers to deploy the contract that best suits their needs, without worrying about the nuances of smart contract code implementation.

Zero Private Key Requirement

The API system has been designed to eliminate the need for the user to hold private keys for contract interactions or deployments. This design feature improves security by reducing the risk of key mismanagement or loss, making the overall system more resilient and robust.

Zero Crypto Asset Requirement

Transaction fees, or "gas," are a staple of blockchain transactions. However, our API breaks this norm, allowing users to deploy smart contracts without holding any cryptocurrency. This approach lowers the barrier of entry for users who are new to blockchain technology or those who wish to transact without the need for owning crypto assets.

Cross-chain Support

This API supports smart contract deployment across Ethereum, Polygon, Binance Smart Chain, and other EVM-compatible networks. This feature offers flexibility to developers and users by allowing cross-chain transactions and interactions, increasing the available options for smart contract deployment.

Solidity-Free Interactions

While Solidity is the primary language for writing smart contracts, particularly for Ethereum, it's a barrier for those unfamiliar with the language. The API abstracts away these interactions, allowing developers to focus more on the logical design of their applications rather than intricacies of Solidity.

Through this developer-focused approach, the API system is significantly improving the process of deploying and interacting with smart contracts. It eliminates the need for managing private keys, owning crypto assets, and interacting directly with Solidity, providing a more streamlined and accessible way to leverage blockchain technology.

Deploy smart contract

This operation is used to create a new smart contract on the blockchain. The operation is asynchronous and returns a transaction hash. The transaction hash can be used to query the status of the transaction.
You can create the following types of contracts:

  • ERC-20 - Fungible token like USDT
  • ERC-721 - NFT collection like BAYC
  • ERC-1155 - MultiToken NFT collection
You can find more information about the contracts on our GitHub page with steps required for verification.
If you deploy NFT collection contract (ERC-721), it is automatically enabled for NFT Express functionality.
SecurityX-API-Key
Request
Request Body schema: application/json
required
One of:
chain
required
string

The blockchain network where the contract will be deployed.

Enum: "bsc-mainnet" "bsc-testnet" "ethereum-mainnet" "ethereum-sepolia" "polygon-mainnet" "polygon-mumbai" "celo-mainnet" "celo-alfajores"
owner
required
string^0x[a-fA-F0-9]{40}$

The address of the owner of the contract.

minter
string^0x[a-fA-F0-9]{40}$

The address of the minter of the contract. If not provided, the owner will be the minter.

name
required
string <= 255 characters

The name of the ERC20 token.

symbol
required
string <= 255 characters

The symbol of the ERC20 token.

contractType
required
string

The type of contract to deploy.

Value: "fungible"
initialSupply
required
string

The initial supply of the ERC20 token.

initialHolder
required
string^0x[a-fA-F0-9]{40}$

The address that will hold the initial supply of the token.

decimals
integer [ 0 .. 30 ]

The number of decimals the ERC20 token will have. If not provided, the default value is 18.

pauser
string^0x[a-fA-F0-9]{40}$

The address that can pause the token contract. If not provided, the pauser is the owner.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v1/contract/deploy
Request samples
application/json
{
  • "chain": "bsc-mainnet",
  • "owner": "string",
  • "minter": "string",
  • "name": "string",
  • "symbol": "string",
  • "contractType": "fungible",
  • "initialSupply": "string",
  • "initialHolder": "string",
  • "decimals": 30,
  • "pauser": "string"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

Deploy smart contract

This operation is used to mint NFT on existing NFT collection on the blockchain. The operation is asynchronous and returns a transaction hash. The transaction hash can be used to query the status of the transaction.
NFT will be minted as NFT Express. See more: NFT Express functionality.

SecurityX-API-Key
Request
Request Body schema: application/json
required
One of:
chain
required
string

The blockchain network where to mint NFT.

Enum: "bsc-mainnet" "bsc-testnet" "ethereum-mainnet" "ethereum-sepolia" "polygon-mainnet" "polygon-mumbai" "celo-mainnet" "celo-alfajores" "one-mainnet-s0" "one-testnet-s0" "kcs-mainnet" "kcs-testnet"
to
required
string^0x[a-fA-F0-9]{40}$

The address of the NFT receiver.

url
required
stringipfs://[a-f0-9]{60}

The URL pointing to the NFT metadata; for more information, see EIP-721

tokenId
required
string^[0-9]+$

Token Id of NFT to be minted

contractAddress
required
string^0x[a-fA-F0-9]{40}$

Smart contract address of the NFT collection

minter
string^0x[a-fA-F0-9]{40}$

The address of the minter of the contract. If not provided, the owner will be the minter.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v1/contract/erc721/mint
Request samples
application/json
{
  • "chain": "bsc-mainnet",
  • "to": "string",
  • "url": "string",
  • "tokenId": "string",
  • "contractAddress": "string",
  • "minter": "string"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

Exchange rate

The API section of exchange rates utilities.

Get the current exchange rate for exchanging fiat/crypto assets

1 credit per API call

Get the current exchange rate for exchanging fiat/crypto assets.

By default, the base pair (the target asset) is EUR. When obtaining the exchange rate for an asset (for example, BTC), the value returned by the API expresses the amount of EUR that can be currently exchanged into 1 BTC.

SecurityX-API-Key
Request
path Parameters
currency
required
string (FiatOrCryptoCurrency)

The fiat or crypto asset to exchange

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "ALGO" "ADA" "BAM" "BAT" "BBD" "BCH" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTC" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DOGE" "DZD" "EGP" "ERN" "ETB" "ETH" "EUR" "FJD" "FKP" "FLOW" "FUSD" "FREE" "GMC" "GMC_BSC" "RMD" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LEO" "LINK" "LKR" "LRD" "LSL" "LTC" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MKR" "MMK" "MMY" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PAX" "PAXG" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TRON" "TUSD" "BUSD" "TWD" "TZS" "UAH" "UGX" "UNI" "USD" "USDC" "USDT" "USDT_TRON" "USDT_MATIC" "UYU" "UZS" "VEF" "VND" "VUV" "WBTC" "WST" "XAF" "XAG" "XAU" "XCD" "XCON" "XDR" "XOF" "XPF" "XRP" "YER" "ZAR" "ZMK" "ZMW" "ZWL"
query Parameters
basePair
string (FiatCurrency)

The target fiat asset to get the exchange rate for

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DOGE" "DZD" "EGP" "ERN" "ETB" "ETH" "EUR" "FJD" "FKP" "FLOW" "FUSD" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZMW" "ZWL"
Responses
200

OK

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

get/v1/rate/{currency}
Request samples
Response samples
application/json
{
  • "id": "AED",
  • "value": "1235.56",
  • "basePair": "AED",
  • "timestamp": 1572031674384,
  • "source": "fixer.io",
  • "batchId": "one"
}

Get the current exchange rates for exchanging fiat/crypto assets

1 credit per pair per API call

Get the current exchange rates for exchanging fiat/crypto assets.

When obtaining the exchange rate for an asset (for example, BTC), the value returned by the API expresses the amount of EUR that can be currently exchanged into 1 BTC.

SecurityX-API-Key
Request
Request Body schema: application/json
required
Array
batchId
required
string

Used for identification, will be returned with result pair

basePair
required
string (FiatCurrency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DOGE" "DZD" "EGP" "ERN" "ETB" "ETH" "EUR" "FJD" "FKP" "FLOW" "FUSD" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZMW" "ZWL"
currency
required
string (FiatOrCryptoCurrency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "ALGO" "ADA" "BAM" "BAT" "BBD" "BCH" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTC" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DOGE" "DZD" "EGP" "ERN" "ETB" "ETH" "EUR" "FJD" "FKP" "FLOW" "FUSD" "FREE" "GMC" "GMC_BSC" "RMD" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LEO" "LINK" "LKR" "LRD" "LSL" "LTC" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MKR" "MMK" "MMY" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PAX" "PAXG" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TRON" "TUSD" "BUSD" "TWD" "TZS" "UAH" "UGX" "UNI" "USD" "USDC" "USDT" "USDT_TRON" "USDT_MATIC" "UYU" "UZS" "VEF" "VND" "VUV" "WBTC" "WST" "XAF" "XAG" "XAU" "XCD" "XCON" "XDR" "XOF" "XPF" "XRP" "YER" "ZAR" "ZMK" "ZMW" "ZWL"
Responses
200

OK

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v1/rate
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]