SearchTransactionsRequest
SearchTransactionsRequest is used to search for transactions matching a set of provided conditions in canonical blocks.
Properties
Name | Type | Description | Required |
---|---|---|---|
network_identifier | NetworkIdentifier | The network_identifier specifies which network a particular object is associated with. | True |
operator | Operator | Operator is used by query-related endpoints to determine how to apply conditions. | True |
max_block | Int64 (>= 0) | max_block is the largest block index to consider when searching for transactions. If this field is not populated, the current block is considered the max_block. If you do not specify a max_block, it is possible a newly synced block will interfere with paginated transaction queries (as the offset could become invalid with newly added rows). | False |
offset | Int64 (>= 0) | offset is the offset into the query result to start returning transactions. If any search conditions are changed, the query offset will change and you must restart your search iteration. | False |
limit | Int64 (>= 0) | limit is the maximum number of transactions to return in one call. The implementation may return "= limit transactions. | False |
transaction_identifier | TransactionIdentifier | The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool. | False |
account_identifier | AccountIdentifier | The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). | False |
coin_identifier | CoinIdentifier | CoinIdentifier uniquely identifies a Coin. | False |
currency | Currency | Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins). | False |
status | String | status is the network-specific operation type. | False |
type | String | type is the network-specific operation type. | False |
address | String | address is AccountIdentifier.Address. This is used to get all transactions related to an AccountIdentifier.Address, regardless of SubAccountIdentifier. | False |
success | Boolean | success is a synthetic condition populated by parsing network-specific operation statuses (using the mapping provided in /network/options ). | False |
Example
{
"network_identifier": {
"blockchain": "bitcoin",
"network": "mainnet",
"sub_network_identifier": {
"network": "shard 1",
"metadata": {
"producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
}
}
},
"operator": "or",
"max_block": 5,
"offset": 5,
"limit": 5,
"transaction_identifier": {
"hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
},
"account_identifier": {
"address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
"sub_account": {
"address": "0x6b175474e89094c44da98b954eedeac495271d0f",
"metadata": {}
},
"metadata": {}
},
"coin_identifier": {
"identifier": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1"
},
"currency": {
"symbol": "BTC",
"decimals": 8,
"metadata": {
"Issuer": "Satoshi"
}
},
"status": "reverted",
"type": "transfer",
"address": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
"success": true
}