io.nem.symbol.sdk.openapi.jersey2.api

Class TransactionRoutesApi

java.lang.Object

io.nem.symbol.sdk.openapi.jersey2.api.TransactionRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-11-12T11:58:50.284Z[UTC]")
public class TransactionRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TransactionRoutesApi()
TransactionRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AnnounceTransactionInfoDTO	announceCosignatureTransaction(Cosignature cosignature) Announce a cosignature transaction Announces a cosignature transaction to the network.
ApiResponse<AnnounceTransactionInfoDTO>	announceCosignatureTransactionWithHttpInfo(Cosignature cosignature) Announce a cosignature transaction Announces a cosignature transaction to the network.
AnnounceTransactionInfoDTO	announcePartialTransaction(TransactionPayload transactionPayload) Announce an aggregate bonded transaction Announces an aggregate bonded transaction to the network.
ApiResponse<AnnounceTransactionInfoDTO>	announcePartialTransactionWithHttpInfo(TransactionPayload transactionPayload) Announce an aggregate bonded transaction Announces an aggregate bonded transaction to the network.
AnnounceTransactionInfoDTO	announceTransaction(TransactionPayload transactionPayload) Announce a new transaction Announces a transaction to the network.
ApiResponse<AnnounceTransactionInfoDTO>	announceTransactionWithHttpInfo(TransactionPayload transactionPayload) Announce a new transaction Announces a transaction to the network.
ApiClient	getApiClient()
TransactionInfoDTO	getConfirmedTransaction(java.lang.String transactionId) Get confirmed transaction information Returns confirmed transaction information given a transactionId or hash.
java.util.List<TransactionInfoDTO>	getConfirmedTransactions(TransactionIds transactionIds) Get confirmed trasactions information Returns confirmed transactions information for a given array of transactionIds.
ApiResponse<java.util.List<TransactionInfoDTO>>	getConfirmedTransactionsWithHttpInfo(TransactionIds transactionIds) Get confirmed trasactions information Returns confirmed transactions information for a given array of transactionIds.
ApiResponse<TransactionInfoDTO>	getConfirmedTransactionWithHttpInfo(java.lang.String transactionId) Get confirmed transaction information Returns confirmed transaction information given a transactionId or hash.
TransactionInfoDTO	getPartialTransaction(java.lang.String transactionId) Get partial transaction information Returns partial transaction information given a transactionId or hash.
java.util.List<TransactionInfoDTO>	getPartialTransactions(TransactionIds transactionIds) Get partial trasactions information Returns partial transactions information for a given array of transactionIds.
ApiResponse<java.util.List<TransactionInfoDTO>>	getPartialTransactionsWithHttpInfo(TransactionIds transactionIds) Get partial trasactions information Returns partial transactions information for a given array of transactionIds.
ApiResponse<TransactionInfoDTO>	getPartialTransactionWithHttpInfo(java.lang.String transactionId) Get partial transaction information Returns partial transaction information given a transactionId or hash.
TransactionInfoDTO	getUnconfirmedTransaction(java.lang.String transactionId) Get unconfirmed transaction information Returns unconfirmed transaction information given a transactionId or hash.
java.util.List<TransactionInfoDTO>	getUnconfirmedTransactions(TransactionIds transactionIds) Get unconfirmed trasactions information Returns unconfirmed transactions information for a given array of transactionIds.
ApiResponse<java.util.List<TransactionInfoDTO>>	getUnconfirmedTransactionsWithHttpInfo(TransactionIds transactionIds) Get unconfirmed trasactions information Returns unconfirmed transactions information for a given array of transactionIds.
ApiResponse<TransactionInfoDTO>	getUnconfirmedTransactionWithHttpInfo(java.lang.String transactionId) Get unconfirmed transaction information Returns unconfirmed transaction information given a transactionId or hash.
TransactionPage	searchConfirmedTransactions(java.lang.String address, java.lang.String recipientAddress, java.lang.String signerPublicKey, java.math.BigInteger height, java.math.BigInteger fromHeight, java.math.BigInteger toHeight, java.math.BigInteger fromTransferAmount, java.math.BigInteger toTransferAmount, java.util.List<TransactionTypeEnum> type, java.lang.Boolean embedded, java.lang.String transferMosaicId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search confirmed transactions Returns an array of confirmed transactions.
ApiResponse<TransactionPage>	searchConfirmedTransactionsWithHttpInfo(java.lang.String address, java.lang.String recipientAddress, java.lang.String signerPublicKey, java.math.BigInteger height, java.math.BigInteger fromHeight, java.math.BigInteger toHeight, java.math.BigInteger fromTransferAmount, java.math.BigInteger toTransferAmount, java.util.List<TransactionTypeEnum> type, java.lang.Boolean embedded, java.lang.String transferMosaicId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search confirmed transactions Returns an array of confirmed transactions.
TransactionPage	searchPartialTransactions(java.lang.String address, java.lang.String recipientAddress, java.lang.String signerPublicKey, java.math.BigInteger height, java.math.BigInteger fromHeight, java.math.BigInteger toHeight, java.math.BigInteger fromTransferAmount, java.math.BigInteger toTransferAmount, java.util.List<TransactionTypeEnum> type, java.lang.Boolean embedded, java.lang.String transferMosaicId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search partial transactions Returns an array of partial transactions.
ApiResponse<TransactionPage>	searchPartialTransactionsWithHttpInfo(java.lang.String address, java.lang.String recipientAddress, java.lang.String signerPublicKey, java.math.BigInteger height, java.math.BigInteger fromHeight, java.math.BigInteger toHeight, java.math.BigInteger fromTransferAmount, java.math.BigInteger toTransferAmount, java.util.List<TransactionTypeEnum> type, java.lang.Boolean embedded, java.lang.String transferMosaicId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search partial transactions Returns an array of partial transactions.
TransactionPage	searchUnconfirmedTransactions(java.lang.String address, java.lang.String recipientAddress, java.lang.String signerPublicKey, java.math.BigInteger height, java.math.BigInteger fromHeight, java.math.BigInteger toHeight, java.math.BigInteger fromTransferAmount, java.math.BigInteger toTransferAmount, java.util.List<TransactionTypeEnum> type, java.lang.Boolean embedded, java.lang.String transferMosaicId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search unconfirmed transactions Returns an array of unconfirmed transactions.
ApiResponse<TransactionPage>	searchUnconfirmedTransactionsWithHttpInfo(java.lang.String address, java.lang.String recipientAddress, java.lang.String signerPublicKey, java.math.BigInteger height, java.math.BigInteger fromHeight, java.math.BigInteger toHeight, java.math.BigInteger fromTransferAmount, java.math.BigInteger toTransferAmount, java.util.List<TransactionTypeEnum> type, java.lang.Boolean embedded, java.lang.String transferMosaicId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search unconfirmed transactions Returns an array of unconfirmed transactions.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionRoutesApi

public TransactionRoutesApi()

TransactionRoutesApi

public TransactionRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

announceCosignatureTransaction

public AnnounceTransactionInfoDTO announceCosignatureTransaction(Cosignature cosignature)
                                                          throws ApiException

Announce a cosignature transaction Announces a cosignature transaction to the network.

Parameters:

cosignature - (required)

Returns:

AnnounceTransactionInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
202	success	-
400	InvalidContent	-
409	InvalidArgument	-

announceCosignatureTransactionWithHttpInfo

public ApiResponse<AnnounceTransactionInfoDTO> announceCosignatureTransactionWithHttpInfo(Cosignature cosignature)
                                                                                   throws ApiException

Announce a cosignature transaction Announces a cosignature transaction to the network.

Parameters:

cosignature - (required)

Returns:

ApiResponse<AnnounceTransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
202	success	-
400	InvalidContent	-
409	InvalidArgument	-

announcePartialTransaction

public AnnounceTransactionInfoDTO announcePartialTransaction(TransactionPayload transactionPayload)
                                                      throws ApiException

Announce an aggregate bonded transaction Announces an aggregate bonded transaction to the network.

Parameters:

transactionPayload - (required)

Returns:

AnnounceTransactionInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
202	success	-
400	InvalidContent	-
409	InvalidArgument	-

announcePartialTransactionWithHttpInfo

public ApiResponse<AnnounceTransactionInfoDTO> announcePartialTransactionWithHttpInfo(TransactionPayload transactionPayload)
                                                                               throws ApiException

Announce an aggregate bonded transaction Announces an aggregate bonded transaction to the network.

Parameters:

transactionPayload - (required)

Returns:

ApiResponse<AnnounceTransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
202	success	-
400	InvalidContent	-
409	InvalidArgument	-

announceTransaction

public AnnounceTransactionInfoDTO announceTransaction(TransactionPayload transactionPayload)
                                               throws ApiException

Announce a new transaction Announces a transaction to the network. The [catbuffer library](https://github.com/nemtech/catbuffer) defines the protocol to serialize and deserialize Symbol entities. Catbuffers are integrated into [Symbol SDKs](https://nemtech.github.io/sdk.html). It's recommended to use SDKs instead of calling the API endpoint directly to announce transactions.

Parameters:

transactionPayload - (required)

Returns:

AnnounceTransactionInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
202	success	-
400	InvalidContent	-
409	InvalidArgument	-

announceTransactionWithHttpInfo

public ApiResponse<AnnounceTransactionInfoDTO> announceTransactionWithHttpInfo(TransactionPayload transactionPayload)
                                                                        throws ApiException

Announce a new transaction Announces a transaction to the network. The [catbuffer library](https://github.com/nemtech/catbuffer) defines the protocol to serialize and deserialize Symbol entities. Catbuffers are integrated into [Symbol SDKs](https://nemtech.github.io/sdk.html). It's recommended to use SDKs instead of calling the API endpoint directly to announce transactions.

Parameters:

transactionPayload - (required)

Returns:

ApiResponse<AnnounceTransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
202	success	-
400	InvalidContent	-
409	InvalidArgument	-

getConfirmedTransaction

public TransactionInfoDTO getConfirmedTransaction(java.lang.String transactionId)
                                           throws ApiException

Get confirmed transaction information Returns confirmed transaction information given a transactionId or hash.

Parameters:

transactionId - Transaction id or hash. (required)

Returns:

TransactionInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getConfirmedTransactionWithHttpInfo

public ApiResponse<TransactionInfoDTO> getConfirmedTransactionWithHttpInfo(java.lang.String transactionId)
                                                                    throws ApiException

Get confirmed transaction information Returns confirmed transaction information given a transactionId or hash.

Parameters:

transactionId - Transaction id or hash. (required)

Returns:

ApiResponse<TransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getConfirmedTransactions

public java.util.List<TransactionInfoDTO> getConfirmedTransactions(TransactionIds transactionIds)
                                                            throws ApiException

Get confirmed trasactions information Returns confirmed transactions information for a given array of transactionIds.

Parameters:

transactionIds - (required)

Returns:

List<TransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getConfirmedTransactionsWithHttpInfo

public ApiResponse<java.util.List<TransactionInfoDTO>> getConfirmedTransactionsWithHttpInfo(TransactionIds transactionIds)
                                                                                     throws ApiException

Get confirmed trasactions information Returns confirmed transactions information for a given array of transactionIds.

Parameters:

transactionIds - (required)

Returns:

ApiResponse<List<TransactionInfoDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getPartialTransaction

public TransactionInfoDTO getPartialTransaction(java.lang.String transactionId)
                                         throws ApiException

Get partial transaction information Returns partial transaction information given a transactionId or hash.

Parameters:

transactionId - Transaction id or hash. (required)

Returns:

TransactionInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getPartialTransactionWithHttpInfo

public ApiResponse<TransactionInfoDTO> getPartialTransactionWithHttpInfo(java.lang.String transactionId)
                                                                  throws ApiException

Get partial transaction information Returns partial transaction information given a transactionId or hash.

Parameters:

transactionId - Transaction id or hash. (required)

Returns:

ApiResponse<TransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getPartialTransactions

public java.util.List<TransactionInfoDTO> getPartialTransactions(TransactionIds transactionIds)
                                                          throws ApiException

Get partial trasactions information Returns partial transactions information for a given array of transactionIds.

Parameters:

transactionIds - (required)

Returns:

List<TransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getPartialTransactionsWithHttpInfo

public ApiResponse<java.util.List<TransactionInfoDTO>> getPartialTransactionsWithHttpInfo(TransactionIds transactionIds)
                                                                                   throws ApiException

Get partial trasactions information Returns partial transactions information for a given array of transactionIds.

Parameters:

transactionIds - (required)

Returns:

ApiResponse<List<TransactionInfoDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getUnconfirmedTransaction

public TransactionInfoDTO getUnconfirmedTransaction(java.lang.String transactionId)
                                             throws ApiException

Get unconfirmed transaction information Returns unconfirmed transaction information given a transactionId or hash.

Parameters:

transactionId - Transaction id or hash. (required)

Returns:

TransactionInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getUnconfirmedTransactionWithHttpInfo

public ApiResponse<TransactionInfoDTO> getUnconfirmedTransactionWithHttpInfo(java.lang.String transactionId)
                                                                      throws ApiException

Get unconfirmed transaction information Returns unconfirmed transaction information given a transactionId or hash.

Parameters:

transactionId - Transaction id or hash. (required)

Returns:

ApiResponse<TransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getUnconfirmedTransactions

public java.util.List<TransactionInfoDTO> getUnconfirmedTransactions(TransactionIds transactionIds)
                                                              throws ApiException

Get unconfirmed trasactions information Returns unconfirmed transactions information for a given array of transactionIds.

Parameters:

transactionIds - (required)

Returns:

List<TransactionInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getUnconfirmedTransactionsWithHttpInfo

public ApiResponse<java.util.List<TransactionInfoDTO>> getUnconfirmedTransactionsWithHttpInfo(TransactionIds transactionIds)
                                                                                       throws ApiException

Get unconfirmed trasactions information Returns unconfirmed transactions information for a given array of transactionIds.

Parameters:

transactionIds - (required)

Returns:

ApiResponse<List<TransactionInfoDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

searchConfirmedTransactions

public TransactionPage searchConfirmedTransactions(java.lang.String address,
                                                   java.lang.String recipientAddress,
                                                   java.lang.String signerPublicKey,
                                                   java.math.BigInteger height,
                                                   java.math.BigInteger fromHeight,
                                                   java.math.BigInteger toHeight,
                                                   java.math.BigInteger fromTransferAmount,
                                                   java.math.BigInteger toTransferAmount,
                                                   java.util.List<TransactionTypeEnum> type,
                                                   java.lang.Boolean embedded,
                                                   java.lang.String transferMosaicId,
                                                   java.lang.Integer pageSize,
                                                   java.lang.Integer pageNumber,
                                                   java.lang.String offset,
                                                   Order order)
                                            throws ApiException

Search confirmed transactions Returns an array of confirmed transactions. If a transaction was announced with an alias rather than an address, the address that will be considered when querying is the one that was resolved from the alias at confirmation time.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

recipientAddress - Filter by address of the account receiving the transaction. (optional)

signerPublicKey - Filter by public key of the account signing the entity. (optional)

height - Filter by block height. (optional, default to null)

fromHeight - Only blocks with height greater or equal than this one are returned. (optional, default to null)

toHeight - Only blocks with height smaller or equal than this one are returned. (optional, default to null)

fromTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned. (optional, default to null)

toTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned. (optional, default to null)

type - Filter by transaction type. To filter by multiple transaction types, add more filter query params like: ``type=16974&type=16718``. (optional, default to new ArrayList<>())

embedded - When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. **Note:** This field does not work when combined with the ``address`` parameter. This is, embedded transactions containing the address specified through the ``address`` parameter will not be returned even when used with ``embedded=true``. There is no problem when using other parameters like ``recipientAddress`` instead. (optional, default to false)

transferMosaicId - Filters transactions involving a specific ``mosaicId``. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

TransactionPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchConfirmedTransactionsWithHttpInfo

public ApiResponse<TransactionPage> searchConfirmedTransactionsWithHttpInfo(java.lang.String address,
                                                                            java.lang.String recipientAddress,
                                                                            java.lang.String signerPublicKey,
                                                                            java.math.BigInteger height,
                                                                            java.math.BigInteger fromHeight,
                                                                            java.math.BigInteger toHeight,
                                                                            java.math.BigInteger fromTransferAmount,
                                                                            java.math.BigInteger toTransferAmount,
                                                                            java.util.List<TransactionTypeEnum> type,
                                                                            java.lang.Boolean embedded,
                                                                            java.lang.String transferMosaicId,
                                                                            java.lang.Integer pageSize,
                                                                            java.lang.Integer pageNumber,
                                                                            java.lang.String offset,
                                                                            Order order)
                                                                     throws ApiException

Search confirmed transactions Returns an array of confirmed transactions. If a transaction was announced with an alias rather than an address, the address that will be considered when querying is the one that was resolved from the alias at confirmation time.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

recipientAddress - Filter by address of the account receiving the transaction. (optional)

signerPublicKey - Filter by public key of the account signing the entity. (optional)

height - Filter by block height. (optional, default to null)

fromHeight - Only blocks with height greater or equal than this one are returned. (optional, default to null)

toHeight - Only blocks with height smaller or equal than this one are returned. (optional, default to null)

fromTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned. (optional, default to null)

toTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned. (optional, default to null)

type - Filter by transaction type. To filter by multiple transaction types, add more filter query params like: ``type=16974&type=16718``. (optional, default to new ArrayList<>())

embedded - When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. **Note:** This field does not work when combined with the ``address`` parameter. This is, embedded transactions containing the address specified through the ``address`` parameter will not be returned even when used with ``embedded=true``. There is no problem when using other parameters like ``recipientAddress`` instead. (optional, default to false)

transferMosaicId - Filters transactions involving a specific ``mosaicId``. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

ApiResponse<TransactionPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchPartialTransactions

public TransactionPage searchPartialTransactions(java.lang.String address,
                                                 java.lang.String recipientAddress,
                                                 java.lang.String signerPublicKey,
                                                 java.math.BigInteger height,
                                                 java.math.BigInteger fromHeight,
                                                 java.math.BigInteger toHeight,
                                                 java.math.BigInteger fromTransferAmount,
                                                 java.math.BigInteger toTransferAmount,
                                                 java.util.List<TransactionTypeEnum> type,
                                                 java.lang.Boolean embedded,
                                                 java.lang.String transferMosaicId,
                                                 java.lang.Integer pageSize,
                                                 java.lang.Integer pageNumber,
                                                 java.lang.String offset,
                                                 Order order)
                                          throws ApiException

Search partial transactions Returns an array of partial transactions.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

recipientAddress - Filter by address of the account receiving the transaction. (optional)

signerPublicKey - Filter by public key of the account signing the entity. (optional)

height - Filter by block height. (optional, default to null)

fromHeight - Only blocks with height greater or equal than this one are returned. (optional, default to null)

toHeight - Only blocks with height smaller or equal than this one are returned. (optional, default to null)

fromTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned. (optional, default to null)

toTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned. (optional, default to null)

type - Filter by transaction type. To filter by multiple transaction types, add more filter query params like: ``type=16974&type=16718``. (optional, default to new ArrayList<>())

embedded - When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. **Note:** This field does not work when combined with the ``address`` parameter. This is, embedded transactions containing the address specified through the ``address`` parameter will not be returned even when used with ``embedded=true``. There is no problem when using other parameters like ``recipientAddress`` instead. (optional, default to false)

transferMosaicId - Filters transactions involving a specific ``mosaicId``. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

TransactionPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchPartialTransactionsWithHttpInfo

public ApiResponse<TransactionPage> searchPartialTransactionsWithHttpInfo(java.lang.String address,
                                                                          java.lang.String recipientAddress,
                                                                          java.lang.String signerPublicKey,
                                                                          java.math.BigInteger height,
                                                                          java.math.BigInteger fromHeight,
                                                                          java.math.BigInteger toHeight,
                                                                          java.math.BigInteger fromTransferAmount,
                                                                          java.math.BigInteger toTransferAmount,
                                                                          java.util.List<TransactionTypeEnum> type,
                                                                          java.lang.Boolean embedded,
                                                                          java.lang.String transferMosaicId,
                                                                          java.lang.Integer pageSize,
                                                                          java.lang.Integer pageNumber,
                                                                          java.lang.String offset,
                                                                          Order order)
                                                                   throws ApiException

Search partial transactions Returns an array of partial transactions.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

recipientAddress - Filter by address of the account receiving the transaction. (optional)

signerPublicKey - Filter by public key of the account signing the entity. (optional)

height - Filter by block height. (optional, default to null)

fromHeight - Only blocks with height greater or equal than this one are returned. (optional, default to null)

toHeight - Only blocks with height smaller or equal than this one are returned. (optional, default to null)

fromTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned. (optional, default to null)

toTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned. (optional, default to null)

type - Filter by transaction type. To filter by multiple transaction types, add more filter query params like: ``type=16974&type=16718``. (optional, default to new ArrayList<>())

embedded - When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. **Note:** This field does not work when combined with the ``address`` parameter. This is, embedded transactions containing the address specified through the ``address`` parameter will not be returned even when used with ``embedded=true``. There is no problem when using other parameters like ``recipientAddress`` instead. (optional, default to false)

transferMosaicId - Filters transactions involving a specific ``mosaicId``. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

ApiResponse<TransactionPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchUnconfirmedTransactions

public TransactionPage searchUnconfirmedTransactions(java.lang.String address,
                                                     java.lang.String recipientAddress,
                                                     java.lang.String signerPublicKey,
                                                     java.math.BigInteger height,
                                                     java.math.BigInteger fromHeight,
                                                     java.math.BigInteger toHeight,
                                                     java.math.BigInteger fromTransferAmount,
                                                     java.math.BigInteger toTransferAmount,
                                                     java.util.List<TransactionTypeEnum> type,
                                                     java.lang.Boolean embedded,
                                                     java.lang.String transferMosaicId,
                                                     java.lang.Integer pageSize,
                                                     java.lang.Integer pageNumber,
                                                     java.lang.String offset,
                                                     Order order)
                                              throws ApiException

Search unconfirmed transactions Returns an array of unconfirmed transactions.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

recipientAddress - Filter by address of the account receiving the transaction. (optional)

signerPublicKey - Filter by public key of the account signing the entity. (optional)

height - Filter by block height. (optional, default to null)

fromHeight - Only blocks with height greater or equal than this one are returned. (optional, default to null)

toHeight - Only blocks with height smaller or equal than this one are returned. (optional, default to null)

fromTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned. (optional, default to null)

toTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned. (optional, default to null)

type - Filter by transaction type. To filter by multiple transaction types, add more filter query params like: ``type=16974&type=16718``. (optional, default to new ArrayList<>())

embedded - When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. **Note:** This field does not work when combined with the ``address`` parameter. This is, embedded transactions containing the address specified through the ``address`` parameter will not be returned even when used with ``embedded=true``. There is no problem when using other parameters like ``recipientAddress`` instead. (optional, default to false)

transferMosaicId - Filters transactions involving a specific ``mosaicId``. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

TransactionPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchUnconfirmedTransactionsWithHttpInfo

public ApiResponse<TransactionPage> searchUnconfirmedTransactionsWithHttpInfo(java.lang.String address,
                                                                              java.lang.String recipientAddress,
                                                                              java.lang.String signerPublicKey,
                                                                              java.math.BigInteger height,
                                                                              java.math.BigInteger fromHeight,
                                                                              java.math.BigInteger toHeight,
                                                                              java.math.BigInteger fromTransferAmount,
                                                                              java.math.BigInteger toTransferAmount,
                                                                              java.util.List<TransactionTypeEnum> type,
                                                                              java.lang.Boolean embedded,
                                                                              java.lang.String transferMosaicId,
                                                                              java.lang.Integer pageSize,
                                                                              java.lang.Integer pageNumber,
                                                                              java.lang.String offset,
                                                                              Order order)
                                                                       throws ApiException

Search unconfirmed transactions Returns an array of unconfirmed transactions.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

recipientAddress - Filter by address of the account receiving the transaction. (optional)

signerPublicKey - Filter by public key of the account signing the entity. (optional)

height - Filter by block height. (optional, default to null)

fromHeight - Only blocks with height greater or equal than this one are returned. (optional, default to null)

toHeight - Only blocks with height smaller or equal than this one are returned. (optional, default to null)

fromTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned. (optional, default to null)

toTransferAmount - Requires providing the `transferMosaicId` filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned. (optional, default to null)

type - Filter by transaction type. To filter by multiple transaction types, add more filter query params like: ``type=16974&type=16718``. (optional, default to new ArrayList<>())

embedded - When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. **Note:** This field does not work when combined with the ``address`` parameter. This is, embedded transactions containing the address specified through the ``address`` parameter will not be returned even when used with ``embedded=true``. There is no problem when using other parameters like ``recipientAddress`` instead. (optional, default to false)

transferMosaicId - Filters transactions involving a specific ``mosaicId``. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

ApiResponse<TransactionPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-