io.blockfrost.sdk.api.AccountService Maven / Gradle / Ivy
package io.blockfrost.sdk.api;
import io.blockfrost.sdk.api.exception.APIException;
import io.blockfrost.sdk.api.model.*;
import io.blockfrost.sdk.api.util.OrderEnum;
import java.util.List;
/**
* Get account specific information
*/
public interface AccountService {
/**
* Obtain information about a specific networkStake account.
*
* @param stakeAddress Bech32 networkStake address. (required)
* @return Account
*/
public Account getAccountByStakeAddress(String stakeAddress) throws APIException;
/**
* Account history
* Obtain information about the history of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one 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 List<AccountHistory>
*/
public List getAccountHistory(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account history
* Obtain information about the history of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountHistory>
*/
public List getAccountHistory(String stakeAddress, int count, int page) throws APIException;
/**
* Account history
* Obtain information about the entire history of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountHistory>
*/
public List getEntireAccountHistory(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account history
* Obtain information about the entire history of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountHistory>
*/
public List getEntireAccountHistory(String stakeAddress) throws APIException;
/**
* Account reward history
* Obtain information about the history of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountRewardHistory>
*/
public List getAccountRewardHistory(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account reward history
* Obtain information about the history of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountRewardHistory>
*/
public List getAccountRewardHistory(String stakeAddress, int count, int page) throws APIException;
/**
* Account reward history
* Obtain information about the entire history of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountRewardHistory>
*/
public List getEntireAccountRewardHistory(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account reward history
* Obtain information about the entire history of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountRewardHistory>
*/
public List getEntireAccountRewardHistory(String stakeAddress) throws APIException;
/**
* Account delegation history
* Obtain information about the delegation of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountDelegationHistory>
*/
public List getAccountDelegationHistory(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account delegation history
* Obtain information about the delegation of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountDelegationHistory>
*/
public List getAccountDelegationHistory(String stakeAddress, int count, int page) throws APIException;
/**
* Account delegation history
* Obtain information about the delegation of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountDelegationHistory>
*/
public List getEntireAccountDelegationHistory(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account delegation history
* Obtain information about the delegation of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountDelegationHistory>
*/
public List getEntireAccountDelegationHistory(String stakeAddress) throws APIException;
/**
* Account registration history
* Obtain information about the registrations and deregistrations of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountRegistrationHistory>
*/
public List getAccountRegistrationHistory(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account registration history
* Obtain information about the registrations and deregistrations of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountRegistrationHistory>
*/
public List getAccountRegistrationHistory(String stakeAddress, int count, int page) throws APIException;
/**
* Account registration history
* Obtain information about all the registrations and deregistrations of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountRegistrationHistory>
*/
public List getEntireAccountRegistrationHistory(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account registration history
* Obtain information about all the registrations and deregistrations of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountRegistrationHistory>
*/
public List getEntireAccountRegistrationHistory(String stakeAddress) throws APIException;
/**
* Account withdrawal history
* Obtain information about the withdrawals of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountWithdrawalHistory>
*/
public List getAccountWithdrawalHistory(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account withdrawal history
* Obtain information about the withdrawals of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountWithdrawalHistory>
*/
public List getAccountWithdrawalHistory(String stakeAddress, int count, int page) throws APIException;
/**
* Account withdrawal history
* Obtain information about all the withdrawals of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountWithdrawalHistory>
*/
public List getEntireAccountWithdrawalHistory(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account withdrawal history
* Obtain information about all the withdrawals of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountWithdrawalHistory>
*/
public List getEntireAccountWithdrawalHistory(String stakeAddress) throws APIException;
/**
* Account MIR history
* Obtain information about the MIRs of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountMirHistory>
*/
public List getAccountMirHistory(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account MIR history
* Obtain information about the MIRs of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountMirHistory>
*/
public List getAccountMirHistory(String stakeAddress, int count, int page) throws APIException;
/**
* Account MIR history
* Obtain information about all the MIRs of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountMirHistory>
*/
public List getEntireAccountMirHistory(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account MIR history
* Obtain information about all the MIRs of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountMirHistory>
*/
public List getEntireAccountMirHistory(String stakeAddress) throws APIException;
/**
* Account associated addresses
* Obtain information about the addresses of a specific account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountAddress>
*/
public List getAccountAddresses(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Account associated addresses
* Obtain information about the addresses of a specific account 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 stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountAddress>
*/
public List getAccountAddresses(String stakeAddress, int count, int page) throws APIException;
/**
* Account associated addresses
* Obtain information about the addresses of a specific account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountAddress>
*/
public List getAllAccountAddresses(String stakeAddress, OrderEnum order) throws APIException;
/**
* Account associated addresses
* Obtain information about the addresses of a specific account 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 stakeAddress Bech32 stake address. (required)
* @return List<AccountAddress>
*/
public List getAllAccountAddresses(String stakeAddress) throws APIException;
/**
* Assets associated with the account addresses
* Obtain information about assets associated with addresses of a specific account.
* <b>Be careful</b>, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page. (optional, default to 100)
* @param page The page number for listing the results. (optional, default to 1)
* @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. (optional, default to asc)
* @return List<AccountAsset>
*/
public List getAccountAssets(String stakeAddress, int count, int page, OrderEnum order) throws APIException;
/**
* Assets associated with the account addresses
* Obtain information about assets associated with addresses of a specific account in ascending order from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
* <b>Be careful</b>, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
*
* @param stakeAddress Bech32 stake address. (required)
* @param count The number of results displayed on one page.
* @param page The page number for listing the results.
* @return List<AccountAsset>
*/
public List getAccountAssets(String stakeAddress, int count, int page) throws APIException;
/**
* Assets associated with the account addresses
* Obtain information about assets associated with addresses of a specific account.
* <b>Be careful</b>, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
*
* @param stakeAddress Bech32 stake 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.
* @return List<AccountAsset>
*/
public List getAllAccountAssets(String stakeAddress, OrderEnum order) throws APIException;
/**
* Assets associated with the account addresses
* Obtain information about assets associated with addresses of a specific account in ascending order from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
* <b>Be careful</b>, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
*
* @param stakeAddress Bech32 stake address. (required)
* @return List<AccountAsset>
*/
public List getAllAccountAssets(String stakeAddress) throws APIException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy