Api/StellarApi
// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();
// MainNet API Call
$sdk->mainnet()->api()->stellar();
// TestNet API Call
$sdk->testnet()->api()->stellar();
Methods
| Method | Description |
|---|---|
| transferXlmBlockchain() | Send XLM from address to address |
| transferXlmBlockchainAsset() | Send XLM from address to address |
| transferXlmBlockchainKMS() | Send XLM from address to address |
| transferXlmBlockchainKMSAsset() | Send XLM from address to address |
| trustLineXlmBlockchain() | Create / Update / Delete XLM trust line |
| trustLineXlmBlockchainKMS() | Create / Update / Delete XLM trust line |
| xlmBroadcast() | Broadcast signed XLM transaction |
| xlmGetAccountInfo() | Get XLM Account info |
| xlmGetAccountTx() | Get XLM Account transactions |
| xlmGetFee() | Get actual XLM fee |
| xlmGetLastClosedLedger() | Get XLM Blockchain Information |
| xlmGetLedger() | Get XLM Blockchain Ledger by sequence |
| xlmGetLedgerTx() | Get XLM Blockchain Transactions in Ledger |
| xlmGetTransaction() | Get XLM Transaction by hash |
| xlmWallet() | Generate XLM account |
transferXlmBlockchain()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/transaction
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->transferXlmBlockchain(
\Tatum\Model\TransferXlmBlockchain $transfer_xlm_blockchain
): \Tatum\Model\TransactionSigned
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $transfer_xlm_blockchain | \Tatum\Model\TransferXlmBlockchain |
Return type
\Tatum\Model\TransactionSigned
Description
Send XLM from address to address
10 credits per API call.
Send XLM from account to account. It is possbile to send native XLM asset, or any other custom asset present on the network. 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.
transferXlmBlockchainAsset()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/transaction
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->transferXlmBlockchainAsset(
\Tatum\Model\TransferXlmBlockchainAsset $transfer_xlm_blockchain_asset
): \Tatum\Model\TransactionSigned
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $transfer_xlm_blockchain_asset | \Tatum\Model\TransferXlmBlockchainAsset |
Return type
\Tatum\Model\TransactionSigned
Description
Send XLM from address to address
transferXlmBlockchainKMS()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/transaction
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->transferXlmBlockchainKMS(
\Tatum\Model\TransferXlmBlockchainKMS $transfer_xlm_blockchain_kms
): \Tatum\Model\TransactionSigned
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $transfer_xlm_blockchain_kms | \Tatum\Model\TransferXlmBlockchainKMS |
Return type
\Tatum\Model\TransactionSigned
Description
Send XLM from address to address
transferXlmBlockchainKMSAsset()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/transaction
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->transferXlmBlockchainKMSAsset(
\Tatum\Model\TransferXlmBlockchainKMSAsset $transfer_xlm_blockchain_kms_asset
): \Tatum\Model\TransactionSigned
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $transfer_xlm_blockchain_kms_asset | \Tatum\Model\TransferXlmBlockchainKMSAsset |
Return type
\Tatum\Model\TransactionSigned
Description
Send XLM from address to address
trustLineXlmBlockchain()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/trust
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->trustLineXlmBlockchain(
\Tatum\Model\TrustLineXlmBlockchain $trust_line_xlm_blockchain
): \Tatum\Model\TransactionSigned
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $trust_line_xlm_blockchain | \Tatum\Model\TrustLineXlmBlockchain |
Return type
\Tatum\Model\TransactionSigned
Description
Create / Update / Delete XLM trust line
10 credits per API call.
Create / Update / Delete XLM trust line between accounts to transfer private assets. By creating trustline for the first time, the asset is created automatically and can be used in the transactions. 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.
trustLineXlmBlockchainKMS()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/trust
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->trustLineXlmBlockchainKMS(
\Tatum\Model\TrustLineXlmBlockchainKMS $trust_line_xlm_blockchain_kms
): \Tatum\Model\TransactionSigned
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $trust_line_xlm_blockchain_kms | \Tatum\Model\TrustLineXlmBlockchainKMS |
Return type
\Tatum\Model\TransactionSigned
Description
Create / Update / Delete XLM trust line
xlmBroadcast()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/xlm/broadcast
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmBroadcast(
\Tatum\Model\BroadcastKMS $broadcast_kms
): \Tatum\Model\TransactionHash
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $broadcast_kms | \Tatum\Model\BroadcastKMS |
Return type
Description
Broadcast signed XLM transaction
5 credits per API call.
Broadcast signed transaction to XLM 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.
xlmGetAccountInfo()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/account/{account}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetAccountInfo(
string $account
): \Tatum\Model\XlmAccount
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $account | string | Account address you want to get balance of |
Return type
Description
Get XLM Account info
5 credits per API call.
Get XLM Account detail.
xlmGetAccountTx()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/account/tx/{account}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetAccountTx(
string $account,
[ string $pagination ]
): \Tatum\Model\XlmTx[]
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $account | string | Address of XLM account. | |
| $pagination | string | Paging token from the last transaction gives you next page | [optional] |
Return type
Description
Get XLM Account transactions
5 credits per API call.
List all XLM account transactions.
xlmGetFee()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/fee
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetFee(): float
Parameters
This endpoint does not need any parameter.
Return type
float
Description
Get actual XLM fee
5 credits per API call.
Get XLM Blockchain fee in 1/10000000 of XLM (stroop)
xlmGetLastClosedLedger()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/info
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetLastClosedLedger(): \Tatum\Model\XlmLedger
Parameters
This endpoint does not need any parameter.
Return type
Description
Get XLM Blockchain Information
5 credits per API call.
Get XLM Blockchain last closed ledger.
xlmGetLedger()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/ledger/{sequence}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetLedger(
string $sequence
): \Tatum\Model\XlmLedger
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $sequence | string | Sequence of the ledger. |
Return type
Description
Get XLM Blockchain Ledger by sequence
5 credits per API call.
Get XLM Blockchain ledger for ledger sequence.
xlmGetLedgerTx()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/ledger/{sequence}/transaction
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetLedgerTx(
string $sequence
): \Tatum\Model\XlmTx[]
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $sequence | string | Sequence of the ledger. |
Return type
Description
Get XLM Blockchain Transactions in Ledger
5 credits per API call.
Get XLM Blockchain transactions in the ledger.
xlmGetTransaction()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/transaction/{hash}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmGetTransaction(
string $hash
): \Tatum\Model\XlmTx
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $hash | string | Transaction hash |
Return type
Description
Get XLM Transaction by hash
5 credits per API call.
Get XLM Transaction by transaction hash.
xlmWallet()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/xlm/account
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->stellar()->xlmWallet(): \Tatum\Model\XlmWallet
Parameters
This endpoint does not need any parameter.
Return type
Description
Generate XLM account
5 credits per API call.
Generate XLM account. Tatum does not support HD wallet for XLM, only specific address and private key can be generated.