Tatum API Reference (3.12.0)

Download OpenAPI specification:Download

Welcome to the Tatum API Reference!

What is Tatum?

Tatum offers a flexible framework to build, run, and scale blockchain apps fast. To learn more about the Tatum blockchain development framework, visit our website.

The Tatum API features powerful endpoints that simplify a complex blockchain into single API requests. Code for all supported blockchains using unified API calls.

Need help?

To chat with other developers, get help from the Support team, and engage with the thriving Tatum community, join our Discord server. For more information about how to work with Tatum, review the online documentation.

About this API Reference

The Tatum API Reference is based on OpenAPI Specification v3.1.0 with a few vendor extensions applied.

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.
    • The number of API calls per month is not limited.

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

    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.

    • You get 10,000,000 credits to spend on API calls within a month.

      The number of credits is reset on the first day of a month. The unused credits from the current month are not rolled over to the next month.

    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-eu1.tatum.io/v3/ledger/account?type=testnet

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