Tatum
Powered by Redocly

Stellar

XLM Blockchain enables access to the most commonly used XLM methods. These methods bring a small level of abstraction and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger to connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
Examples of working with the Stellar blockchain can be found in Tatum XLM SDK.
Tatum supports 2 chains:


In order to start using the XLM blockchain, we first need to create an XLM account. In order to have the account activated, it must be credited with 0.5 XLM. Because of this requirement, it is common to use one account for all customers and differentiate them using a memo - a short text/number included in every transaction as an account distinguisher.
When an off-chain deposit address is created for the ledger account, a memo is generated, e.g. 12345 for that account. When a transaction to the blockchain is performed, it should contain the address of the recipient and the memo as an account distinguisher.

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.

SecurityX-API-Key
Responses
200

OK

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

get/v3/xlm/account
Request samples 
Response samples 
application/json
{
  • "address": "GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT",
  • "secret": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED"
}
Get XLM Blockchain Information
5 credits per API call.

Get XLM Blockchain last closed ledger.
SecurityX-API-Key 
Responses 
200
OK


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/info
Request samples 
Response samples 
application/json
{
  • "id": "63d98f536ee68d1b27b5b89f23af5311b7569a24faf1403ad0b52b633b07be99",
  • "paging_token": "4294967296",
  • "hash": "63d98f536ee68d1b27b5b89f23af5311b7569a24faf1403ad0b52b633b07be99",
  • "sequence": 1,
  • "successful_transaction_count": 0,
  • "failed_transaction_count": 0,
  • "operation_count": 0,
  • "closed_at": "1970-01-01T00:00:00Z",
  • "total_coins": "100000000000.0000000",
  • "fee_pool": "0.0000000",
  • "base_fee_in_stroops": 100,
  • "base_reserve_in_stroops": 100000000,
  • "max_tx_set_size": 100,
  • "protocol_version": 0,
  • "header_xdr": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABXKi4y/ySKB7DnD9H20xjB+s0gtswIwz1XdSWYaBJaFgAAAAEN4Lazp2QAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZAX14QAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
Get XLM Blockchain Ledger by sequence
5 credits per API call.

Get XLM Blockchain ledger for ledger sequence.
SecurityX-API-Key 
Request 
path Parameters
sequence
required
string
Sequence of the ledger.


 
 Example:  1
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/ledger/{sequence}
Request samples 
Response samples 
application/json
{
  • "id": "63d98f536ee68d1b27b5b89f23af5311b7569a24faf1403ad0b52b633b07be99",
  • "paging_token": "4294967296",
  • "hash": "63d98f536ee68d1b27b5b89f23af5311b7569a24faf1403ad0b52b633b07be99",
  • "sequence": 1,
  • "successful_transaction_count": 0,
  • "failed_transaction_count": 0,
  • "operation_count": 0,
  • "closed_at": "1970-01-01T00:00:00Z",
  • "total_coins": "100000000000.0000000",
  • "fee_pool": "0.0000000",
  • "base_fee_in_stroops": 100,
  • "base_reserve_in_stroops": 100000000,
  • "max_tx_set_size": 100,
  • "protocol_version": 0,
  • "header_xdr": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABXKi4y/ySKB7DnD9H20xjB+s0gtswIwz1XdSWYaBJaFgAAAAEN4Lazp2QAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZAX14QAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
Get XLM Blockchain Transactions in Ledger
5 credits per API call.

Get XLM Blockchain transactions in the ledger.
SecurityX-API-Key 
Request 
path Parameters
sequence
required
string
Sequence of the ledger.


 
 Example:  1
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/ledger/{sequence}/transaction
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get actual XLM fee
5 credits per API call.

Get XLM Blockchain fee in 1/10000000 of XLM (stroop)
SecurityX-API-Key 
Responses 
200
OK


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/fee
Request samples 
Response samples 
application/json
100
Get XLM Account transactions
5 credits per API call.

List all XLM account transactions.
SecurityX-API-Key 
Request 
path Parameters
account
required
string
Address of XLM account.


 
 Example:  GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H
query Parameters
pagination
string
Paging token from the last transaction gives you next page


 
 Example:  pagination=1348087155011584
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/account/tx/{account}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get XLM Transaction by hash
5 credits per API call.

Get XLM Transaction by transaction hash.
SecurityX-API-Key 
Request 
path Parameters
hash
required
string
Transaction hash


 
 Example:  749e4f8933221b9942ef38a02856803f379789ec8d971f1f60535db70135673e
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/transaction/{hash}
Request samples 
Response samples 
application/json
{
  • "id": "749e4f8933221b9942ef38a02856803f379789ec8d971f1f60535db70135673e",
  • "paging_token": "438086668288",
  • "successful": true,
  • "hash": "749e4f8933221b9942ef38a02856803f379789ec8d971f1f60535db70135673e",
  • "ledger": 102,
  • "created_at": "2019-10-30T09:34:07Z",
  • "source_account": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
  • "source_account_sequence": "1",
  • "fee_paid": 1000,
  • "fee_charged": 1000,
  • "max_fee": 1000,
  • "operation_count": 10,
  • "envelope_xdr": "AAAAAGL8HQvQkbK2HA3WVjRrKmjX00fG8sLI7m0ERwJW/AX3AAAD6AAAAAAAAAABAAAAAAAAAAAAAAAKAAAAAAAAAAAAAAAAEH3Rayw4M0iCLoEe96rPFNGYim8AVHJU0z4ebYZW4JwBY0V4XYoAAAAAAAAAAAAAAAAAAN2+SherpNcNX0imC680fIBdpQfgBwIuqFOgmlobpwLJAAAAF0h26AAAAAAAAAAAAAAAAAAAlRt2go9sp7E1a5ZWvr7vin4UPrFQThpQax1lOFm33AAAABdIdugAAAAAAAAAAAAAAAAAmv+knlR6JR2VqWeU0k/4FgvZ/tSV5DEY4gu0iOTKgpUAAAAXSHboAAAAAAAAAAAAAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAF0h26AAAAAABAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAABgAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bf/////////8AAAABAAAAAJr/pJ5UeiUdlalnlNJP+BYL2f7UleQxGOILtIjkyoKVAAAABgAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bf/////////8AAAABAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAAQAAAAAAlRt2go9sp7E1a5ZWvr7vin4UPrFQThpQax1lOFm33AAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAJGE5yoAAAAAABAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAAQAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAJGE5yoAAAAAAAAAAAAAAAAABKBB+2UBMP/abwcm/M1TXO+/JQWhPwkalgqizKmXyRIQx9cN3sY5YAAAAAAAAAAARW/AX3AAAAQDX5vrTLWyUxzrvpeEghwlfZYjb8PhnV+vjXAQE+iCNotx2S0qDtnNppNy9p0qlsXtKKyZqn036kHMFGQ7RxBQ3GYc0bAAAAQOquRvJeUiQ8uDcNGUnIxXT0xaHe91JZHCVjPEm6j9Biii954p9o7Muer9B9ipn6O4Y+4oiF9NbUxyeqh1VJnQw4WbfcAAAAQG/GEctb+uefyEvdeP8V61fCvvdGCW7KoH7iLXxtvanGk9CyydtRGEIxu66hPdUKKbXpXPEKWvnAAp5V+XQqjQnkyoKVAAAAQNTyKwB94kyBjjczpFwMFVtbhHtugo+DYeQKN13jQUjWQDSgistLE+TDrxlxW0qiIhl/GkOdVLMtG6YhfZeVOQU=",
  • "result_xdr": "AAAAAAAAA+gAAAAAAAAACgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAABAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
  • "result_meta_xdr": "AAAAAQAAAAAAAAAKAAAAAwAAAAMAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9w3gtrOnY/wYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cTtJ2fwYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAAAAAAAQfdFrLDgzSIIugR73qs8U0ZiKbwBUclTTPh5thlbgnAFjRXhdigAAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXE7Sdn8GAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXEkAWMUGAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZgAAAAAAAAAA3b5KF6uk1w1fSKYLrzR8gF2lB+AHAi6oU6CaWhunAskAAAAXSHboAAAAAGYAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAADAAAAAwAAAGYAAAAAAAAAAGL8HQvQkbK2HA3WVjRrKmjX00fG8sLI7m0ERwJW/AX3DH1xJAFjFBgAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAGYAAAAAAAAAAGL8HQvQkbK2HA3WVjRrKmjX00fG8sLI7m0ERwJW/AX3DH1xDLjsLBgAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGYAAAAAAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAF0h26AAAAABmAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAMAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cQy47CwYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cPVwdUQYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAAAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAABdIdugAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXD1cHVEGAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXDeJ/5cGAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZgAAAAAAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAAXSHboAAAAAGYAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAADAAAAAwAAAGYAAAAAAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAF0h26AAAAABmAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAGYAAAAAAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAF0h26AAAAABmAAAAAAAAAAEAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGYAAAABAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAAVRFU1QAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAAAAAAAAH//////////AAAAAQAAAAAAAAAAAAAAAwAAAAMAAABmAAAAAAAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAABdIdugAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAABdIdugAAAAAZgAAAAAAAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAQAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAAAAAAAB//////////wAAAAEAAAAAAAAAAAAAAAIAAAADAAAAZgAAAAEAAAAAAJUbdoKPbKexNWuWVr6+74p+FD6xUE4aUGsdZThZt9wAAAABVEVTVAAAAADaWli6I7jrXwtHJjIfg70E3zw65H14W5UE3RV6xmHNGwAAAAAAAAAAf/////////8AAAABAAAAAAAAAAAAAAABAAAAZgAAAAEAAAAAAJUbdoKPbKexNWuWVr6+74p+FD6xUE4aUGsdZThZt9wAAAABVEVTVAAAAADaWli6I7jrXwtHJjIfg70E3zw65H14W5UE3RV6xmHNGwAACRhOcqAAf/////////8AAAABAAAAAAAAAAAAAAACAAAAAwAAAGYAAAABAAAAAJr/pJ5UeiUdlalnlNJP+BYL2f7UleQxGOILtIjkyoKVAAAAAVRFU1QAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAAAAAAAAH//////////AAAAAQAAAAAAAAAAAAAAAQAAAGYAAAABAAAAAJr/pJ5UeiUdlalnlNJP+BYL2f7UleQxGOILtIjkyoKVAAAAAVRFU1QAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAkYTnKgAH//////////AAAAAQAAAAAAAAAAAAAAAwAAAAMAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cN4n/lwYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wAAAAA7msYYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAAAAAABKBB+2UBMP/abwcm/M1TXO+/JQWhPwkalgqizKmXyRIQx9cN3sY5YAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==",
  • "fee_meta_xdr": "AAAAAgAAAAMAAAABAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9w3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9w3gtrOnY/wYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==",
  • "memo": "12345",
  • "memo_type": "MEMO_TEXT",
  • "signatures": [
    ]
}
Get XLM Account info
5 credits per API call.

Get XLM Account detail.
SecurityX-API-Key 
Request 
path Parameters
account
required
string
Account address you want to get balance of


 
 Example:  GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/xlm/account/{account}
Request samples 
Response samples 
application/json
{
  • "id": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
  • "account_id": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
  • "sequence": "1",
  • "subentry_count": 0,
  • "last_modified_ledger": 102,
  • "thresholds": {
    },
  • "flags": {
    },
  • "balances": [
    ],
  • "signers": [
    ],
  • "data": { }
}
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.



SecurityX-API-Key 
Request 
Request Body schema: application/json
One of:
fromAccount
required
string  = 56 characters 
Blockchain account to send assets from


 
to
required
string  = 56 characters 
Blockchain address to send assets


 
amount
required
string^[+]?((\d+(\.\d*)?)|(\.\d+))$
Amount to be sent, in XLM.


 
fromSecret
required
string  = 56 characters 
Secret for account. Secret, or signature Id must be present.


 
initialize
boolean
 Default:  false
Set to true, if the destination address is not yet initialized and should be funded for the first time.


 
message
string  <= 64 characters ^[ -~]{0,64}$
Short message to recipient. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number.


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


post/v3/xlm/transaction
Request samples 
application/json
{
  • "fromAccount": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
  • "to": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
  • "amount": "10000",
  • "fromSecret": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
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.



SecurityX-API-Key 
Request 
Request Body schema: application/json
One of:
fromAccount
required
string  = 56 characters 
XLM account address. Must be the one used for generating deposit tags.


 
issuerAccount
required
string  = 56 characters 
Blockchain address of the issuer of the assets to create trust line for.


 
token
required
string  [ 1 .. 12 ] characters ^[a-zA-Z0-9]{1,12}$
Asset name.


 
fromSecret
required
string  = 56 characters 
Secret for account. Secret, or signature Id must be present.


 
limit
string^[+]?((\d+(\.\d*)?)|(\.\d+))$
Amount of the assets to be permitted to send over this trust line. 0 means deletion of the trust line. When no limit is specified, maximum amount available is permitted.


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


post/v3/xlm/trust
Request samples 
application/json
{
  • "fromAccount": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
  • "issuerAccount": "GC5LAVZ5UPLIFDH6SI33PNVL5TKWA4ODXTI3WEF5JM6LRM5MNGVJ56TT",
  • "token": "TOKEN123",
  • "fromSecret": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
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.


SecurityX-API-Key 
Request 
Request Body schema: application/json
txData
required
string  [ 1 .. 500000 ] characters 
Raw signed transaction to be published to network.


 
signatureId
string <uuid> 
ID of prepared payment template to sign. Required only, when broadcasting transaction signed by Tatum KMS.


 
index
number  [ 0 .. 2147483647 ] 
(Only if the signature ID is mnemonic-based and you run KMS v6.2 or later) The index of the address to send the assets from that was generated from the mnemonic


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


post/v3/xlm/broadcast
Request samples 
application/json
{
  • "txData": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
➔ Next to Tron