Api/FlowApi

Flow API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->flow();

// TestNet API Call
$sdk->testnet()->api()->flow();

Methods

flowAddPubKeyMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f flowAddPubKeyMnemonic.php

Request

PUT /v3/flow/account

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowAddPubKeyMnemonic(
    \Tatum\Model\FlowAddPubKeyMnemonic $flow_add_pub_key_mnemonic
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Add public key to Flow address

100 credits per API call. Tatum covers the fee connected to the transaction costs in subscription credits. This operation can be done on mainnet only for paid plans.

Add public key to existing Flow blockchain addresses. Private key for that public key can be used for signing transaction. There are two possibilites how the transaction on the blockchain can be created:

• Using mnemonic and index - private key is generated based on the index in the mnemonic.
• Using secret - private keys is entered manually. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

flowAddPubKeySecret()

Example

#️⃣ Execute command in terminal

✨ php -f flowAddPubKeySecret.php

Request

PUT /v3/flow/account

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowAddPubKeySecret(
    \Tatum\Model\FlowAddPubKeySecret $flow_add_pub_key_secret
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Add public key to Flow address

Back to top

flowAddPubKeySecretKMS()

Example

#️⃣ Execute command in terminal

✨ php -f flowAddPubKeySecretKMS.php

Request

PUT /v3/flow/account

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowAddPubKeySecretKMS(
    \Tatum\Model\FlowAddPubKeySecretKMS $flow_add_pub_key_secret_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Add public key to Flow address

Back to top

flowCreateAddressFromPubKeyKMS()

Example

#️⃣ Execute command in terminal

✨ php -f flowCreateAddressFromPubKeyKMS.php

Request

POST /v3/flow/account

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowCreateAddressFromPubKeyKMS(
    \Tatum\Model\FlowCreateAddressFromPubKeyKMS $flow_create_address_from_pub_key_kms
): \Tatum\Model\FlowCreateAddressFromPubKeyMnemonic200Response

Parameters

Return type

\Tatum\Model\FlowCreateAddressFromPubKeyMnemonic200Response

Description

Create Flow address from public key

Back to top

flowCreateAddressFromPubKeyMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f flowCreateAddressFromPubKeyMnemonic.php

Request

POST /v3/flow/account

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowCreateAddressFromPubKeyMnemonic(
    \Tatum\Model\FlowCreateAddressFromPubKeyMnemonic $flow_create_address_from_pub_key_mnemonic
): \Tatum\Model\FlowCreateAddressFromPubKeyMnemonic200Response

Parameters

Return type

\Tatum\Model\FlowCreateAddressFromPubKeyMnemonic200Response

Description

Create Flow address from public key

100 credits per API call. Tatum covers the fee connected to the transaction costs in subscription credits. This operation can be done on mainnet only for paid plans.

Create Flow blockchain addresses from public key. This will generate address on the blockchain with public key. Private key for that public key can be used for signing transaction. There are two possibilites how the transaction on the blockchain can be created:

• Using mnemonic and index - private key is generated based on the index in the mnemonic.
• Using secret - private keys is entered manually. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

flowCreateAddressFromPubKeySecret()

Example

#️⃣ Execute command in terminal

✨ php -f flowCreateAddressFromPubKeySecret.php

Request

POST /v3/flow/account

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowCreateAddressFromPubKeySecret(
    \Tatum\Model\FlowCreateAddressFromPubKeySecret $flow_create_address_from_pub_key_secret
): \Tatum\Model\FlowCreateAddressFromPubKeyMnemonic200Response

Parameters

Return type

\Tatum\Model\FlowCreateAddressFromPubKeyMnemonic200Response

Description

Create Flow address from public key

Back to top

flowCustomTransactionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f flowCustomTransactionKMS.php

Request

POST /v3/flow/transaction/custom

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowCustomTransactionKMS(
    \Tatum\Model\FlowCustomTransactionKMS $flow_custom_transaction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send arbitrary transaction to blockchain

Back to top

flowCustomTransactionMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f flowCustomTransactionMnemonic.php

Request

POST /v3/flow/transaction/custom

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowCustomTransactionMnemonic(
    \Tatum\Model\FlowCustomTransactionMnemonic $flow_custom_transaction_mnemonic
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send arbitrary transaction to blockchain

100 credits per API call.

Send arbitrary blockchain transaction to FLOW blockchain. Tatum covers the fee connected to the transaction costs in subscription credits. This operation can be done on mainnet only for paid plans. There are two possibilites how the transaction on the blockchain can be created:

• Using mnemonic and index - private key is generated based on the index in the mnemonic.
• Using secret - private keys is entered manually. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

flowCustomTransactionPK()

Example

#️⃣ Execute command in terminal

✨ php -f flowCustomTransactionPK.php

Request

POST /v3/flow/transaction/custom

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowCustomTransactionPK(
    \Tatum\Model\FlowCustomTransactionPK $flow_custom_transaction_pk
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send arbitrary transaction to blockchain

Back to top

flowGenerateAddress()

Example

#️⃣ Execute command in terminal

✨ php -f flowGenerateAddress.php

Request

GET /v3/flow/address/{xpub}/{index}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGenerateAddress(
    string $xpub,
    float $index
): \Tatum\Model\FlowGenerateAddress200Response

Parameters

Return type

\Tatum\Model\FlowGenerateAddress200Response

Description

Generate Flow address from Extended public key

1 credit for GET operation + 3000 credits per address.

Generate Flow address from Extended public key. This operation internally creates public key and assings it to the newly created address on the blockchain. There is minimal amount, which must be sent to the FLOW address during creation - 0.001 FLOW, which will be used from Tatum service account.This operation is allowed on any Testnet plan and only on Paid Mainnet plans. Public key is generated for the specific index - each extended public key can generate up to 2^31 addresses starting from index 0 until 2^31 - 1.

Back to top

flowGeneratePubKey()

Example

#️⃣ Execute command in terminal

✨ php -f flowGeneratePubKey.php

Request

GET /v3/flow/pubkey/{xpub}/{index}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGeneratePubKey(
    string $xpub,
    float $index
): \Tatum\Model\FlowGeneratePubKey200Response

Parameters

Return type

\Tatum\Model\FlowGeneratePubKey200Response

Description

Generate Flow public key from Extended public key

1 credit per API call.

Generate Flow public key from Extended public key. This key is added to the address on the blockchain and can control the funds there. Public key is generated for the specific index - each extended public key can generate up to 2^31 addresses starting from index 0 until 2^31 - 1.

Back to top

flowGeneratePubKeyPrivateKey()

Example

#️⃣ Execute command in terminal

✨ php -f flowGeneratePubKeyPrivateKey.php

Request

POST /v3/flow/wallet/priv

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGeneratePubKeyPrivateKey(
    \Tatum\Model\PrivKeyRequest $priv_key_request
): \Tatum\Model\PrivKey

Parameters

Return type

\Tatum\Model\PrivKey

Description

Generate Flow private key

2 credits per API call.

Generate private key for address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic can generate up to 2^32 private keys starting from index 0 until 2^31 - 1.

Back to top

flowGenerateWallet()

Example

#️⃣ Execute command in terminal

✨ php -f flowGenerateWallet.php

Request

GET /v3/flow/wallet

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGenerateWallet(
    [ string $mnemonic ]
): \Tatum\Model\Wallet

Parameters

Return type

\Tatum\Model\Wallet

Description

Generate Flow wallet

1 credit per API call.

Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys. Each address is identified by 3 main values:

• Private Key - your secret value, which should never be revealed
• Public Key - public address to be published
• Derivation index - index of generated address

Tatum follows BIP44 specification and generates for Dogecoin wallet with derivation path m’/44’/3’/0’/0. More about BIP44 HD wallets can be found here - https://github.com/litecoin/bips/blob/master/bip-0044.mediawiki. Generate BIP44 compatible Dogecoin wallet.

Back to top

flowGetAccount()

Example

#️⃣ Execute command in terminal

✨ php -f flowGetAccount.php

Request

GET /v3/flow/account/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGetAccount(
    string $address
): \Tatum\Model\FlowAccount

Parameters

Return type

\Tatum\Model\FlowAccount

Description

Get the balance of a Flow account

1 credit per API call.

Get Flow account details.

Back to top

flowGetBlock()

Example

#️⃣ Execute command in terminal

✨ php -f flowGetBlock.php

Request

GET /v3/flow/block/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGetBlock(
    string $hash
): \Tatum\Model\FlowBlock

Parameters

Return type

\Tatum\Model\FlowBlock

Description

Get Flow Block by hash or height

1 credit per API call.

Get Flow Block detail by block hash or height.

Back to top

flowGetBlockChainInfo()

Example

#️⃣ Execute command in terminal

✨ php -f flowGetBlockChainInfo.php

Request

GET /v3/flow/block/current

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGetBlockChainInfo(): float

Parameters

This endpoint does not need any parameter.

Return type

float

Description

Get Flow current block number

1 credit per API call.

Get Flow current block number.

Back to top

flowGetBlockEvents()

Example

#️⃣ Execute command in terminal

✨ php -f flowGetBlockEvents.php

Request

GET /v3/flow/block/events

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGetBlockEvents(
    string $type,
    float $from,
    float $to
): \Tatum\Model\FlowEvent[]

Parameters

Return type

\Tatum\Model\FlowEvent[]

Description

Get Flow events from blocks

1 credit per API call.

Get Flow events from block.

Back to top

flowGetRawTransaction()

Example

#️⃣ Execute command in terminal

✨ php -f flowGetRawTransaction.php

Request

GET /v3/flow/transaction/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowGetRawTransaction(
    string $hash
): \Tatum\Model\FlowTx

Parameters

Return type

\Tatum\Model\FlowTx

Description

Get Flow Transaction by hash

1 credit per API call.

Get Flow Transaction detail by transaction hash.

Back to top

flowTransactionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f flowTransactionKMS.php

Request

POST /v3/flow/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowTransactionKMS(
    \Tatum\Model\FlowTransactionKMS $flow_transaction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send Flow to blockchain addresses

Back to top

flowTransactionMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f flowTransactionMnemonic.php

Request

POST /v3/flow/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowTransactionMnemonic(
    \Tatum\Model\FlowTransactionMnemonic $flow_transaction_mnemonic
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send Flow to blockchain addresses

100 credits per API call.

Send Flow or FUSD to blockchain addresses. Tatum covers the fee connected to the transaction costs in subscription credits. This operation can be done on mainnet only for paid plans. There are two possibilites how the transaction on the blockchain can be created:

• Using mnemonic and index - private key is generated based on the index in the mnemonic.
• Using secret - private keys is entered manually. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

flowTransactionPK()

Example

#️⃣ Execute command in terminal

✨ php -f flowTransactionPK.php

Request

POST /v3/flow/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->flow()->flowTransactionPK(
    \Tatum\Model\FlowTransactionPK $flow_transaction_pk
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send Flow to blockchain addresses

Back to top