BatchGetTokenBalance

$result = $client->batchGetTokenBalance([/* ... */]);
$promise = $client->batchGetTokenBalanceAsync([/* ... */]);

Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request.

Parameter Syntax

$result = $client->batchGetTokenBalance([
    'getTokenBalanceInputs' => [
        [
            'atBlockchainInstant' => [
                'time' => <integer || string || DateTime>,
            ],
            'ownerIdentifier' => [ // REQUIRED
                'address' => '<string>', // REQUIRED
            ],
            'tokenIdentifier' => [ // REQUIRED
                'contractAddress' => '<string>',
                'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
                'tokenId' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'atBlockchainInstant' => [
                'time' => <DateTime>,
            ],
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'errorType' => 'VALIDATION_EXCEPTION|RESOURCE_NOT_FOUND_EXCEPTION',
            'ownerIdentifier' => [
                'address' => '<string>',
            ],
            'tokenIdentifier' => [
                'contractAddress' => '<string>',
                'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
                'tokenId' => '<string>',
            ],
        ],
        // ...
    ],
    'tokenBalances' => [
        [
            'atBlockchainInstant' => [
                'time' => <DateTime>,
            ],
            'balance' => '<string>',
            'lastUpdatedTime' => [
                'time' => <DateTime>,
            ],
            'ownerIdentifier' => [
                'address' => '<string>',
            ],
            'tokenIdentifier' => [
                'contractAddress' => '<string>',
                'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
                'tokenId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

GetAssetContract

$result = $client->getAssetContract([/* ... */]);
$promise = $client->getAssetContractAsync([/* ... */]);

Gets the information about a specific contract deployed on the blockchain.

Parameter Syntax

$result = $client->getAssetContract([
    'contractIdentifier' => [ // REQUIRED
        'contractAddress' => '<string>', // REQUIRED
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'contractIdentifier' => [
        'contractAddress' => '<string>',
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
    ],
    'deployerAddress' => '<string>',
    'metadata' => [
        'decimals' => <integer>,
        'name' => '<string>',
        'symbol' => '<string>',
    ],
    'tokenStandard' => 'ERC20|ERC721|ERC1155',
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

GetTokenBalance

$result = $client->getTokenBalance([/* ... */]);
$promise = $client->getTokenBalanceAsync([/* ... */]);

Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.

Parameter Syntax

$result = $client->getTokenBalance([
    'atBlockchainInstant' => [
        'time' => <integer || string || DateTime>,
    ],
    'ownerIdentifier' => [ // REQUIRED
        'address' => '<string>', // REQUIRED
    ],
    'tokenIdentifier' => [ // REQUIRED
        'contractAddress' => '<string>',
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
        'tokenId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'atBlockchainInstant' => [
        'time' => <DateTime>,
    ],
    'balance' => '<string>',
    'lastUpdatedTime' => [
        'time' => <DateTime>,
    ],
    'ownerIdentifier' => [
        'address' => '<string>',
    ],
    'tokenIdentifier' => [
        'contractAddress' => '<string>',
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
        'tokenId' => '<string>',
    ],
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

GetTransaction

$result = $client->getTransaction([/* ... */]);
$promise = $client->getTransactionAsync([/* ... */]);

Gets the details of a transaction.

Parameter Syntax

$result = $client->getTransaction([
    'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
    'transactionHash' => '<string>',
    'transactionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'transaction' => [
        'blockHash' => '<string>',
        'blockNumber' => '<string>',
        'confirmationStatus' => 'FINAL|NONFINAL',
        'contractAddress' => '<string>',
        'cumulativeGasUsed' => '<string>',
        'effectiveGasPrice' => '<string>',
        'executionStatus' => 'FAILED|SUCCEEDED',
        'from' => '<string>',
        'gasUsed' => '<string>',
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
        'numberOfTransactions' => <integer>,
        'signatureR' => '<string>',
        'signatureS' => '<string>',
        'signatureV' => <integer>,
        'to' => '<string>',
        'transactionFee' => '<string>',
        'transactionHash' => '<string>',
        'transactionId' => '<string>',
        'transactionIndex' => <integer>,
        'transactionTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

ListAssetContracts

$result = $client->listAssetContracts([/* ... */]);
$promise = $client->listAssetContractsAsync([/* ... */]);

Lists all the contracts for a given contract type deployed by an address (either a contract address or a wallet address).

The Bitcoin blockchain networks do not support this operation.

Parameter Syntax

$result = $client->listAssetContracts([
    'contractFilter' => [ // REQUIRED
        'deployerAddress' => '<string>', // REQUIRED
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
        'tokenStandard' => 'ERC20|ERC721|ERC1155', // REQUIRED
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'contracts' => [
        [
            'contractIdentifier' => [
                'contractAddress' => '<string>',
                'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
            ],
            'deployerAddress' => '<string>',
            'tokenStandard' => 'ERC20|ERC721|ERC1155',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

ListFilteredTransactionEvents

$result = $client->listFilteredTransactionEvents([/* ... */]);
$promise = $client->listFilteredTransactionEventsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listFilteredTransactionEvents([
    'addressIdentifierFilter' => [ // REQUIRED
        'transactionEventToAddress' => ['<string>', ...], // REQUIRED
    ],
    'confirmationStatusFilter' => [
        'include' => ['<string>', ...], // REQUIRED
    ],
    'maxResults' => <integer>,
    'network' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sort' => [
        'sortBy' => 'blockchainInstant',
        'sortOrder' => 'ASCENDING|DESCENDING',
    ],
    'timeFilter' => [
        'from' => [
            'time' => <integer || string || DateTime>,
        ],
        'to' => [
            'time' => <integer || string || DateTime>,
        ],
    ],
    'voutFilter' => [
        'voutSpent' => true || false, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'blockchainInstant' => [
                'time' => <DateTime>,
            ],
            'confirmationStatus' => 'FINAL|NONFINAL',
            'contractAddress' => '<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>',
            'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
            'spentVoutIndex' => <integer>,
            'spentVoutTransactionHash' => '<string>',
            'spentVoutTransactionId' => '<string>',
            'to' => '<string>',
            'tokenId' => '<string>',
            'transactionHash' => '<string>',
            'transactionId' => '<string>',
            'value' => '<string>',
            'voutIndex' => <integer>,
            'voutSpent' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

ListTokenBalances

$result = $client->listTokenBalances([/* ... */]);
$promise = $client->listTokenBalancesAsync([/* ... */]);

This action returns the following for a given blockchain network:

• Lists all token balances owned by an address (either a contract address or a wallet address).

• Lists all token balances for all tokens created by a contract.

• Lists all token balances for a given token.

Parameter Syntax

$result = $client->listTokenBalances([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'ownerFilter' => [
        'address' => '<string>', // REQUIRED
    ],
    'tokenFilter' => [ // REQUIRED
        'contractAddress' => '<string>',
        'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
        'tokenId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tokenBalances' => [
        [
            'atBlockchainInstant' => [
                'time' => <DateTime>,
            ],
            'balance' => '<string>',
            'lastUpdatedTime' => [
                'time' => <DateTime>,
            ],
            'ownerIdentifier' => [
                'address' => '<string>',
            ],
            'tokenIdentifier' => [
                'contractAddress' => '<string>',
                'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
                'tokenId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

ListTransactionEvents

$result = $client->listTransactionEvents([/* ... */]);
$promise = $client->listTransactionEventsAsync([/* ... */]);

Lists all the transaction events for a transaction

Parameter Syntax

$result = $client->listTransactionEvents([
    'maxResults' => <integer>,
    'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
    'nextToken' => '<string>',
    'transactionHash' => '<string>',
    'transactionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'blockchainInstant' => [
                'time' => <DateTime>,
            ],
            'confirmationStatus' => 'FINAL|NONFINAL',
            'contractAddress' => '<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>',
            'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
            'spentVoutIndex' => <integer>,
            'spentVoutTransactionHash' => '<string>',
            'spentVoutTransactionId' => '<string>',
            'to' => '<string>',
            'tokenId' => '<string>',
            'transactionHash' => '<string>',
            'transactionId' => '<string>',
            'value' => '<string>',
            'voutIndex' => <integer>,
            'voutSpent' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.

ListTransactions

$result = $client->listTransactions([/* ... */]);
$promise = $client->listTransactionsAsync([/* ... */]);

Lists all the transaction events for a transaction.

Parameter Syntax

$result = $client->listTransactions([
    'address' => '<string>', // REQUIRED
    'confirmationStatusFilter' => [
        'include' => ['<string>', ...], // REQUIRED
    ],
    'fromBlockchainInstant' => [
        'time' => <integer || string || DateTime>,
    ],
    'maxResults' => <integer>,
    'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET', // REQUIRED
    'nextToken' => '<string>',
    'sort' => [
        'sortBy' => 'TRANSACTION_TIMESTAMP',
        'sortOrder' => 'ASCENDING|DESCENDING',
    ],
    'toBlockchainInstant' => [
        'time' => <integer || string || DateTime>,
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'transactions' => [
        [
            'confirmationStatus' => 'FINAL|NONFINAL',
            'network' => 'ETHEREUM_MAINNET|ETHEREUM_SEPOLIA_TESTNET|BITCOIN_MAINNET|BITCOIN_TESTNET',
            'transactionHash' => '<string>',
            'transactionId' => '<string>',
            'transactionTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

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.

ValidationException:

The resource passed is invalid.

AccessDeniedException:

The Amazon Web Services account doesn’t have access to this resource.

InternalServerException:

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

ServiceQuotaExceededException:

The service quota has been exceeded for this resource.