ADAMANT Docs

Appearance

Transactions ​

Contains endpoints useful to interact with transactions of ADAMANT blockchain.

Every action in ADAMANT, a blockchain messenger, is a transaction — f. e., sending tokens, voting for delegate, storing contact list, or sending a message. See Transaction Types.

Transactions can be fetched with filtering and options using Transactions Query Language. To receive asset contents, set returnAsset to 1.

Get List of Transactions ​

sh
GET /api/transactions

  • Description

    To get the list of all transactions registered at the ADAMANT blockchain, use endpoint /api/transactions. The result includes a list of transactions with the following structure:

    • id — ID of transaction
    • height — block height where the transaction was forged
    • blockId — block ID where the transaction was forged
    • type — type of transaction. See Transaction Types.
    • timestamp — transaction timestamp, a 32-bit integer epoch timestamp (in seconds starting from Sep 02, 2017, 17:00:00 GMT+0000). Nodes do not accept transactions stamped in the future.
    • block_timestamp — transaction's block timestamp. It is up to the client to interpret this field. It is recommended to take into account both timestamp and block_timestamp fields when determining transaction timestamp.
    • senderPublicKey — public key of sender
    • senderId — ADAMANT address of sender
    • recipientId — ADAMANT address of recipient
    • recipientPublicKey — public key of recipient
    • amount — amount to transfer in a 64-bit integer, 8 decimal points (100000000 equals to 1 ADM). For non-transfer transactions, this value is 0.
    • fee — fee for operation. Depends on the type of transaction.
    • signature — transaction signature
    • confirmations — count of network confirmations — how many blocks were generated after this block on the current node's height.
    • asset — transaction data specific to different transaction/message types. See ADAMANT Message Types and Storing Data in KVS. Used also in Signature calculation.

    Read more about the transaction structure in AIP 10: General transaction structure for API calls.

  • Example

    Request:

    sh
    GET https://endless.adamant.im/api/transactions?minAmount=100000000000001&and:fromHeight=2190516&limit=2

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 63647315,
  "transactions": [
    {
      "id": "15161295239237781653",
      "height": 7585271,
      "blockId": "16391508373936326027",
      "type": 8,
      "block_timestamp": 45182260,
      "timestamp": 45182254,
      "senderPublicKey": "bd39cc708499ae91b937083463fce5e0668c2b37e78df28f69d132fce51d49ed",
      "senderId": "U16023712506749300952",
      "recipientId": "U17653312780572073341",
      "recipientPublicKey": "23d27f616e304ef2046a60b762683b8dabebe0d8fc26e5ecdb1d5f3d291dbe21",
      "amount": 204921300000000,
      "fee": 50000000,
      "signature": "3c8e551f60fedb81e52835c69e8b158eb1b8b3c89a04d3df5adc0d99017ffbcb06a7b16ad76d519f80df019c930960317a67e8d18ab1e85e575c9470000cf607",
      "signatures": [],
      "confirmations": 3660548,
      "asset": {}
    },
    {
      "id": "273812757049414072",
      "height": 5022045,
      "blockId": "3228763343382065625",
      "type": 0,
      "block_timestamp": 32283395,
      "timestamp": 32283382,
      "senderPublicKey": "1e214309cc659646ecf1d90fa37be23fe76854a76e3b4da9e4d6b65a718baf8b",
      "senderId": "U7047165086065693428",
      "recipientId": "U11420099101614271169",
      "recipientPublicKey": "b29420b8ee7a678b49c2f4b41e614e32a7149ac7f8b81cc174611daefe9636cf",
      "amount": 600000000000000,
      "fee": 50000000,
      "signature": "2a6b51058b4d4a6312f32d4a6c14f1cc77f8c581e1f02ad8c13aeaa77880edd7e66ce150ffaeef2f541ad8366849f32710f66a6b95b3d2c9291f6fcdf045a50e",
      "signatures": [],
      "confirmations": 6223774,
      "asset": {}
    }
  ],
  "count": "6"
}

Get Transaction by ID ​

sh
GET api/transactions/get?id={id}

  • Description

    Get information about a specific transaction using endpoint /api/transactions/get with the transaction id as a parameter.

  • Example

    Request:

    sh
    GET https://ahead.adamant.im/api/transactions/get?id=12154642911137703318&returnAsset=1

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 63652999,
  "transaction": {
    "id": "12154642911137703318",
    "height": 3245671,
    "blockId": "13885000778367150465",
    "type": 8,
    "block_timestamp": 23284520,
    "timestamp": 23284514,
    "senderPublicKey": "cdab95b082b9774bd975677c868261618c7ce7bea97d02e0f56d483e30c077b6",
    "senderId": "U15423595369615486571",
    "recipientId": "U12777528161244463452",
    "recipientPublicKey": "738a15db24bd055d65a449dee27508708a2c6b8457c3033fb5f389ac0e3b4c9e",
    "amount": 0,
    "fee": 100000,
    "signature": "8c846fbd41b84635283096bb5833745886760776a433bb050505aaf045efb0f97ce69cd9f108dc4e58392bb507848e1e75d6ea203e7c7904881c44d0f61e2901",
    "signatures": [],
    "confirmations": 8001268,
    "asset": {
      "chat": {
        "message": "6ef39d1034b368bd731c7bcbaa820f0e501bbfb1d1b15e2ffa4bd8421836fe87be10e32342e183d3",
        "own_message": "a23419efa40a9e340741325d0f5db508959c330af51e37fe",
        "type": 1
      }
    }
  }
}

Get Count of Transactions ​

sh
GET /api/transactions/count

  • Description

    Get the count of transactions with different states using endpoint /api/transactions/count. As a result, you'll receive:

    • confirmed
    • unconfirmed
    • queued

    When a node receives a new transaction, it is added to the transaction pool, where transactions are queued. A delegate then selects these queued transactions and includes them in a block. Until the network confirms the block, the transactions within it remain unconfirmed.

    WARNING

    Endpoint /api/transactions/count can return misleading unconfirmed and queued values. To get unconfirmed and queued transactions and their count, use /api/transactions/unconfirmed and /api/transactions/queued endpoints.

    Unconfirmed and queued transactions can vary between different nodes.

    TIP

    Use unconfirmed and queued transactions judiciously, as they may never be included in the blockchain. There are limited use cases where retrieving unconfirmed and queued transactions is necessary.

  • Example

    Request:

    sh
    GET https://endless.adamant.im/api/transactions/count

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 59979539,
  "confirmed": 256953,
  "multisignature": 0,
  "unconfirmed": 44,
  "queued": 42
}

Get Queued Transactions ​

sh
GET /api/transactions/queued

  • Description

    Get transactions that are in the node's queue with the endpoint /api/transactions/queued. As these transactions have not been included in the blockchain yet, they have no blockId and height fields, but have an additional receivedAt field.

  • Example

    Request:

    sh
    GET https://endless.adamant.im/api/transactions/queued

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 59979277,
  "transactions": [
    {
      "timestamp": 59979276,
      "senderId": "U17362714543155685887",
      "recipientId": "U17819800352812315500",
      "type": 0,
      "senderPublicKey": "632816f2c44a08f282e85532443d73286cadc6d9820d5d25c9d50d8e01c668e0",
      "signature": "1db7e9111eaca790b73d51c32572739c46fcba3962aff55ca47ecf9a8c9fcb82c323de39ed60bc87d81a1245d43b5351b9dd44ad70128d78536250168b64c408",
      "amount": 100000000,
      "id": "16682447412632442981",
      "fee": 50000000,
      "relays": 1,
      "receivedAt": "2019-07-28T21:54:36.543Z"
    }
  ],
  "count": 1
}

Get Specific Queued Transaction ​

sh
GET /api/transactions/queued/get?id={id}

  • Description

    Get a specific transaction from the node's queue by its id using the endpoint /api/transactions/queued/get.

    TIP

    Typically, the time for a queued transaction to become unconfirmed and then confirmed is short. Therefore, the use cases for the /api/transactions/queued/get endpoint are limited.

  • Example

    Request:

    sh
    GET https://endless.adamant.im/api/transactions/queued/get?id=16682447412632442981

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 153712825,
  "transaction": {
    "id": "16682447412632442981",
    "height": 10527806,
    "blockId": "2635215585577611518",
    "type": 0,
    "block_timestamp": 59979295,
    "timestamp": 59979276,
    "senderPublicKey": "632816f2c44a08f282e85532443d73286cadc6d9820d5d25c9d50d8e01c668e0",
    "senderId": "U17362714543155685887",
    "recipientId": "U17819800352812315500",
    "recipientPublicKey": "28994b2cd075fd442e6ce78fa8c07966ed122932ff07411fed3c918e495586e2",
    "amount": 100000000,
    "fee": 50000000,
    "signature": "1db7e9111eaca790b73d51c32572739c46fcba3962aff55ca47ecf9a8c9fcb82c323de39ed60bc87d81a1245d43b5351b9dd44ad70128d78536250168b64c408",
    "signatures": [],
    "confirmations": 18431929,
    "asset": {}
  }
}

Get Unconfirmed Transactions ​

sh
GET /api/transactions/unconfirmed

  • Description

    Get transactions that are unconfirmed yet using the endpoint /api/transactions/unconfirmed. As these transactions have not been included in the blockchain yet, they have no blockId and height fields, but have an additional receivedAt field.

    TIP

    You can retrieve both confirmed and unconfirmed transactions in a single request using returnUnconfirmed option with the /api/transactions endpoint.

  • Example

    Request:

    sh
    GET https://endless.adamant.im/api/transactions/unconfirmed

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 58880320,
  "transactions": [
    {
      "type": 8,
      "amount": 9000000,
      "senderId": "U11987698782411545765",
      "senderPublicKey": "b87f9fe005c3533152230fdcbd7bf87a0cea83592c591f7e71be5b7a48bb6e44",
      "asset": {
        "chat": {
          "message": "6e69d547ce31dbbe0a5aba78c516e91d71e3b2",
          "own_message": "e1c00c2c8b8f59f49e176aef30915c6deba554f87c45951e",
          "type": 1
        }
      },
      "recipientId": "U5885317311990438076",
      "timestamp": 58880317,
      "signature": "5ee972df476703492a667616eef428ed127e13fe5de8ba873b6579a806ddbd9fbd34147cf0321823d72e0d234466fc3dc89ebe7341e0b4a91a56b32d3bdb6a00",
      "id": "2521078418148431420",
      "fee": 50000000,
      "relays": 1,
      "receivedAt": "2019-07-16T04:38:38.492Z"
    }
  ],
  "count": 1
}

Get Specific Unconfirmed Transaction ​

sh
GET /api/transactions/unconfirmed/get?id={id}

  • Description

    Get a specific unconfirmed transaction by its id using the endpoint /api/transactions/unconfirmed/get.

    TIP

    Typically, the time for a unconfirmed transaction to become confirmed is short. Therefore, the use cases for the /api/transactions/unconfirmed/get endpoint are limited.

    You can retrieve a transaction in both confirmed and unconfirmed states using returnUnconfirmed option with the api/transactions/get endpoint.

  • Example

    Request:

    sh
    GET https://endless.adamant.im/api/transactions/unconfirmed/get?id=8958126469643732641

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 63137669,
  "transaction": {
    "type": 8,
    "amount": 0,
    "senderId": "U15677078342684640219",
    "senderPublicKey": "e16e624fd0a5123294b448c21f30a07a0435533c693b146b14e66830e4e20404",
    "asset": {
      "chat": {
        "message": "75582d940f2c4093929c99a6c1911b4753",
        "own_message": "58dceaa227b3fb1dd1c7d3fbf3eb5db6aeb6a03cb7e2ec91",
        "type": 1
      }
    },
    "recipientId": "U16655734187932477074",
    "timestamp": 63137661,
    "signature": "e25f1aba994c7f07c03099edcbe0ada19df371ddf1a829dae8dee36ab809ce8a438111bf65056c813e9dc832a890a081ba1cd295d37e509f62f042149e62e30d",
    "id": "8958126469643732641",
    "fee": 100000,
    "relays": 1,
    "receivedAt": "2019-09-03T11:14:22.638Z"
  }
}

Register Token Transfer Transaction ​

sh
POST /api/transactions/process

  • Description

    Use the endpoint /api/transactions/process to broadcast transactions of type 0 — Token transfer, and type 8 — Chat/Message.

    To make an in-chat ADM token transfer with a comment, you can also use Register Chat Message Transaction or universal Register Transaction endpoints.

    Make a POST request to the endpoint, with the payload of transaction object, where:

    • type is set to 0
    • asset is empty
    • amount is integer measured in 1/108 ADM (1 ADM = 100,000,000)

    Transaction must be formed and signed.

    As a successful result, you'll get the ID of the transaction registered in the ADAMANT blockchain.

  • Example

    Request:

    sh
    POST https://endless.adamant.im/api/transactions/process
    json
    {
  "transaction": {
    "type": 0,
    "amount": 100000000,
    "senderId": "U14236667426471084862",
    "senderPublicKey": "8cd9631f9f634a361ea3b85cbd0df882633e39e7d26d7bc615bbcf75e41524ef",
    "recipientId": "U16655734187932477074",
    "timestamp": 63228852,
    "signature": "b3982d603be8f0246fa663e9f012bf28b198cd28f82473db1eb4a342d890f7a2a2c1845db8d256bb5bce1e64a9425822a91e10bf960a2e0b55e20b4841e4ae0b"
  }
}

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 63228852,
  "transactionId": "6146865104403680934"
}

Register Transaction ​

sh
POST /api/transactions

  • Description

    Use the universal endpoint /api/transactions to broadcast transactions of any type. This endpoint can be used instead of:

    Make a POST request to the endpoint, with the payload of transaction object. Transaction must be formed and signed.

    As a successful result, you'll get the ID of the transaction registered in the ADAMANT blockchain.

  • Example

    Request:

    sh
    POST https://endless.adamant.im/api/transactions
    json
    {
  "transaction": {
    "type": 0,
    "amount": 100000000,
    "senderId": "U14236667426471084862",
    "senderPublicKey": "8cd9631f9f634a361ea3b85cbd0df882633e39e7d26d7bc615bbcf75e41524ef",
    "recipientId": "U16655734187932477074",
    "timestamp": 63228852,
    "signature": "b3982d603be8f0246fa663e9f012bf28b198cd28f82473db1eb4a342d890f7a2a2c1845db8d256bb5bce1e64a9425822a91e10bf960a2e0b55e20b4841e4ae0b"
  }
}

    Response:

    json
    {
  "success": true,
  "nodeTimestamp": 63228852,
  "transactionId": "6146865104403680934"
}