ManagedBlockchainQuery / Client / list_filtered_transaction_events

list_filtered_transaction_events#

ManagedBlockchainQuery.Client.list_filtered_transaction_events(**kwargs)#

Lists all the transaction events for an address on the blockchain.

Note

This operation is only supported on the Bitcoin networks.

See also: AWS API Documentation

Request Syntax

response = client.list_filtered_transaction_events(
    network='string',
    addressIdentifierFilter={
        'transactionEventToAddress': [
            'string',
        ]
    },
    timeFilter={
        'from': {
            'time': datetime(2015, 1, 1)
        },
        'to': {
            'time': datetime(2015, 1, 1)
        }
    },
    voutFilter={
        'voutSpent': True|False
    },
    confirmationStatusFilter={
        'include': [
            'FINAL'|'NONFINAL',
        ]
    },
    sort={
        'sortBy': 'blockchainInstant',
        'sortOrder': 'ASCENDING'|'DESCENDING'
    },
    nextToken='string',
    maxResults=123
)
Parameters:

  • network (string) –

    [REQUIRED]

    The blockchain network where the transaction occurred.

    Valid Values: BITCOIN_MAINNET | BITCOIN_TESTNET

  • addressIdentifierFilter (dict) –

    [REQUIRED]

    This is the unique public address on the blockchain for which the transaction events are being requested.

    • transactionEventToAddress (list) – [REQUIRED]

      The container for the recipient address of the transaction.

      • (string) –

  • timeFilter (dict) –

    This container specifies the time frame for the transaction events returned in the response.

    • from (dict) –

      The container for time.

      • time (datetime) –

        The container of the Timestamp of the blockchain instant.

        Note

        This timestamp will only be recorded up to the second.

    • to (dict) –

      The container for time.

      • time (datetime) –

        The container of the Timestamp of the blockchain instant.

        Note

        This timestamp will only be recorded up to the second.

  • voutFilter (dict) –

    This container specifies filtering attributes related to BITCOIN_VOUT event types

    • voutSpent (boolean) – [REQUIRED]

      Specifies if the transaction output is spent or unspent.

  • confirmationStatusFilter (dict) –

    The container for the ConfirmationStatusFilter that filters for the finality of the results.

    • include (list) – [REQUIRED]

      The container to determine whether to list results that have only reached finality. Transactions that have reached finality are always part of the response.

      • (string) –

  • sort (dict) –

    The order by which the results will be sorted.

    • sortBy (string) –

      Container on how the results will be sorted by?

    • sortOrder (string) –

      The container for the sort order for ListFilteredTransactionEvents. The SortOrder field only accepts the values ASCENDING and DESCENDING. Not providing SortOrder will default to ASCENDING.

  • nextToken (string) – The pagination token that indicates the next set of results to retrieve.

  • maxResults (integer) –

    The maximum number of transaction events to list.

    Default: 100

    Note

    Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.

    To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return

Return type:

dict

Returns:

Response Syntax

{
    'events': [
        {
            'network': 'ETHEREUM_MAINNET'|'ETHEREUM_SEPOLIA_TESTNET'|'BITCOIN_MAINNET'|'BITCOIN_TESTNET',
            'transactionHash': 'string',
            'eventType': 'ERC20_TRANSFER'|'ERC20_MINT'|'ERC20_BURN'|'ERC20_DEPOSIT'|'ERC20_WITHDRAWAL'|'ERC721_TRANSFER'|'ERC1155_TRANSFER'|'BITCOIN_VIN'|'BITCOIN_VOUT'|'INTERNAL_ETH_TRANSFER'|'ETH_TRANSFER',
            'from': 'string',
            'to': 'string',
            'value': 'string',
            'contractAddress': 'string',
            'tokenId': 'string',
            'transactionId': 'string',
            'voutIndex': 123,
            'voutSpent': True|False,
            'spentVoutTransactionId': 'string',
            'spentVoutTransactionHash': 'string',
            'spentVoutIndex': 123,
            'blockchainInstant': {
                'time': datetime(2015, 1, 1)
            },
            'confirmationStatus': 'FINAL'|'NONFINAL'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • events (list) –

      The transaction events returned by the request.

      • (dict) –

        The container for the properties of a transaction event.

        • network (string) –

          The blockchain network where the transaction occurred.

        • transactionHash (string) –

          The hash of a transaction. It is generated when a transaction is created.

        • eventType (string) –

          The type of transaction event.

        • from (string) –

          The wallet address initiating the transaction. It can either be a public key or a contract.

        • to (string) –

          The wallet address receiving the transaction. It can either be a public key or a contract.

        • value (string) –

          The value that was transacted.

        • contractAddress (string) –

          The blockchain address for the contract

        • tokenId (string) –

          The unique identifier for the token involved in the transaction.

        • transactionId (string) –

          The identifier of a Bitcoin transaction. It is generated when a transaction is created.

        • voutIndex (integer) –

          The position of the transaction output in the transaction output list.

        • voutSpent (boolean) –

          Specifies if the transaction output is spent or unspent. This is only returned for BITCOIN_VOUT event types.

          Note

          This is only returned for BITCOIN_VOUT event types.

        • spentVoutTransactionId (string) –

          The transactionId that created the spent transaction output.

          Note

          This is only returned for BITCOIN_VIN event types.

        • spentVoutTransactionHash (string) –

          The transactionHash that created the spent transaction output.

          Note

          This is only returned for BITCOIN_VIN event types.

        • spentVoutIndex (integer) –

          The position of the spent transaction output in the output list of the creating transaction.

          Note

          This is only returned for BITCOIN_VIN event types.

        • blockchainInstant (dict) –

          The container for time.

          • time (datetime) –

            The container of the Timestamp of the blockchain instant.

            Note

            This timestamp will only be recorded up to the second.

        • confirmationStatus (string) –

          This container specifies whether the transaction has reached Finality.

    • nextToken (string) –

      The pagination token that indicates the next set of results to retrieve.

Exceptions