Transactions Query Language

To expand opportunities of getting transactions use parameters to filter results and options.

Filters available for endpoints:

• /api/transactions: blockId, fromHeight, toHeight, minAmount, maxAmount, senderId, senderIds, recipientId, recipientIds, senderPublicKey, senderPublicKeys, recipientPublicKey, recipientPublicKeys, inId, type, types
• /api/chats/get: fromHeight, toHeight, senderId, recipientId, inId, type
• /api/chatrooms: type
• /api/states/get: fromHeight, toHeight, senderId, senderIds,key, keyIds,type

You can use limit, offset, orderBy and returnUnconfirmed options. There are additional options for endpoints:

• /api/transactions: returnAsset
• /api/chats/get: includeDirectTransfers
• /api/chatrooms: includeDirectTransfers

Filters and options can be joined: Combine filters and options.

Available filter parameters

blockId

Get transactions in specific block.

• Example

  http://endless.adamant.im/api/transactions?blockId=7917597195203393333

fromHeight

Get transactions starting from block with specific height.

• Example

  http://endless.adamant.im/api/transactions?fromHeight=10336065

toHeight

Get transactions till block with specific height.

• Example

  http://endless.adamant.im/api/transactions?toHeight=11

minAmount

Get transactions with amount not less than specified Integer value of 1/10⁸ tokens (1 ADM = 100,000,000).

• Example

  http://endless.adamant.im/api/transactions?minAmount=1000000000000001

maxAmount

Get transactions with amount not more than specified Integer value of 1/10⁸ tokens (1 ADM = 100,000,000).

• Example

  http://endless.adamant.im/api/transactions?maxAmount=50000000

senderId

Get transactions sent from specified ADAMANT address.

• Example

  https://endless.adamant.im/api/transactions?senderId=U15423595369615486571

senderIds

Get transactions sent from specified ADAMANT addresses, separated by commas.

TIP

Available for /api/transactions and /api/states/get endpoints only.

• Example

  https://debate.adamant.im/api/transactions?senderIds=U18132012621449491414,U15881344309699504778

recipientId

Get transactions received by specified ADAMANT address.

• Example

  https://endless.adamant.im/api/transactions?recipientId=U15423595369615486571

recipientIds

Get transactions received by specified ADAMANT addresses, separated by commas.

TIP

Available for /api/transactions endpoint only.

• Example

  https://debate.adamant.im/api/transactions?recipientIds=U18132012621449491414,U15881344309699504778

senderPublicKey

Get transactions sent from specified ADAMANT account by public key.

NOTE: Available for /api/transactions endpoint only.

• Example

  https://debate.adamant.im/api/transactions?senderPublicKey=801846655523f5e21f2d454b2f98f70aaf5d3887c806463100a1764a4e7c1457

senderPublicKeys

Get transactions sent from specified ADAMANT account by public keys, separated by commas.

TIP

Available for /api/transactions endpoint only.

• Example

  https://ahead.adamant.im/api/transactions?senderPublicKeys=801846655523f5e21f2d454b2f98f70aaf5d3887c806463100a1764a4e7c1457,125a9b8304ef885053c630041f57493343d7f6023107c5dc8b8148147e732c93

recipientPublicKey

Get transactions received by specified ADAMANT account by public key.

TIP

Available for /api/transactions endpoint only.

• Example

  https://debate.adamant.im/api/transactions?recipientPublicKey=801846655523f5e21f2d454b2f98f70aaf5d3887c806463100a1764a4e7c1457

recipientPublicKeys

Get transactions received by specified ADAMANT account by public keys, separated by commas.

TIP

Available for /api/transactions endpoint only.

• Example

  https://ahead.adamant.im/api/transactions?recipientPublicKeys=801846655523f5e21f2d454b2f98f70aaf5d3887c806463100a1764a4e7c1457,125a9b8304ef885053c630041f57493343d7f6023107c5dc8b8148147e732c93

inId

Get transactions sent from or received to specified ADAMANT address.

• Example

  http://endless.adamant.im/api/transactions?inId=U100739400829575109

type

Parameter meaning depends on endpoint:

• /api/transactions: Get transactions of specified type. See Transaction Types. If type is not set, all types of transactions will be returned.

• /api/chats/get and /api/chatrooms: Get messages of specified type. See ADAMANT Message Types. If type is not set, all types of messages will be returned.

• /api/states/get: Get KVS records of incremental or full re-write of previous values. Default is 0. See AIP 11: Behavior for KVS data.

• Examples

  To get message transactions:

  https://endless.adamant.im/api/transactions?type=8

  To get Rich messages:

  https://endless.adamant.im/api/chats/get?type=2

  or

  https://endless.adamant.im/api/chatrooms/U17362714543155685887/U17819800352812315500?type=2

types

Get transactions of specified types, separated by commas. See Transaction Types.

TIP

Available for /api/transactions endpoint only.

• Example

  https://debate.adamant.im/api/transactions?types=9,0

key

Refers to /api/states/get endpoint.

Get transactions of specified KVS key. See AIP 3: Storing data in chain (KVS).

• Example

  https://endless.adamant.im/api/states/get?key=eth:address&senderId=U14236667426471084862&orderBy=timestamp:desc

keyIds

Refers to /api/states/get endpoint.

Get transactions of specified KVS keys. Combine with senderIds to fetch multiple values for multiple accounts, like public bound coin addresses for contact list.

• Example

  https://ahead.adamant.im/api/states/get?keyIds=eth:address,doge:address,dash:address,btc:address&senderIds=U3461022864428928223,U17790659840463725618,U43512412354440829,U10666556853857590034,U15677078342684640219,U10879891600431315092,U15677078342684640219,U16189664252187503076,U15738334853882270577,U11051173936218114255,U5149447931090026688,U18064911620565010636,U11962817086029207137,U14236667426471084862,U3857204090751960756,U18290410688451164219,U15506276306084215695,U18009522315196199993,U17325711452096864732,U16634908687170714645,U9203183357885757380,U12382044996701379416,U3938345682225572184,U116971041436569303,U11163081294512846715,U5517006347330072401,U7972131227889954319,U7578227434840718692&orderBy=timestamp:desc

Available options

Options can be combined.

limit

Limits returned items count. Default is 100 for transactions and 25 for Chatrooms.

• Example

  https://endless.adamant.im/api/transactions?limit=2

offset

Offset value for results, integer. Default is 0.

• Example

  https://endless.adamant.im/api/transactions?offset=100

orderBy

Ordering request results by field name.

• Example

  https://endless.adamant.im/api/transactions?orderBy=timestamp:desc

returnUnconfirmed

Includes unconfirmed transactions when set to 1. All filters and ordering are applied to unconfirmed transactions as well. The default value is 0.

WARNING

When using blockId or toHeight filters, unconfirmed transactions are NOT returned.

• Example

  https://endless.adamant.im/api/transactions?fromHeight=100000&returnUnconfirmed=1

returnAsset

Get transaction's asset when set to 1. Default is 0.

TIP

Available for /api/transactions endpoint only. Endpoints /api/chats/get, /api/chatrooms and /api/states/get always do return asset field.

• Example

  https://endless.adamant.im/api/transactions/get?id=13920471299012339255&returnAsset=1

includeDirectTransfers

When set to 0, excludes type 0 transactions (direct token transfers) from results. Default is 1 for /api/chatrooms and 0 for /api/chats/get.

TIP

Available for /api/chatrooms and /api/chats/get endpoints only.

• Examples

  https://endless.adamant.im/api/chatrooms/U2707535059340134112?includeDirectTransfers=0

  https://endless.adamant.im/api/chats/get?senderId=U2707535059340134112?includeDirectTransfers=1

Combine filters and options

You can filter by single parameter, or by multiple parameters. Default condition and or or differs for endpoint:

• /api/transactions: default is or; to set and use and:
• /api/chats/get: default is and
• /api/chatrooms: default is and
• /api/states/get: default is and

Options always joined with and condition.

• Examples

  Get transactions where height greater than 1336065 or blockId = 7917597195203393333:

  https://endless.adamant.im/api/transactions?fromHeight=1336065&blockId=7917597195203393333

  Get transactions where height greater than 1336065 and senderId = U15423595369615486571, order by timestamp ascending and limit results by 2 transactions:

  https://endless.adamant.im/api/transactions?fromHeight=1336065&and:senderId=U15423595369615486571&limit=2&orderBy=timestamp:asc

  Get type 9 or type 0 transactions where senderId = U18132012621449491414 or senderId = U15881344309699504778, order by timestamp descending:

  https://debate.adamant.im/api/transactions?senderIds=U18132012621449491414,U15881344309699504778&and:types=9,0&orderBy=timestamp:desc