blockfrost-js-ratelimited
Version:
A JavaScript/TypeScript SDK for interacting with the https://blockfrost.io API
1,220 lines (1,219 loc) • 143 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/": {
/** Root endpoint has no other function than to point end users to documentation. */
get: {
responses: {
/** Information pointing to the documentation. */
200: {
content: {
"application/json": {
url: string;
version: string;
};
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/health": {
/**
* Return backend status as a boolean. Your application
* should handle situations when backend for the given chain is unavailable.
*/
get: {
responses: {
/** Return the boolean indicating the health of the backend. */
200: {
content: {
"application/json": {
is_healthy: boolean;
};
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/health/clock": {
/**
* This endpoint provides the current UNIX time. Your application might
* use this to verify if the client clock is not out of sync.
*/
get: {
responses: {
/** Return the current UNIX time in milliseconds. */
200: {
content: {
"application/json": {
server_time: number;
};
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/latest": {
/**
* Return the latest block available to the backends, also known as the
* tip of the blockchain.
*/
get: {
responses: {
/** Return the contents of the latest block. */
200: {
content: {
"application/json": components["schemas"]["block_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/latest/txs": {
/** Return the transactions within the latest block. */
get: {
parameters: {
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the transactions within the block. */
200: {
content: {
"application/json": components["schemas"]["block_content_txs"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/{hash_or_number}": {
/** Return the content of a requested block. */
get: {
parameters: {
path: {
/** Hash or number of the requested block. */
hash_or_number: string;
};
};
responses: {
/** Return the contents of the block */
200: {
content: {
"application/json": components["schemas"]["block_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/slot/{slot_number}": {
/** Return the content of a requested block for a specific slot. */
get: {
parameters: {
path: {
/** Slot position for requested block. */
slot_number: number;
};
};
responses: {
/** Return the contents of the block */
200: {
content: {
"application/json": components["schemas"]["block_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/epoch/{epoch_number}/slot/{slot_number}": {
/** Return the content of a requested block for a specific slot in an epoch. */
get: {
parameters: {
path: {
/** Epoch for specific epoch slot. */
epoch_number: number;
/** Slot position for requested block. */
slot_number: number;
};
};
responses: {
/** Return the contents of the block */
200: {
content: {
"application/json": components["schemas"]["block_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/{hash_or_number}/next": {
/** Return the list of blocks following a specific block. */
get: {
parameters: {
path: {
/** Hash of the requested block. */
hash_or_number: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
};
};
responses: {
/** Return the contents of the block. */
200: {
content: {
"application/json": components["schemas"]["block_content_array"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/{hash_or_number}/previous": {
/** Return the list of blocks preceding a specific block. */
get: {
parameters: {
path: {
/** Hash of the requested block */
hash_or_number: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
};
};
responses: {
/** Return the contents of the block */
200: {
content: {
"application/json": components["schemas"]["block_content_array"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/blocks/{hash_or_number}/txs": {
/** Return the transactions within the block. */
get: {
parameters: {
path: {
/** Hash of the requested block. */
hash_or_number: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the transactions within the block. */
200: {
content: {
"application/json": components["schemas"]["block_content_txs"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/genesis": {
/** Return the information about blockchain genesis. */
get: {
responses: {
/** Return the genesis parameters. */
200: {
content: {
"application/json": components["schemas"]["genesis_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/latest": {
/** Return the information about the latest, therefore current, epoch. */
get: {
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/latest/parameters": {
/** Return the protocol parameters for the latest epoch. */
get: {
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_param_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}": {
/** Return the content of the requested epoch. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
};
};
responses: {
/** Return the epoch data. */
200: {
content: {
"application/json": components["schemas"]["epoch_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/next": {
/** Return the list of epochs following a specific epoch. */
get: {
parameters: {
path: {
/** Number of the requested epoch. */
number: number;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
};
};
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_content_array"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/previous": {
/** Return the list of epochs preceding a specific epoch. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results */
page?: number;
};
};
responses: {
/** Return the epoch data */
200: {
content: {
"application/json": components["schemas"]["epoch_content_array"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/stakes": {
/** Return the active stake distribution for the specified epoch. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
};
};
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_stake_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/stakes/{pool_id}": {
/** Return the active stake distribution for the epoch specified by stake pool. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
/** Stake pool ID to filter */
pool_id: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
};
};
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_stake_pool_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/blocks": {
/** Return the blocks minted for the epoch specified. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_block_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/blocks/{pool_id}": {
/** Return the block minted for the epoch specified by stake pool. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
/** Stake pool ID to filter */
pool_id: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_block_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/epochs/{number}/parameters": {
/** Return the protocol parameters for the epoch specified. */
get: {
parameters: {
path: {
/** Number of the epoch */
number: number;
};
};
responses: {
/** Return the data about the epoch */
200: {
content: {
"application/json": components["schemas"]["epoch_param_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}": {
/** Return content of the requested transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Return the contents of the transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/utxos": {
/** Return the inputs and UTXOs of the specific transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Return the contents of the transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_utxo"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/stakes": {
/** Obtain information about (de)registration of stake addresses within a transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction. */
hash: string;
};
};
responses: {
/** Obtain information about (de)registration of stake addresses within a transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_stake_addr"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/delegations": {
/** Obtain information about delegation certificates of a specific transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction. */
hash: string;
};
};
responses: {
/** Obtain information about delegation certificates of a specific transaction */
200: {
content: {
"application/json": components["schemas"]["tx_content_delegations"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/withdrawals": {
/** Obtain information about withdrawals of a specific transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction. */
hash: string;
};
};
responses: {
/** Obtain information about withdrawals of a specific transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_withdrawals"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/mirs": {
/** Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction. */
hash: string;
};
};
responses: {
/** Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_mirs"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/pool_updates": {
/** Obtain information about stake pool registration and update certificates of a specific transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Obtain information about stake pool certificates of a specific transaction */
200: {
content: {
"application/json": components["schemas"]["tx_content_pool_certs"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/pool_retires": {
/** Obtain information about stake pool retirements within a specific transaction. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Obtain information about stake pool retirements within a specific transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_pool_retires"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/metadata": {
/** Obtain the transaction metadata. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Obtain information about stake pool retirements within a specific transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_metadata"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/metadata/cbor": {
/** Obtain the transaction metadata in CBOR. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Obtain information about stake pool retirements within a specific transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_metadata_cbor"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/txs/{hash}/redeemers": {
/** Obtain the transaction redeemers. */
get: {
parameters: {
path: {
/** Hash of the requested transaction */
hash: string;
};
};
responses: {
/** Obtain information about redeemers within a specific transaction. */
200: {
content: {
"application/json": components["schemas"]["tx_content_redeemers"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/tx/submit": {
/** Submit an already serialized transaction to the network. */
post: {
parameters: {
header: {
"Content-Type": "application/cbor";
};
};
responses: {
/** Return the ID of the submitted transaction. */
200: {
content: {
"application/json": string;
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}": {
/** Obtain information about a specific stake account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
};
responses: {
/** Return the account content. */
200: {
content: {
"application/json": components["schemas"]["account_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/rewards": {
/** Obtain information about the reward history of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account content. */
200: {
content: {
"application/json": components["schemas"]["account_reward_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/history": {
/** Obtain information about the history of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account content. */
200: {
content: {
"application/json": components["schemas"]["account_history_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/delegations": {
/** Obtain information about the delegation of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account delegations content */
200: {
content: {
"application/json": components["schemas"]["account_delegation_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/registrations": {
/** Obtain information about the registrations and deregistrations of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account registration content. */
200: {
content: {
"application/json": components["schemas"]["account_registration_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/withdrawals": {
/** Obtain information about the withdrawals of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account withdrawal content. */
200: {
content: {
"application/json": components["schemas"]["account_withdrawal_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/mirs": {
/** Obtain information about the MIRs of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account MIR content. */
200: {
content: {
"application/json": components["schemas"]["account_mir_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/addresses": {
/** Obtain information about the addresses of a specific account. */
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account addresses content */
200: {
content: {
"application/json": components["schemas"]["account_addresses_content"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];
418: components["responses"]["autobanned"];
429: components["responses"]["overusage_limit"];
500: components["responses"]["internal_server_error"];
};
};
};
"/accounts/{stake_address}/addresses/assets": {
/**
* 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.
*/
get: {
parameters: {
path: {
/** Bech32 stake address. */
stake_address: string;
};
query: {
/** The number of results displayed on one page. */
count?: number;
/** The page number for listing the results. */
page?: number;
/**
* 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.
*/
order?: "asc" | "desc";
};
};
responses: {
/** Return the account addresses content */
200: {
content: {
"application/json": components["schemas"]["account_addresses_assets"];
};
};
400: components["responses"]["bad_request"];
403: components["responses"]["unauthorized_error"];
404: components["responses"]["not_found"];