Tatum
Powered by Redocly

Neo

NEO Blockchain enables access to the most commonly used NEO methods. Tatum does not support off-chain capabilities for the NEO blockchain. Tatum KMS is not supported for NEO transactions. NEO supports 2 native assets - NEO and GAS. GAS is used for paying transaction fees.
Tatum supports 2 chains:

  • Mainnet - a regular live chain
  • Testnet - a chain used for testing purposes. Coins on the test chain have no value and can be obtained from a faucet, e.g. http://neo.mywish.io/

Generate NEO account

5 credits per API call.


Generate NEO account. Tatum does not support HD wallet for NEO, 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.

500

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

get/v3/neo/wallet
Request samples
curl -i -X GET \
  https://api-eu1.tatum.io/v3/neo/wallet \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "privateKey": "0ee69b443c740982e31ac64f8ab06006c24b7aab9e6ebe81b4663eafc72e13c9",
  • "address": "Abfm15QX2JCjtHPsgBwiHwMcZXWofUwCLZ"
}

Get current NEO block

5 credits per API call.


Get current NEO block.

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/neo/block/current
Request samples
curl -i -X GET \
  https://api-eu1.tatum.io/v3/neo/block/current \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
654321

Get NEO block

5 credits per API call.


Get NEO block by hash or height.

SecurityX-API-Key
Request
path Parameters
hash
required
string

Block hash or height.

Example: 0xc32b61db088e9fe20acd592ebd06f5ccde5726b17f31633dca2909a646109e07
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/neo/block/{hash}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/block/{hash}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "hash": "0xc32b61db088e9fe20acd592ebd06f5ccde5726b17f31633dca2909a646109e07",
  • "size": 686,
  • "version": 0,
  • "previousblockhash": "0xc2705a7e34b7068bcad2efbc963408c990a25ef285144ae09d89d6c2e57ac2b8",
  • "merkleroot": "0x521e0666d2abc6f4154cb29542f5e39d8be5a797638ae6caa2e606e962dba447",
  • "time": 1574492311,
  • "index": 3467078,
  • "nonce": "d41900f603da3d01",
  • "nextconsensus": "AUNSizuErA3dv1a2ag2ozvikkQS7hhPY1X",
  • "script": {
    },
  • "tx": [
    ],
  • "confirmations": 86,
  • "nextblockhash": "0x1e259632dfa77665a9ce0789143dc4fe32a559b183b26370c8e8d7ab9d75526c"
}

Get NEO Account balance

5 credits per API call.


Get Balance of all assets (NEO, GAS, etc.) and tokens for the Account.

SecurityX-API-Key
Request
path Parameters
address
required
string

Address to get balance

Example: AKL19WwiJ2fiTDkAnYQ7GJSTUBoJPTQKhn
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/neo/account/balance/{address}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/account/balance/{address}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "address": "AKL19WwiJ2fiTDkAnYQ7GJSTUBoJPTQKhn",
  • "assets": {
    },
  • "tokens": { }
}

Get Neo Asset details

5 credits per API call.


Get information about asset.

SecurityX-API-Key
Request
path Parameters
asset
required
string

Asset ID

Example: 0x602c79718b16e442de58778e148d0b1084e3b2dffd5de6b7b16cee7969282de7
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/neo/asset/{asset}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/asset/{asset}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "version": 0,
  • "id": "0x602c79718b16e442de58778e148d0b1084e3b2dffd5de6b7b16cee7969282de7",
  • "type": "UtilityToken",
  • "name": [
    ],
  • "amount": "100000000",
  • "available": "0",
  • "precision": 8,
  • "owner": "00",
  • "admin": "AWKECj9RD8rS8RPcpCgYVjk1DeYyHwxZm3",
  • "issuer": "AWKECj9RD8rS8RPcpCgYVjk1DeYyHwxZm3",
  • "expiration": 4000000,
  • "frozen": false
}

Get NEO unspent transaction outputs

5 credits per API call.


Get NEO unspent transaction outputs.

SecurityX-API-Key
Request
path Parameters
txId
required
string

Transaction ID.

Example: 45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99
index
required
number

Index of output.

Example: 0
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/neo/transaction/out/{txId}/{index}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/transaction/out/{txId}/{index}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "asset": "0x602c79718b16e442de58778e148d0b1084e3b2dffd5de6b7b16cee7969282de7",
  • "value": "47000",
  • "address": "Aenzj5NnVgPUo3hAVy9cyFN9CbrgREyyJ1",
  • "n": 1
}

Get NEO Account transactions

5 credits per API call.


Get NEO Account transactions.

SecurityX-API-Key
Request
path Parameters
address
required
string
Example: AKL19WwiJ2fiTDkAnYQ7GJSTUBoJPTQKhn
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/neo/account/tx/{address}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/account/tx/{address}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Get NEO contract details

5 credits per API call.


Get NEO contract details.

SecurityX-API-Key
Request
path Parameters
scriptHash
required
string

Hash of smart contract

Example: 0xdc675afc61a7c0f7b3d2682bf6e1d8ed865a0e5f
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/neo/contract/{scriptHash}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/contract/{scriptHash}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "version": 0,
  • "hash": "0xdc675afc61a7c0f7b3d2682bf6e1d8ed865a0e5f",
  • "script": "5fc56b6c766b00527ac46c766b51527ac46107576f6f6c6f6e676c766b52527ac403574e476c766b53527ac4006c766b54527ac4210354ae498221046c666efebbaee9bd0eb4823469c98e748494a92a71f346b1a6616c766b55527ac46c766b00c3066465706c6f79876c766b56527ac46c766b56c36416006c766b55c36165f2026c766b57527ac462d8016c766b55c36165d801616c766b00c30b746f74616c537570706c79876c766b58527ac46c766b58c36440006168164e656f2e53746f726167652e476574436f6e7465787406737570706c79617c680f4e656f2e53746f726167652e4765746c766b57527ac46270016c766b00c3046e616d65876c766b59527ac46c766b59c36412006c766b52c36c766b57527ac46247016c766b00c30673796d626f6c876c766b5a527ac46c766b5ac36412006c766b53c36c766b57527ac4621c016c766b00c308646563696d616c73876c766b5b527ac46c766b5bc36412006c766b54c36c766b57527ac462ef006c766b00c30962616c616e63654f66876c766b5c527ac46c766b5cc36440006168164e656f2e53746f726167652e476574436f6e746578746c766b51c351c3617c680f4e656f2e53746f726167652e4765746c766b57527ac46293006c766b51c300c36168184e656f2e52756e74696d652e436865636b5769746e657373009c6c766b5d527ac46c766b5dc3640e00006c766b57527ac46255006c766b00c3087472616e73666572876c766b5e527ac46c766b5ec3642c006c766b51c300c36c766b51c351c36c766b51c352c36165d40361527265c9016c766b57527ac4620e00006c766b57527ac46203006c766b57c3616c756653c56b6c766b00527ac4616168164e656f2e53746f726167652e476574436f6e746578746c766b00c3617c680f4e656f2e53746f726167652e4765746165700351936c766b51527ac46168164e656f2e53746f726167652e476574436f6e746578746c766b00c36c766b51c361651103615272680f4e656f2e53746f726167652e507574616168164e656f2e53746f726167652e476574436f6e7465787406737570706c79617c680f4e656f2e53746f726167652e4765746165f40251936c766b52527ac46168164e656f2e53746f726167652e476574436f6e7465787406737570706c796c766b52c361659302615272680f4e656f2e53746f726167652e50757461616c756653c56b6c766b00527ac461516c766b51527ac46168164e656f2e53746f726167652e476574436f6e746578746c766b00c36c766b51c361654002615272680f4e656f2e53746f726167652e507574616168164e656f2e53746f726167652e476574436f6e7465787406737570706c796c766b51c361650202615272680f4e656f2e53746f726167652e50757461516c766b52527ac46203006c766b52c3616c756659c56b6c766b00527ac46c766b51527ac46c766b52527ac4616168164e656f2e53746f726167652e476574436f6e746578746c766b00c3617c680f4e656f2e53746f726167652e4765746c766b53527ac46168164e656f2e53746f726167652e476574436f6e746578746c766b51c3617c680f4e656f2e53746f726167652e4765746c766b54527ac46c766b53c3616576016c766b52c3946c766b55527ac46c766b54c3616560016c766b52c3936c766b56527ac46c766b55c300a2640d006c766b52c300a2620400006c766b57527ac46c766b57c364ec00616168164e656f2e53746f726167652e476574436f6e746578746c766b00c36c766b55c36165d800615272680f4e656f2e53746f726167652e507574616168164e656f2e53746f726167652e476574436f6e746578746c766b51c36c766b56c361659c00615272680f4e656f2e53746f726167652e5075746155c57600135472616e73666572205375636365737366756cc476516c766b00c3c476526c766b51c3c476536c766b52c3c476546168184e656f2e426c6f636b636861696e2e476574486569676874c46168124e656f2e52756e74696d652e4e6f7469667961516c766b58527ac4620e00006c766b58527ac46203006c766b58c3616c756653c56b6c766b00527ac4616c766b00c36c766b51527ac46c766b51c36c766b52527ac46203006c766b52c3616c756653c56b6c766b00527ac461516c766b00c36a527a527ac46c766b51c36c766b52527ac46203006c766b52c3616c7566",
  • "parameters": [
    ],
  • "returntype": "ByteArray",
  • "name": "Woolong",
  • "code_version": "0.9.2",
  • "author": "lllwvlvwlll",
  • "email": "lllwvlvwlll@gmail.com",
  • "description": "GO NEO!!!",
  • "properties": {
    }
}

Get NEO transaction by hash

5 credits per API call.


Get NEO transaction by hash.

SecurityX-API-Key
Request
path Parameters
hash
required
string

Transaction hash.

Example: 45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99
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/neo/transaction/{hash}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/neo/transaction/{hash}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "txid": "0x45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99",
  • "size": 262,
  • "type": "ContractTransaction",
  • "version": 0,
  • "attributes": [ ],
  • "vin": [
    ],
  • "vout": [
    ],
  • "sys_fee": "0",
  • "net_fee": "0",
  • "scripts": [
    ],
  • "blockhash": "0x099d263a881f39da89f60f4132737ac18ebd3ac2ead7414a3453b43cb97ca411",
  • "confirmations": 385,
  • "blocktime": 1574502564
}

Send NEO assets

5 credits per API call.


Send NEO assets from address to address. It is possible to send NEO and GAS in the same transaction.

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. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, it is possible to use the Tatum client library for supported languages.

SecurityX-API-Key
Request
Request Body schema: application/json
to
required
string <= 100 characters

Recipient address.

required
object

Assets to send.

NEO
number > 0

Amount of NEO to be sent.

GAS
number > 0

Amount of GAS to be sent.

fromPrivateKey
required
string <= 64 characters

Private key of address to send assets from.

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/neo/transaction
Request samples
application/json
{
  • "to": "Abfm15QX2JCjtHPsgBwiHwMcZXWofUwCLZ",
  • "assets": {
    },
  • "fromPrivateKey": "0ee69b443c740982e31ac64f8ab06006c24b7aab9e6ebe81b4663eafc72e13c9"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

Claim GAS

5 credits per API call.


Claim GAS for NEO account. Every account owner can claim for the GAS, which is produced for owning NEO on the address.

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. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, it is possible to use the Tatum client library for supported languages.

SecurityX-API-Key
Request
Request Body schema: application/json
privateKey
required
string <= 64 characters

Private key of address to claim for GAS.

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/neo/claim
Request samples
application/json
{
  • "privateKey": "0ee69b443c740982e31ac64f8ab06006c24b7aab9e6ebe81b4663eafc72e13c9"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

Send NEO smart contract tokens

5 credits per API call.


Send NEO smart contract tokens. It is possible to transfer custom NEO-based tokens to another account.

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. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, it is possible to use the Tatum client library for supported languages.

SecurityX-API-Key
Request
Request Body schema: application/json
numOfDecimals
required
number >= 1

Number of decimals of asset being transferred.

additionalInvocationGas
number >= 0

Additional GAS to be paid for smart contract invocation.

amount
required
number > 0

Amount to be sent.

scriptHash
required
string <= 50000 characters

Function to be invoked on Smart Contract.

to
required
string <= 100 characters

Recipient address.

fromPrivateKey
required
string <= 64 characters

Private key of address to invoke smart contract.

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/neo/invoke
Request samples
application/json
{
  • "numOfDecimals": 8,
  • "additionalInvocationGas": 1,
  • "amount": 10,
  • "scriptHash": "string",
  • "to": "Abfm15QX2JCjtHPsgBwiHwMcZXWofUwCLZ",
  • "fromPrivateKey": "0ee69b443c740982e31ac64f8ab06006c24b7aab9e6ebe81b4663eafc72e13c9"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

Broadcast NEO transaction

5 credits per API call.


Broadcast NEO transaction. This method is used internally or Tatum client libraries. It is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.

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 = 24 characters

Identifier of KMS pending transaction ID to be completed with the broadcast.

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/neo/broadcast
Request samples
application/json
{
  • "txData": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D",
  • "signatureId": "5e68c66581f2ee32bc354087"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
➔ Next to Polygon