/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { AccessRegistryCurrentStateResponse2 } from '../models'; import { AccessRegistrySummaryResponse } from '../models'; import { ActiveRolesResponse2 } from '../models'; import { AddressBalancePagedResponse2 } from '../models'; import { BalanceHistoryPagedResponse2 } from '../models'; import { OnchainTransactionsPagedResponse2 } from '../models'; import { TokenContractSummaryResponse } from '../models'; import { TotalSupplyPagedResponse2 } from '../models'; /** * OnchainDataApi - axios parameter creator * @export */ export declare const OnchainDataApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the current state of addresses in the specified access registry. Only addresses that are currently active (added but not removed) are included. * @summary Get the current state of addresses in an access registry * @param {string} baseAssetId The blockchain base assetId * @param {string} accessRegistryAddress The access registry address * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetAccessRegistryCurrentStateSortByEnum} [sortBy] Sorting field (enum). * @param {GetAccessRegistryCurrentStateOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessRegistryCurrentState: (baseAssetId: string, accessRegistryAddress: string, pageCursor?: string, pageSize?: number, sortBy?: GetAccessRegistryCurrentStateSortByEnum, order?: GetAccessRegistryCurrentStateOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns a summary of the current state of the access registry for the specified baseAssetId and accessRegistryAddress. * @summary Summary of access registry state * @param {string} baseAssetId The blockchain base assetId * @param {string} accessRegistryAddress The access registry address * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessRegistrySummary: (baseAssetId: string, accessRegistryAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of currently active roles for the specified baseAssetId and contractAddress. * @summary List of active roles for a given contract address and base asset ID * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActiveRolesForContract: (baseAssetId: string, contractAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the paginated balance history of the specified account in a contract with optional date range and interval filtering. * @summary Get historical balance data for a specific account in a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} accountAddress The account address to get balance history for * @param {string} [startDate] Start date of the time range in ISO 8601 format * @param {string} [endDate] End date of the time range in ISO 8601 format * @param {GetContractBalanceHistoryIntervalEnum} [interval] Time interval for grouping data * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetContractBalanceHistorySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' * @param {GetContractBalanceHistoryOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractBalanceHistory: (baseAssetId: string, contractAddress: string, accountAddress: string, startDate?: string, endDate?: string, interval?: GetContractBalanceHistoryIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractBalanceHistorySortByEnum, order?: GetContractBalanceHistoryOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns the total number of unique addresses holding balances and the total supply for the specified contract. * @summary Get summary for the token contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractBalancesSummary: (baseAssetId: string, contractAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the paginated total supply history of the specified contract with optional date range and interval filtering. * @summary Get historical total supply data for a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} [startDate] Start date of the time range in ISO 8601 format * @param {string} [endDate] End date of the time range in ISO 8601 format * @param {GetContractTotalSupplyIntervalEnum} [interval] Time interval for grouping data * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetContractTotalSupplySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' * @param {GetContractTotalSupplyOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractTotalSupply: (baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, interval?: GetContractTotalSupplyIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractTotalSupplySortByEnum, order?: GetContractTotalSupplyOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns the latest balance for each unique address with support for numeric balance sorting. The `prev` cursor is reserved for future support. * @summary Get latest balances for all addresses holding tokens from a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} [accountAddress] Optional filter to get balance for a specific account address * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetLatestBalancesForContractSortByEnum} [sortBy] Sorting field for balances * @param {GetLatestBalancesForContractOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLatestBalancesForContract: (baseAssetId: string, contractAddress: string, accountAddress?: string, pageCursor?: string, pageSize?: number, sortBy?: GetLatestBalancesForContractSortByEnum, order?: GetLatestBalancesForContractOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of onchain transactions for the specified contract address and base asset ID, optionally filtered by date range. * @summary Fetch onchain transactions for a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} [startDate] Start date of the time range in ISO 8601 format * @param {string} [endDate] End date of the time range in ISO 8601 format * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetOnchainTransactionsSortByEnum} [sortBy] Sorting field (enum). * @param {GetOnchainTransactionsOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOnchainTransactions: (baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetOnchainTransactionsSortByEnum, order?: GetOnchainTransactionsOrderEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * OnchainDataApi - functional programming interface * @export */ export declare const OnchainDataApiFp: (configuration?: Configuration) => { /** * Returns the current state of addresses in the specified access registry. Only addresses that are currently active (added but not removed) are included. * @summary Get the current state of addresses in an access registry * @param {string} baseAssetId The blockchain base assetId * @param {string} accessRegistryAddress The access registry address * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetAccessRegistryCurrentStateSortByEnum} [sortBy] Sorting field (enum). * @param {GetAccessRegistryCurrentStateOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessRegistryCurrentState(baseAssetId: string, accessRegistryAddress: string, pageCursor?: string, pageSize?: number, sortBy?: GetAccessRegistryCurrentStateSortByEnum, order?: GetAccessRegistryCurrentStateOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a summary of the current state of the access registry for the specified baseAssetId and accessRegistryAddress. * @summary Summary of access registry state * @param {string} baseAssetId The blockchain base assetId * @param {string} accessRegistryAddress The access registry address * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessRegistrySummary(baseAssetId: string, accessRegistryAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of currently active roles for the specified baseAssetId and contractAddress. * @summary List of active roles for a given contract address and base asset ID * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActiveRolesForContract(baseAssetId: string, contractAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the paginated balance history of the specified account in a contract with optional date range and interval filtering. * @summary Get historical balance data for a specific account in a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} accountAddress The account address to get balance history for * @param {string} [startDate] Start date of the time range in ISO 8601 format * @param {string} [endDate] End date of the time range in ISO 8601 format * @param {GetContractBalanceHistoryIntervalEnum} [interval] Time interval for grouping data * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetContractBalanceHistorySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' * @param {GetContractBalanceHistoryOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractBalanceHistory(baseAssetId: string, contractAddress: string, accountAddress: string, startDate?: string, endDate?: string, interval?: GetContractBalanceHistoryIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractBalanceHistorySortByEnum, order?: GetContractBalanceHistoryOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the total number of unique addresses holding balances and the total supply for the specified contract. * @summary Get summary for the token contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractBalancesSummary(baseAssetId: string, contractAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the paginated total supply history of the specified contract with optional date range and interval filtering. * @summary Get historical total supply data for a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} [startDate] Start date of the time range in ISO 8601 format * @param {string} [endDate] End date of the time range in ISO 8601 format * @param {GetContractTotalSupplyIntervalEnum} [interval] Time interval for grouping data * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetContractTotalSupplySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' * @param {GetContractTotalSupplyOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractTotalSupply(baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, interval?: GetContractTotalSupplyIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractTotalSupplySortByEnum, order?: GetContractTotalSupplyOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the latest balance for each unique address with support for numeric balance sorting. The `prev` cursor is reserved for future support. * @summary Get latest balances for all addresses holding tokens from a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} [accountAddress] Optional filter to get balance for a specific account address * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetLatestBalancesForContractSortByEnum} [sortBy] Sorting field for balances * @param {GetLatestBalancesForContractOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLatestBalancesForContract(baseAssetId: string, contractAddress: string, accountAddress?: string, pageCursor?: string, pageSize?: number, sortBy?: GetLatestBalancesForContractSortByEnum, order?: GetLatestBalancesForContractOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of onchain transactions for the specified contract address and base asset ID, optionally filtered by date range. * @summary Fetch onchain transactions for a contract * @param {string} baseAssetId The blockchain base assetId * @param {string} contractAddress The contract address * @param {string} [startDate] Start date of the time range in ISO 8601 format * @param {string} [endDate] End date of the time range in ISO 8601 format * @param {string} [pageCursor] Page cursor to get the next page\" * @param {number} [pageSize] Number of items per page (max 100), requesting more then 100 will return 100 items * @param {GetOnchainTransactionsSortByEnum} [sortBy] Sorting field (enum). * @param {GetOnchainTransactionsOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOnchainTransactions(baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetOnchainTransactionsSortByEnum, order?: GetOnchainTransactionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OnchainDataApi - factory interface * @export */ export declare const OnchainDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the current state of addresses in the specified access registry. Only addresses that are currently active (added but not removed) are included. * @summary Get the current state of addresses in an access registry * @param {OnchainDataApiGetAccessRegistryCurrentStateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessRegistryCurrentState(requestParameters: OnchainDataApiGetAccessRegistryCurrentStateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a summary of the current state of the access registry for the specified baseAssetId and accessRegistryAddress. * @summary Summary of access registry state * @param {OnchainDataApiGetAccessRegistrySummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessRegistrySummary(requestParameters: OnchainDataApiGetAccessRegistrySummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of currently active roles for the specified baseAssetId and contractAddress. * @summary List of active roles for a given contract address and base asset ID * @param {OnchainDataApiGetActiveRolesForContractRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActiveRolesForContract(requestParameters: OnchainDataApiGetActiveRolesForContractRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the paginated balance history of the specified account in a contract with optional date range and interval filtering. * @summary Get historical balance data for a specific account in a contract * @param {OnchainDataApiGetContractBalanceHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractBalanceHistory(requestParameters: OnchainDataApiGetContractBalanceHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the total number of unique addresses holding balances and the total supply for the specified contract. * @summary Get summary for the token contract * @param {OnchainDataApiGetContractBalancesSummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractBalancesSummary(requestParameters: OnchainDataApiGetContractBalancesSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the paginated total supply history of the specified contract with optional date range and interval filtering. * @summary Get historical total supply data for a contract * @param {OnchainDataApiGetContractTotalSupplyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractTotalSupply(requestParameters: OnchainDataApiGetContractTotalSupplyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the latest balance for each unique address with support for numeric balance sorting. The `prev` cursor is reserved for future support. * @summary Get latest balances for all addresses holding tokens from a contract * @param {OnchainDataApiGetLatestBalancesForContractRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLatestBalancesForContract(requestParameters: OnchainDataApiGetLatestBalancesForContractRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of onchain transactions for the specified contract address and base asset ID, optionally filtered by date range. * @summary Fetch onchain transactions for a contract * @param {OnchainDataApiGetOnchainTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOnchainTransactions(requestParameters: OnchainDataApiGetOnchainTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getAccessRegistryCurrentState operation in OnchainDataApi. * @export * @interface OnchainDataApiGetAccessRegistryCurrentStateRequest */ export interface OnchainDataApiGetAccessRegistryCurrentStateRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetAccessRegistryCurrentState */ readonly baseAssetId: string; /** * The access registry address * @type {string} * @memberof OnchainDataApiGetAccessRegistryCurrentState */ readonly accessRegistryAddress: string; /** * Page cursor to get the next page\" * @type {string} * @memberof OnchainDataApiGetAccessRegistryCurrentState */ readonly pageCursor?: string; /** * Number of items per page (max 100), requesting more then 100 will return 100 items * @type {number} * @memberof OnchainDataApiGetAccessRegistryCurrentState */ readonly pageSize?: number; /** * Sorting field (enum). * @type {'dateAdded' | 'address'} * @memberof OnchainDataApiGetAccessRegistryCurrentState */ readonly sortBy?: GetAccessRegistryCurrentStateSortByEnum; /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof OnchainDataApiGetAccessRegistryCurrentState */ readonly order?: GetAccessRegistryCurrentStateOrderEnum; } /** * Request parameters for getAccessRegistrySummary operation in OnchainDataApi. * @export * @interface OnchainDataApiGetAccessRegistrySummaryRequest */ export interface OnchainDataApiGetAccessRegistrySummaryRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetAccessRegistrySummary */ readonly baseAssetId: string; /** * The access registry address * @type {string} * @memberof OnchainDataApiGetAccessRegistrySummary */ readonly accessRegistryAddress: string; } /** * Request parameters for getActiveRolesForContract operation in OnchainDataApi. * @export * @interface OnchainDataApiGetActiveRolesForContractRequest */ export interface OnchainDataApiGetActiveRolesForContractRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetActiveRolesForContract */ readonly baseAssetId: string; /** * The contract address * @type {string} * @memberof OnchainDataApiGetActiveRolesForContract */ readonly contractAddress: string; } /** * Request parameters for getContractBalanceHistory operation in OnchainDataApi. * @export * @interface OnchainDataApiGetContractBalanceHistoryRequest */ export interface OnchainDataApiGetContractBalanceHistoryRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly baseAssetId: string; /** * The contract address * @type {string} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly contractAddress: string; /** * The account address to get balance history for * @type {string} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly accountAddress: string; /** * Start date of the time range in ISO 8601 format * @type {string} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly startDate?: string; /** * End date of the time range in ISO 8601 format * @type {string} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly endDate?: string; /** * Time interval for grouping data * @type {'hour' | 'day' | 'week' | 'month'} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly interval?: GetContractBalanceHistoryIntervalEnum; /** * Page cursor to get the next page\" * @type {string} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly pageCursor?: string; /** * Number of items per page (max 100), requesting more then 100 will return 100 items * @type {number} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly pageSize?: number; /** * Sorting field (enum). Sorting only supported by \'blockTimestamp\' * @type {'blockTimestamp'} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly sortBy?: GetContractBalanceHistorySortByEnum; /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof OnchainDataApiGetContractBalanceHistory */ readonly order?: GetContractBalanceHistoryOrderEnum; } /** * Request parameters for getContractBalancesSummary operation in OnchainDataApi. * @export * @interface OnchainDataApiGetContractBalancesSummaryRequest */ export interface OnchainDataApiGetContractBalancesSummaryRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetContractBalancesSummary */ readonly baseAssetId: string; /** * The contract address * @type {string} * @memberof OnchainDataApiGetContractBalancesSummary */ readonly contractAddress: string; } /** * Request parameters for getContractTotalSupply operation in OnchainDataApi. * @export * @interface OnchainDataApiGetContractTotalSupplyRequest */ export interface OnchainDataApiGetContractTotalSupplyRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetContractTotalSupply */ readonly baseAssetId: string; /** * The contract address * @type {string} * @memberof OnchainDataApiGetContractTotalSupply */ readonly contractAddress: string; /** * Start date of the time range in ISO 8601 format * @type {string} * @memberof OnchainDataApiGetContractTotalSupply */ readonly startDate?: string; /** * End date of the time range in ISO 8601 format * @type {string} * @memberof OnchainDataApiGetContractTotalSupply */ readonly endDate?: string; /** * Time interval for grouping data * @type {'hour' | 'day' | 'week' | 'month'} * @memberof OnchainDataApiGetContractTotalSupply */ readonly interval?: GetContractTotalSupplyIntervalEnum; /** * Page cursor to get the next page\" * @type {string} * @memberof OnchainDataApiGetContractTotalSupply */ readonly pageCursor?: string; /** * Number of items per page (max 100), requesting more then 100 will return 100 items * @type {number} * @memberof OnchainDataApiGetContractTotalSupply */ readonly pageSize?: number; /** * Sorting field (enum). Sorting only supported by \'blockTimestamp\' * @type {'blockTimestamp'} * @memberof OnchainDataApiGetContractTotalSupply */ readonly sortBy?: GetContractTotalSupplySortByEnum; /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof OnchainDataApiGetContractTotalSupply */ readonly order?: GetContractTotalSupplyOrderEnum; } /** * Request parameters for getLatestBalancesForContract operation in OnchainDataApi. * @export * @interface OnchainDataApiGetLatestBalancesForContractRequest */ export interface OnchainDataApiGetLatestBalancesForContractRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly baseAssetId: string; /** * The contract address * @type {string} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly contractAddress: string; /** * Optional filter to get balance for a specific account address * @type {string} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly accountAddress?: string; /** * Page cursor to get the next page\" * @type {string} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly pageCursor?: string; /** * Number of items per page (max 100), requesting more then 100 will return 100 items * @type {number} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly pageSize?: number; /** * Sorting field for balances * @type {'accountAddress' | 'blockTimestamp'} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly sortBy?: GetLatestBalancesForContractSortByEnum; /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof OnchainDataApiGetLatestBalancesForContract */ readonly order?: GetLatestBalancesForContractOrderEnum; } /** * Request parameters for getOnchainTransactions operation in OnchainDataApi. * @export * @interface OnchainDataApiGetOnchainTransactionsRequest */ export interface OnchainDataApiGetOnchainTransactionsRequest { /** * The blockchain base assetId * @type {string} * @memberof OnchainDataApiGetOnchainTransactions */ readonly baseAssetId: string; /** * The contract address * @type {string} * @memberof OnchainDataApiGetOnchainTransactions */ readonly contractAddress: string; /** * Start date of the time range in ISO 8601 format * @type {string} * @memberof OnchainDataApiGetOnchainTransactions */ readonly startDate?: string; /** * End date of the time range in ISO 8601 format * @type {string} * @memberof OnchainDataApiGetOnchainTransactions */ readonly endDate?: string; /** * Page cursor to get the next page\" * @type {string} * @memberof OnchainDataApiGetOnchainTransactions */ readonly pageCursor?: string; /** * Number of items per page (max 100), requesting more then 100 will return 100 items * @type {number} * @memberof OnchainDataApiGetOnchainTransactions */ readonly pageSize?: number; /** * Sorting field (enum). * @type {'blockTimestamp' | 'blockNumber' | 'transactionHash'} * @memberof OnchainDataApiGetOnchainTransactions */ readonly sortBy?: GetOnchainTransactionsSortByEnum; /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof OnchainDataApiGetOnchainTransactions */ readonly order?: GetOnchainTransactionsOrderEnum; } /** * OnchainDataApi - object-oriented interface * @export * @class OnchainDataApi * @extends {BaseAPI} */ export declare class OnchainDataApi extends BaseAPI { /** * Returns the current state of addresses in the specified access registry. Only addresses that are currently active (added but not removed) are included. * @summary Get the current state of addresses in an access registry * @param {OnchainDataApiGetAccessRegistryCurrentStateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getAccessRegistryCurrentState(requestParameters: OnchainDataApiGetAccessRegistryCurrentStateRequest): Promise>; /** * Returns a summary of the current state of the access registry for the specified baseAssetId and accessRegistryAddress. * @summary Summary of access registry state * @param {OnchainDataApiGetAccessRegistrySummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getAccessRegistrySummary(requestParameters: OnchainDataApiGetAccessRegistrySummaryRequest): Promise>; /** * Returns a list of currently active roles for the specified baseAssetId and contractAddress. * @summary List of active roles for a given contract address and base asset ID * @param {OnchainDataApiGetActiveRolesForContractRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getActiveRolesForContract(requestParameters: OnchainDataApiGetActiveRolesForContractRequest): Promise>; /** * Returns the paginated balance history of the specified account in a contract with optional date range and interval filtering. * @summary Get historical balance data for a specific account in a contract * @param {OnchainDataApiGetContractBalanceHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getContractBalanceHistory(requestParameters: OnchainDataApiGetContractBalanceHistoryRequest): Promise>; /** * Returns the total number of unique addresses holding balances and the total supply for the specified contract. * @summary Get summary for the token contract * @param {OnchainDataApiGetContractBalancesSummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getContractBalancesSummary(requestParameters: OnchainDataApiGetContractBalancesSummaryRequest): Promise>; /** * Returns the paginated total supply history of the specified contract with optional date range and interval filtering. * @summary Get historical total supply data for a contract * @param {OnchainDataApiGetContractTotalSupplyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getContractTotalSupply(requestParameters: OnchainDataApiGetContractTotalSupplyRequest): Promise>; /** * Returns the latest balance for each unique address with support for numeric balance sorting. The `prev` cursor is reserved for future support. * @summary Get latest balances for all addresses holding tokens from a contract * @param {OnchainDataApiGetLatestBalancesForContractRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getLatestBalancesForContract(requestParameters: OnchainDataApiGetLatestBalancesForContractRequest): Promise>; /** * Returns a paginated list of onchain transactions for the specified contract address and base asset ID, optionally filtered by date range. * @summary Fetch onchain transactions for a contract * @param {OnchainDataApiGetOnchainTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OnchainDataApi */ getOnchainTransactions(requestParameters: OnchainDataApiGetOnchainTransactionsRequest): Promise>; } /** * @export */ export declare const GetAccessRegistryCurrentStateSortByEnum: { readonly DateAdded: "dateAdded"; readonly Address: "address"; }; export type GetAccessRegistryCurrentStateSortByEnum = typeof GetAccessRegistryCurrentStateSortByEnum[keyof typeof GetAccessRegistryCurrentStateSortByEnum]; /** * @export */ export declare const GetAccessRegistryCurrentStateOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetAccessRegistryCurrentStateOrderEnum = typeof GetAccessRegistryCurrentStateOrderEnum[keyof typeof GetAccessRegistryCurrentStateOrderEnum]; /** * @export */ export declare const GetContractBalanceHistoryIntervalEnum: { readonly Hour: "hour"; readonly Day: "day"; readonly Week: "week"; readonly Month: "month"; }; export type GetContractBalanceHistoryIntervalEnum = typeof GetContractBalanceHistoryIntervalEnum[keyof typeof GetContractBalanceHistoryIntervalEnum]; /** * @export */ export declare const GetContractBalanceHistorySortByEnum: { readonly BlockTimestamp: "blockTimestamp"; }; export type GetContractBalanceHistorySortByEnum = typeof GetContractBalanceHistorySortByEnum[keyof typeof GetContractBalanceHistorySortByEnum]; /** * @export */ export declare const GetContractBalanceHistoryOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetContractBalanceHistoryOrderEnum = typeof GetContractBalanceHistoryOrderEnum[keyof typeof GetContractBalanceHistoryOrderEnum]; /** * @export */ export declare const GetContractTotalSupplyIntervalEnum: { readonly Hour: "hour"; readonly Day: "day"; readonly Week: "week"; readonly Month: "month"; }; export type GetContractTotalSupplyIntervalEnum = typeof GetContractTotalSupplyIntervalEnum[keyof typeof GetContractTotalSupplyIntervalEnum]; /** * @export */ export declare const GetContractTotalSupplySortByEnum: { readonly BlockTimestamp: "blockTimestamp"; }; export type GetContractTotalSupplySortByEnum = typeof GetContractTotalSupplySortByEnum[keyof typeof GetContractTotalSupplySortByEnum]; /** * @export */ export declare const GetContractTotalSupplyOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetContractTotalSupplyOrderEnum = typeof GetContractTotalSupplyOrderEnum[keyof typeof GetContractTotalSupplyOrderEnum]; /** * @export */ export declare const GetLatestBalancesForContractSortByEnum: { readonly AccountAddress: "accountAddress"; readonly BlockTimestamp: "blockTimestamp"; }; export type GetLatestBalancesForContractSortByEnum = typeof GetLatestBalancesForContractSortByEnum[keyof typeof GetLatestBalancesForContractSortByEnum]; /** * @export */ export declare const GetLatestBalancesForContractOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetLatestBalancesForContractOrderEnum = typeof GetLatestBalancesForContractOrderEnum[keyof typeof GetLatestBalancesForContractOrderEnum]; /** * @export */ export declare const GetOnchainTransactionsSortByEnum: { readonly BlockTimestamp: "blockTimestamp"; readonly BlockNumber: "blockNumber"; readonly TransactionHash: "transactionHash"; }; export type GetOnchainTransactionsSortByEnum = typeof GetOnchainTransactionsSortByEnum[keyof typeof GetOnchainTransactionsSortByEnum]; /** * @export */ export declare const GetOnchainTransactionsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetOnchainTransactionsOrderEnum = typeof GetOnchainTransactionsOrderEnum[keyof typeof GetOnchainTransactionsOrderEnum];