blockfrost.api.CardanoAccountsApi

Load the API package

import 'package:blockfrost/api.dart';

All URIs are relative to https://cardano-mainnet.blockfrost.io/api/v0

Method	HTTP request	Description
accountsStakeAddressAddressesAssetsGet	GET /accounts/{stake_address}/addresses/assets	Assets associated with the account addresses
accountsStakeAddressAddressesGet	GET /accounts/{stake_address}/addresses	Account associated addresses
accountsStakeAddressAddressesTotalGet	GET /accounts/{stake_address}/addresses/total	Detailed information about account associated addresses
accountsStakeAddressDelegationsGet	GET /accounts/{stake_address}/delegations	Account delegation history
accountsStakeAddressGet	GET /accounts/{stake_address}	Specific account address
accountsStakeAddressHistoryGet	GET /accounts/{stake_address}/history	Account history
accountsStakeAddressMirsGet	GET /accounts/{stake_address}/mirs	Account MIR history
accountsStakeAddressRegistrationsGet	GET /accounts/{stake_address}/registrations	Account registration history
accountsStakeAddressRewardsGet	GET /accounts/{stake_address}/rewards	Account reward history
accountsStakeAddressWithdrawalsGet	GET /accounts/{stake_address}/withdrawals	Account withdrawal history

accountsStakeAddressAddressesAssetsGet

BuiltList accountsStakeAddressAddressesAssetsGet(stakeAddress, count, page, order)

Assets associated with the account addresses

Obtain information about assets associated with addresses of a specific account. Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressAddressesAssetsGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressAddressesAssetsGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountAddressesAssetsInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressAddressesGet

BuiltList accountsStakeAddressAddressesGet(stakeAddress, count, page, order)

Account associated addresses

Obtain information about the addresses of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressAddressesGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressAddressesGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountAddressesContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressAddressesTotalGet

AccountAddressesTotal accountsStakeAddressAddressesTotalGet(stakeAddress)

Detailed information about account associated addresses

Obtain summed details about all addresses associated with a given account. Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz; // String | Bech32 address.

try {
    final response = api.accountsStakeAddressAddressesTotalGet(stakeAddress);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressAddressesTotalGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 address.

Return type

AccountAddressesTotal

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressDelegationsGet

BuiltList accountsStakeAddressDelegationsGet(stakeAddress, count, page, order)

Account delegation history

Obtain information about the delegation of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressDelegationsGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressDelegationsGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountDelegationContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressGet

AccountContent accountsStakeAddressGet(stakeAddress)

Specific account address

Obtain information about a specific stake account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.

try {
    final response = api.accountsStakeAddressGet(stakeAddress);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.

Return type

AccountContent

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressHistoryGet

BuiltList accountsStakeAddressHistoryGet(stakeAddress, count, page, order)

Account history

Obtain information about the history of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressHistoryGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressHistoryGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountHistoryContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressMirsGet

BuiltList accountsStakeAddressMirsGet(stakeAddress, count, page, order)

Account MIR history

Obtain information about the MIRs of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressMirsGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressMirsGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountMirContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressRegistrationsGet

BuiltList accountsStakeAddressRegistrationsGet(stakeAddress, count, page, order)

Account registration history

Obtain information about the registrations and deregistrations of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressRegistrationsGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressRegistrationsGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountRegistrationContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressRewardsGet

BuiltList accountsStakeAddressRewardsGet(stakeAddress, count, page, order)

Account reward history

Obtain information about the reward history of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressRewardsGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressRewardsGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountRewardContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountsStakeAddressWithdrawalsGet

BuiltList accountsStakeAddressWithdrawalsGet(stakeAddress, count, page, order)

Account withdrawal history

Obtain information about the withdrawals of a specific account.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoAccountsApi();
final String stakeAddress = stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc; // String | Bech32 stake address.
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.accountsStakeAddressWithdrawalsGet(stakeAddress, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoAccountsApi->accountsStakeAddressWithdrawalsGet: $e\n');
}

Parameters

Name	Type	Description	Notes
stakeAddress	String	Bech32 stake address.
count	int	The number of results displayed on one page.	[optional] [default to 100]
page	int	The page number for listing the results.	[optional] [default to 1]
order	String	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 type

BuiltList<AccountWithdrawalContentInner>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

CardanoAccountsApi.md

Latest commit

History

CardanoAccountsApi.md

File metadata and controls

blockfrost.api.CardanoAccountsApi

Load the API package

accountsStakeAddressAddressesAssetsGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressAddressesGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressAddressesTotalGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressDelegationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressHistoryGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressMirsGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressRegistrationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressRewardsGet

Example

Parameters

Return type

Authorization

HTTP request headers

accountsStakeAddressWithdrawalsGet

Example

Parameters

Return type

Authorization

HTTP request headers