API Reference
SupportStatusSign UpLogin

Deploy a fungible token smart contract

post
https://api.tatum.io/v3/blockchain/token/deploy

/v3/blockchain/token/deploy

2 credits per API call

Deploy a fungible token smart contract on the blockchain. In a deployed smart contract, you can mint and burn fungible tokens. The whole supply of fungible tokens (the supply parameter in the request body) will be transferred to the specified blockchain address (the address parameter in the request body).

Additionally, you can specify the number of additional digits for the token amounts using the digits parameter. Please note that the maximum value for the supply parameter with added digits is within the range of uint64.

Smart contracts are standardized and audited.

This API is supported for the following blockchains:

  • Algorand
  • BNB Smart Chain
  • Celo
  • Ethereum
  • Harmony
  • Klaytn
  • KuCoin Community Chain
  • Polygon
  • Solana
  • XinFin
  • Flare
  • Cronos
  • Base
  • Avalanche
  • Fantom
  • Optimism

You can review the code of a deployed smart contract here.

Signing a transaction
When deploying a fungible token smart contract, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Type of testnet in query. The default type is based on the currency: ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, this value is ignored. The currency/chain must be specified to determine the applicable set of testnet types.

Allowed:
Body Params
string
enum
required

The blockchain to work with

string
required
length between 1 and 30

Symbol of the ERC20 token

string
required
length between 1 and 100

Name of the ERC20 token

string
length ≤ 38

Max supply of ERC20 token.

string
required
length ≤ 38

Initial supply of ERC20 token. If totalCap is not defined, this will be the total cap.

number
required
1 to 30

Number of decimal points

string
required
length between 42 and 43

Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.

string
required
length between 66 and 66

Private key of Ethereum account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.

number
≥ 0

The nonce to be set to the transaction; if not present, the last known nonce will be used

fee
object

The custom defined fee; if not present, will be calculated automatically

Headers
string
enum

Type of testnet in header. The default type is based on the currency: ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, this value is ignored. The currency/chain must be specified to determine the applicable set of testnet types.

Allowed:
Responses

Updated 13 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago