Api/VeChainApi

VeChain API Reference

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

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

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

Methods

Method	Description
transferVetBlockchain()	Send VeChain from account to account
transferVetBlockchainKMS()	Send VeChain from account to account
vetBroadcast()	Broadcast signed VeChain transaction
vetGenerateAddress()	Generate VeChain account address from Extended public key
vetGenerateAddressPrivateKey()	Generate VeChain private key
vetGenerateWallet()	Generate VeChain wallet
vetGetBalance()	Get VeChain Account balance
vetGetBlock()	Get VeChain Block by hash
vetGetCurrentBlock()	Get VeChain current block
vetGetEnergy()	Get VeChain Account energy (VTHO)
vetGetTransaction()	Get VeChain Transaction
vetGetTransactionReceipt()	Get VeChain Transaction Receipt

`transferVetBlockchain()`

Example

#️⃣ Execute command in terminal

✨ php -f transferVetBlockchain.php

Request

POST /v3/vet/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->transferVetBlockchain(
    \Tatum\Model\TransferVetBlockchain $transfer_vet_blockchain
): \Tatum\Model\TransactionHash

Parameters

Name	Type	Description	Notes
$transfer_vet_blockchain	\Tatum\Model\TransferVetBlockchain

Return type

\Tatum\Model\TransactionHash

Description

Send VeChain from account to account

10 credits per API call.

Send VET from account to account. Fee for the transaction is paid in VTHO. 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 loss of 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.

`transferVetBlockchainKMS()`

Example

#️⃣ Execute command in terminal

✨ php -f transferVetBlockchainKMS.php

Request

POST /v3/vet/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->transferVetBlockchainKMS(
    \Tatum\Model\TransferVetBlockchainKMS $transfer_vet_blockchain_kms
): \Tatum\Model\TransactionHash

Parameters

Name	Type	Description	Notes
$transfer_vet_blockchain_kms	\Tatum\Model\TransferVetBlockchainKMS

Return type

\Tatum\Model\TransactionHash

Description

Send VeChain from account to account

`vetBroadcast()`

Example

#️⃣ Execute command in terminal

✨ php -f vetBroadcast.php

Request

POST /v3/vet/broadcast

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetBroadcast(
    \Tatum\Model\BroadcastKMS $broadcast_kms
): \Tatum\Model\TransactionHash

Parameters

Name	Type	Description	Notes
$broadcast_kms	\Tatum\Model\BroadcastKMS

Return type

\Tatum\Model\TransactionHash

Description

Broadcast signed VeChain transaction

5 credits per API call.

Broadcast signed transaction to VeChain blockchain. This method is used internally from Tatum KMS or Tatum client libraries. It is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.

`vetGenerateAddress()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGenerateAddress.php

Request

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

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetGenerateAddress(
    string $xpub,
    float $index
): \Tatum\Model\VetGenerateAddress200Response

Parameters

Name	Type	Description	Notes
$xpub	string	Extended public key of wallet.
$index	float	Derivation index of desired address to be generated.

Return type

\Tatum\Model\VetGenerateAddress200Response

Description

Generate VeChain account address from Extended public key

5 credits per API call.

Generate VeChain account deposit address from Extended public key. Deposit address 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.

`vetGenerateAddressPrivateKey()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGenerateAddressPrivateKey.php

Request

POST /v3/vet/wallet/priv

Type signature

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

Parameters

Name	Type	Description	Notes
$priv_key_request	\Tatum\Model\PrivKeyRequest

Return type

\Tatum\Model\PrivKey

Description

Generate VeChain private key

5 credits per API call.

Generate private key of 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.

`vetGenerateWallet()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGenerateWallet.php

Request

GET /v3/vet/wallet

Type signature

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

Parameters

Name	Type	Description	Notes
$mnemonic	string	Mnemonic to use for generation of extended public and private keys.	[optional]

Return type

\Tatum\Model\Wallet

Description

Generate VeChain wallet

5 credits 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 VeChain wallet with derivation path m’/44’/818’/0’/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. Generate BIP44 compatible VeChain wallet.

`vetGetBalance()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGetBalance.php

Request

GET /v3/vet/account/balance/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetGetBalance(
    string $address
): \Tatum\Model\VetGetBalance200Response

Parameters

Name	Type	Description	Notes
$address	string	Account address you want to get balance of

Return type

\Tatum\Model\VetGetBalance200Response

Description

Get VeChain Account balance

5 credits per API call.

Get VeChain Account balance in VET.

`vetGetBlock()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGetBlock.php

Request

GET /v3/vet/block/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetGetBlock(
    string $hash
): \Tatum\Model\VetBlock

Parameters

Name	Type	Description	Notes
$hash	string	Block hash or block number

Return type

\Tatum\Model\VetBlock

Description

Get VeChain Block by hash

5 credits per API call.

Get VeChain Block by block hash or block number.

`vetGetCurrentBlock()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGetCurrentBlock.php

Request

GET /v3/vet/block/current

Type signature

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

Parameters

This endpoint does not need any parameter.

Return type

float

Description

Get VeChain current block

5 credits per API call.

Get VeChain current block number.

`vetGetEnergy()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGetEnergy.php

Request

GET /v3/vet/account/energy/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetGetEnergy(
    string $address
): \Tatum\Model\VetGetEnergy200Response

Parameters

Name	Type	Description	Notes
$address	string	Account address you want to get balance of

Return type

\Tatum\Model\VetGetEnergy200Response

Description

Get VeChain Account energy (VTHO)

5 credits per API call.

Get VeChain Account energy in VTHO. VTHO is used for paying for the transaction fee.

`vetGetTransaction()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGetTransaction.php

Request

GET /v3/vet/transaction/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetGetTransaction(
    string $hash
): \Tatum\Model\VetTx

Parameters

Name	Type	Description	Notes
$hash	string	Transaction hash

Return type

\Tatum\Model\VetTx

Description

Get VeChain Transaction

10 credits per API call.

Get VeChain Transaction by transaction hash.

`vetGetTransactionReceipt()`

Example

#️⃣ Execute command in terminal

✨ php -f vetGetTransactionReceipt.php

Request

GET /v3/vet/transaction/{hash}/receipt

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->veChain()->vetGetTransactionReceipt(
    string $hash
): \Tatum\Model\VetTxReceipt

Parameters

Name	Type	Description	Notes
$hash	string	Transaction hash

Return type

\Tatum\Model\VetTxReceipt

Description

Get VeChain Transaction Receipt

5 credits per API call.

Get VeChain Transaction Receipt by transaction hash. Transaction receipt is available only after transaction is included in the block and contains information about paid fee or created contract address and much more.