io.blockfrost.sdk.api.AddressService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of blockfrost-java Show documentation
Java SDK for the Blockfrost.io API
There is a newer version: 0.1.3
package io.blockfrost.sdk.api;

import io.blockfrost.sdk.api.exception.APIException;
import io.blockfrost.sdk.api.model.Address;
import io.blockfrost.sdk.api.model.AddressTotal;
import io.blockfrost.sdk.api.model.AddressTransaction;
import io.blockfrost.sdk.api.model.AddressUtxo;
import io.blockfrost.sdk.api.util.OrderEnum;

import java.util.List;

public interface AddressService {

    /**
     * Specific address
     * Obtain information about a specific address.
     *
     * @param address Bech32 address. (required)
     * @return Address
     */
    Address getAddress(String address) throws APIException;

    /**
     * Address total
     * Obtain details about an address.
     *
     * @param address Bech32 address. (required)
     * @return AddressTotal
     */
    AddressTotal getAddressDetails(String address) throws APIException;

    /**
     * Address UTXOs
     * UTXOs of the address.
     *
     * @param address Bech32 address. (required)
     * @param count   The number of results displayed on one page.
     * @param page    The page number for listing the results.
     * @param order   Ordered by tx index in the block. The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     * @return List<AddressUtxo>
     */
    List getAddressUtxos(String address, int count, int page, OrderEnum order) throws APIException;

    /**
     * Address UTXOs
     * UTXOs of the address ascending ordered by tx index in the block.
     *
     * @param address Bech32 address. (required)
     * @param count   The number of results displayed on one page.
     * @param page    The page number for listing the results.
     * @return List<AddressUtxo>
     */
    List getAddressUtxos(String address, int count, int page) throws APIException;

    /**
     * Address UTXOs
     * All UTXOs of the address.
     *
     * @param address Bech32 address. (required)
     * @param order   Ordered by tx index in the block. The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.     *
     * @return List<AddressUtxo>
     */
    List getAllAddressUtxos(String address, OrderEnum order) throws APIException;

    /**
     * Address UTXOs
     * All UTXOs of the address ascending ordered by tx index in the block.
     *
     * @param address Bech32 address. (required)
     * @return List<AddressUtxo>
     */
    List getAllAddressUtxos(String address) throws APIException;

    /**
     * Address transactions
     * Transactions on the address.
     *
     * @param address Bech32 address. (required)
     * @param count   The numbers of pools per page.
     * @param page    The page number for listing the results.
     * @param order   The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     * @return
     * @throws APIException
     */
    List getAddressTransactions(String address, int count, int page, OrderEnum order) throws APIException;

    /**
     * Address transactions
     * Transactions on the address.
     *
     * @param address Bech32 address. (required)
     * @param count   The numbers of pools per page.
     * @param page    The page number for listing the results.
     * @param order   The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     * @param from    The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. Has to be lower than or equal to `to` parameter.
     * @param to      The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. Has to be higher than or equal to `from` parameter.
     * @return List<AddressTransaction>
     */

    List getAddressTransactions(String address, int count, int page, OrderEnum order, String from, String to) throws APIException;

    /**
     * Address transactions
     * Transactions on the address in ascending order from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param address Bech32 address. (required)
     * @param count   The numbers of pools per page.
     * @param page    The page number for listing the results.
     * @param from    The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. Has to be lower than or equal to `to` parameter.
     * @param to      The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. Has to be higher than or equal to `from` parameter.
     * @return List<AddressTransaction>
     */

    List getAddressTransactions(String address, int count, int page, String from, String to) throws APIException;

    /**
     * Address transactions
     * Transactions on the address.
     *
     * @param address Bech32 address. (required)
     * @param order   The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     * @param from    The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. Has to be lower than or equal to `to` parameter.
     * @param to      The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. Has to be higher than or equal to `from` parameter.
     * @return List<AddressTransaction>
     */
    List getAddressTransactions(String address, OrderEnum order, String from, String to) throws APIException;

    /**
     * Address transactions
     * Transactions on the address in ascending order from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param address Bech32 address. (required)
     * @param from    The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. Has to be lower than or equal to `to` parameter.
     * @param to      The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. Has to be higher than or equal to `from` parameter.
     * @return List<AddressTransaction>
     */
    List getAddressTransactions(String address, String from, String to) throws APIException;


}