Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListFilteredTransactionEvents

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

Note

This operation is only supported on the Bitcoin networks.

Request Syntax


POST /list-filtered-transaction-events HTTP/1.1
Content-type: application/json

{
   "addressIdentifierFilter": { 
      "transactionEventToAddress": [ "string" ]
   },
   "confirmationStatusFilter": { 
      "include": [ "string" ]
   },
   "maxResults": number,
   "network": "string",
   "nextToken": "string",
   "sort": { 
      "sortBy": "string",
      "sortOrder": "string"
   },
   "timeFilter": { 
      "from": { 
         "time": number
      },
      "to": { 
         "time": number
      }
   },
   "voutFilter": { 
      "voutSpent": boolean
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

addressIdentifierFilter

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

Type: AddressIdentifierFilter object

Required: Yes

confirmationStatusFilter

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

Type: ConfirmationStatusFilter object

Required: No

maxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 250.

Required: No

network

The blockchain network where the transaction occurred.

Valid Values: BITCOIN_MAINNET | BITCOIN_TESTNET

Type: String

Required: Yes

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131070.

Required: No

sort

The order by which the results will be sorted.

Type: ListFilteredTransactionEventsSort object

Required: No

timeFilter

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

Type: TimeFilter object

Required: No

voutFilter

This container specifies filtering attributes related to BITCOIN_VOUT event types

Type: VoutFilter object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "events": [ 
      { 
         "blockchainInstant": { 
            "time": number
         },
         "confirmationStatus": "string",
         "contractAddress": "string",
         "eventType": "string",
         "from": "string",
         "network": "string",
         "spentVoutIndex": number,
         "spentVoutTransactionHash": "string",
         "spentVoutTransactionId": "string",
         "to": "string",
         "tokenId": "string",
         "transactionHash": "string",
         "transactionId": "string",
         "value": "string",
         "voutIndex": number,
         "voutSpent": boolean
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

events

The transaction events returned by the request.

Type: Array of TransactionEvent objects

Array Members: Minimum number of 0 items. Maximum number of 250 items.

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131070.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The AWS account doesn’t have access to this resource.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an internal error in the service.

HTTP Status Code: 500

ServiceQuotaExceededException

The service quota has been exceeded for this resource.

HTTP Status Code: 402

ThrottlingException

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is when you create resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources, if possible.

HTTP Status Code: 429

ValidationException

The resource passed is invalid.

HTTP Status Code: 400