Managedblockchain Query
This page documents function available when using the Managedblockchain_Query
module, created with @service Managedblockchain_Query
.
Index
Main.Managedblockchain_Query.batch_get_token_balance
Main.Managedblockchain_Query.get_asset_contract
Main.Managedblockchain_Query.get_token_balance
Main.Managedblockchain_Query.get_transaction
Main.Managedblockchain_Query.list_asset_contracts
Main.Managedblockchain_Query.list_filtered_transaction_events
Main.Managedblockchain_Query.list_token_balances
Main.Managedblockchain_Query.list_transaction_events
Main.Managedblockchain_Query.list_transactions
Documentation
Main.Managedblockchain_Query.batch_get_token_balance
— Methodbatch_get_token_balance()
batch_get_token_balance(params::Dict{String,<:Any})
Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request. Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"getTokenBalanceInputs"
: An array of BatchGetTokenBalanceInputItem objects whose balance is being requested.
Main.Managedblockchain_Query.get_asset_contract
— Methodget_asset_contract(contract_identifier)
get_asset_contract(contract_identifier, params::Dict{String,<:Any})
Gets the information about a specific contract deployed on the blockchain. The Bitcoin blockchain networks do not support this operation. Metadata is currently only available for some ERC-20 contracts. Metadata will be available for additional contracts in the future.
Arguments
contract_identifier
: Contains the blockchain address and network information about the contract.
Main.Managedblockchain_Query.get_token_balance
— Methodget_token_balance(owner_identifier, token_identifier)
get_token_balance(owner_identifier, token_identifier, params::Dict{String,<:Any})
Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain. Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
Arguments
owner_identifier
: The container for the identifier for the owner.token_identifier
: The container for the identifier for the token, including the unique token ID and its blockchain network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"atBlockchainInstant"
: The time for when the TokenBalance is requested or the current time if a time is not provided in the request. This time will only be recorded up to the second.
Main.Managedblockchain_Query.get_transaction
— Methodget_transaction(network)
get_transaction(network, params::Dict{String,<:Any})
Gets the details of a transaction. This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.
Arguments
network
: The blockchain network where the transaction occurred.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"transactionHash"
: The hash of a transaction. It is generated when a transaction is created."transactionId"
: The identifier of a Bitcoin transaction. It is generated when a transaction is created. transactionId is only supported on the Bitcoin networks.
Main.Managedblockchain_Query.list_asset_contracts
— Methodlist_asset_contracts(contract_filter)
list_asset_contracts(contract_filter, params::Dict{String,<:Any})
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.
Arguments
contract_filter
: Contains the filter parameter for the request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of contracts to list. Default: 100 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"nextToken"
: The pagination token that indicates the next set of results to retrieve.
Main.Managedblockchain_Query.list_filtered_transaction_events
— Methodlist_filtered_transaction_events(address_identifier_filter, network)
list_filtered_transaction_events(address_identifier_filter, network, params::Dict{String,<:Any})
Lists all the transaction events for an address on the blockchain. This operation is only supported on the Bitcoin networks.
Arguments
address_identifier_filter
: This is the unique public address on the blockchain for which the transaction events are being requested.network
: The blockchain network where the transaction occurred. Valid Values: BITCOINMAINNET | BITCOINTESTNET
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"confirmationStatusFilter"
:"maxResults"
: The maximum number of transaction events to list. Default: 100 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"nextToken"
: The pagination token that indicates the next set of results to retrieve."sort"
: The order by which the results will be sorted."timeFilter"
: This container specifies the time frame for the transaction events returned in the response."voutFilter"
: This container specifies filtering attributes related to BITCOIN_VOUT event types
Main.Managedblockchain_Query.list_token_balances
— Methodlist_token_balances(token_filter)
list_token_balances(token_filter, params::Dict{String,<:Any})
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. You must always specify the network property of the tokenFilter when using this operation.
Arguments
token_filter
: The contract address or a token identifier on the blockchain network by which to filter the request. You must specify the contractAddress property of this container when listing tokens minted by a contract. You must always specify the network property of this container when using this operation.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of token balances to return. Default: 100 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"nextToken"
: The pagination token that indicates the next set of results to retrieve."ownerFilter"
: The contract or wallet address on the blockchain network by which to filter the request. You must specify the address property of the ownerFilter when listing balances of tokens owned by the address.
Main.Managedblockchain_Query.list_transaction_events
— Methodlist_transaction_events(network)
list_transaction_events(network, params::Dict{String,<:Any})
Lists all the transaction events for a transaction This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.
Arguments
network
: The blockchain network where the transaction events occurred.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of transaction events to list. Default: 100 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"nextToken"
: The pagination token that indicates the next set of results to retrieve."transactionHash"
: The hash of a transaction. It is generated when a transaction is created."transactionId"
: The identifier of a Bitcoin transaction. It is generated when a transaction is created. transactionId is only supported on the Bitcoin networks.
Main.Managedblockchain_Query.list_transactions
— Methodlist_transactions(address, network)
list_transactions(address, network, params::Dict{String,<:Any})
Lists all the transaction events for a transaction.
Arguments
address
: The address (either a contract or wallet), whose transactions are being requested.network
: The blockchain network where the transactions occurred.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"confirmationStatusFilter"
: This filter is used to include transactions in the response that haven't reached finality . Transactions that have reached finality are always part of the response."fromBlockchainInstant"
:"maxResults"
: The maximum number of transactions to list. Default: 100 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"nextToken"
: The pagination token that indicates the next set of results to retrieve."sort"
: The order by which the results will be sorted."toBlockchainInstant"
: