@stacks/blockchain-api-client
Version:
Client for the Stacks Blockchain API
1,602 lines (1,600 loc) • 1.96 MB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/extended": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* API status
* @description Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information.
*/
get: operations["get_status"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent transactions
* @description Retrieves all recently mined transactions
*/
get: operations["get_transaction_list"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/multiple": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get list of details for transactions
* @description Retrieves a list of transactions for a given list of transaction IDs
*/
get: operations["get_tx_list_details"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/mempool": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get mempool transactions
* @description Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
*
* If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
*/
get: operations["get_mempool_transaction_list"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/mempool/dropped": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get dropped mempool transactions
* @description Retrieves all recently-broadcast transactions that have been dropped from the mempool.
*
* Transactions are dropped from the mempool if:
* * they were stale and awaiting garbage collection or,
* * were expensive, or
* * were replaced with a new fee
*/
get: operations["get_dropped_mempool_transaction_list"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/mempool/stats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get statistics for mempool transactions
* @description Queries for transactions counts, age (by block height), fees (simple average), and size.
* All results broken down by transaction type and percentiles (p25, p50, p75, p95).
*/
get: operations["get_mempool_transaction_stats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Transaction Events
* @description Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types.
* The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset').
*/
get: operations["get_filtered_events"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/{tx_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get transaction
* @description Retrieves transaction details for a given transaction ID
*/
get: operations["get_transaction_by_id"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/{tx_id}/raw": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get raw transaction
* @description Retrieves a hex encoded serialized transaction for a given ID
*/
get: operations["get_raw_transaction_by_id"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/block/{block_hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Transactions by block hash
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get transactions by block](/api/get-transactions-by-block).
*
* Retrieves a list of all transactions within a block for a given block hash.
*/
get: operations["get_transactions_by_block_hash"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tx/block_height/{height}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Transactions by block height
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get transactions by block](/api/get-transactions-by-block).
*
* Retrieves all transactions within a block at a given height
*/
get: operations["get_transactions_by_block_height"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/stx_supply/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get total and unlocked STX supply
* @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
*/
get: operations["get_stx_supply"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/stx_supply/total/plain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get total STX supply in plain text format
* @deprecated
* @description Retrieves the total circulating STX token supply as plain text.
*/
get: operations["get_stx_supply_total_supply_plain"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/stx_supply/circulating/plain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get circulating STX supply in plain text format
* @deprecated
* @description Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
*/
get: operations["get_stx_supply_circulating_plain"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/stx_supply/legacy_format": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
* @deprecated
* @description Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
*/
get: operations["get_total_stx_supply_legacy_format"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/info/network_block_times": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get the network target block time
* @description Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
*/
get: operations["get_network_block_times"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/info/network_block_time/{network}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a given network's target block time
* @description Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
*/
get: operations["get_network_block_time_by_network"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tokens/nft/holdings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Non-Fungible Token holdings
* @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
* Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.
*
* More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
*/
get: operations["get_nft_holdings"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tokens/nft/history": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Non-Fungible Token history
* @description Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.
*
* More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
*/
get: operations["get_nft_history"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tokens/nft/mints": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Non-Fungible Token mints
* @description Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.
*
* More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
*/
get: operations["get_nft_mints"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/tokens/ft/{token}/holders": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fungible token holders
* @description Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders.
*/
get: operations["get_ft_holders"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/contract/by_trait": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get contracts by trait
* @description Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
*/
get: operations["get_contracts_by_trait"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/contract/{contract_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get contract info
* @description Retrieves details of a contract with a given `contract_id`
*/
get: operations["get_contract_by_id"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/contract/{contract_id}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get contract events
* @description Retrieves a list of events that have been triggered by a given `contract_id`
*/
get: operations["get_contract_events_by_id"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/fee_rate/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Fetch fee rate
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](/api/get-approximate-fees-for-a-given-transaction).
*
* Retrieves estimated fee rate.
*/
post: operations["fetch_fee_rate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/microblock/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent microblocks
* @description Retrieves a list of microblocks.
*
* If you need to actively monitor new microblocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
*/
get: operations["get_microblock_list"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/microblock/{hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get microblock
* @description Retrieves a specific microblock by `hash`
*/
get: operations["get_microblock_by_hash"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/microblock/unanchored/txs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get the list of current transactions that belong to unanchored microblocks
* @description Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
*/
get: operations["get_unanchored_txs"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/block/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent blocks
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get blocks](/api/get-blocks).
*
* Retrieves a list of recently mined blocks
*
* If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
*/
get: operations["get_block_list"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/block/by_height/{height}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get block by height
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get block](/api/get-block).
*
* Retrieves block details of a specific block at a given block height
*/
get: operations["get_block_by_height"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/block/by_burn_block_height/{burn_block_height}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get block by burnchain height
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get blocks](/api/get-blocks).
*
* Retrieves block details of a specific block for a given burn chain height
*/
get: operations["get_block_by_burn_block_height"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/block/{hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get block by hash
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get block](/api/get-block).
*
* Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details.
*/
get: operations["get_block_by_hash"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/block/by_burn_block_hash/{burn_block_hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get block by burnchain block hash
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get blocks](/api/get-blocks).
*
* Retrieves block details of a specific block for a given burnchain block hash
*/
get: operations["get_block_by_burn_block_hash"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/burnchain/reward_slot_holders": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent reward slot holders
* @description Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
*/
get: operations["get_burnchain_reward_slot_holders"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/burnchain/reward_slot_holders/{address}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent reward slot holder entries for the given address
* @description Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
*/
get: operations["get_burnchain_reward_slot_holders_by_address"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/burnchain/rewards": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent burnchain reward recipients
* @description Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
*/
get: operations["get_burnchain_reward_list"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/burnchain/rewards/{address}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get recent burnchain reward for the given recipient
* @description Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
*/
get: operations["get_burnchain_reward_list_by_address"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/burnchain/rewards/{address}/total": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get total burnchain rewards for the given recipient
* @description Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
*/
get: operations["get_burnchain_rewards_total_by_address"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/stx": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get account STX balance
* @description Retrieves STX token balance for a given Address or Contract Identifier.
*/
get: operations["get_account_stx_balance"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/balances": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get account balances
* @description Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
*/
get: operations["get_account_balance"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get account transactions
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).
*
* Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
*
* If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
*/
get: operations["get_account_transactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/{tx_id}/with_transfers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get account transaction information for specific transaction
* @deprecated
* @description **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).
*
* Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
*/
get: operations["get_single_transaction_with_transfers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/transactions_with_transfers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get account transactions including STX transfers for each transaction.
* @deprecated
* @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
*/
get: operations["get_account_transactions_with_transfers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/assets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get account assets
* @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
*/
get: operations["get_account_assets"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/stx_inbound": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get inbound STX transfers
* @description Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,
* and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
*/
get: operations["get_account_inbound"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/mempool": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Transactions for address
* @description Retrieves all transactions for a given address that are currently in mempool
*/
get: operations["get_address_mempool_transactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/address/{principal}/nonces": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get the latest nonce used by an account
* @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
*/
get: operations["get_account_nonces"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/search/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Search
* @description Search blocks, transactions, contracts, or accounts by hash/ID
*/
get: operations["search_by_id"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/{pox}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get latest PoX events */
get: {
parameters: {
query?: {
/** @description Results per page */
limit?: number;
/** @description Result offset */
offset?: number;
};
header?: never;
path: {
pox: "pox2" | "pox3" | "pox4";
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Default Response */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/{pox}/tx/{tx_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get PoX events for a transaction */
get: {
parameters: {
query?: never;
header?: never;
path: {
pox: "pox2" | "pox3" | "pox4";
tx_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Default Response */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/{pox}/stacker/{principal}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get events for a stacking address */
get: {
parameters: {
query?: never;
header?: never;
path: {
pox: "pox2" | "pox3" | "pox4";
principal: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Default Response */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/{pox}/{pool_principal}/delegations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Stacking pool members
* @description Retrieves the list of stacking pool members for a given delegator principal.
*/
get: operations["get_pool_delegations"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/faucets/btc": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add regtest BTC tokens to address
* @description Add 0.01 BTC token to the specified regtest BTC address.
*
* The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block
* explorer. The tokens are delivered once the transaction has been included in a block.
*
* **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet.
*/
post: operations["run_faucet_btc"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/faucets/btc/{address}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get BTC balance for address */
get: operations["get_btc_balance"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v1/faucets/stx": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Get STX testnet tokens
* @description Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with `ST`. If the `stacking`
* parameter is set to `true`, the faucet will add the required number of tokens for individual stacking to the
* specified testnet address.
*
* The endpoint returns the transaction ID, which you can use to view the transaction in the
* [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has
* been included in an anchor block.
*
* A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing
* failed faucet transactions to a testnet address, you can get help in [Discord](https://stacks.chat).
*
* **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet.
*/
post: operations["run_faucet_stx"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/blocks/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get blocks
* @description Retrieves a list of recently mined blocks
*/
get: operations["get_blocks"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/blocks/average-times": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get average block times
* @description Retrieves average block times (in seconds)
*/
get: operations["get_average_block_times"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/blocks/{height_or_hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get block
* @description Retrieves a single block
*/
get: operations["get_block"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/blocks/{height_or_hash}/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get transactions by block
* @description Retrieves transactions confirmed in a single block
*/
get: operations["get_transactions_by_block"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/blocks/{height_or_hash}/signer-signatures": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get signer signatures for block
* @description Retrieves the signer signatures (an array of signature byte strings) in a single block
*/
get: operations["get_signer_signatures_for_block"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/burn-blocks/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get burn blocks
* @description Retrieves a list of recent burn blocks
*/
get: operations["get_burn_blocks"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/burn-blocks/{height_or_hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get burn block
* @description Retrieves a single burn block
*/
get: operations["get_burn_block"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/burn-blocks/{height_or_hash}/blocks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get blocks by burn block
* @description Retrieves a list of blocks confirmed by a specific burn block
*/
get: operations["get_blocks_by_burn_block"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/smart-contracts/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get smart contracts status
* @description Retrieves the deployment status of multiple smart contracts.
*/
get: operations["get_smart_contracts_status"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/mempool/fees": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get mempool transaction fee priorities
* @description Returns estimated fee priorities (in micro-STX) for all transactions that are currently in the mempool. Also returns priorities separated by transaction type.
*/
get: operations["get_mempool_fee_priorities"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/pox/cycles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get PoX cycles
* @description Retrieves a list of PoX cycles
*/
get: operations["get_pox_cycles"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/pox/cycles/{cycle_number}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get PoX cycle
* @description Retrieves details for a PoX cycle
*/
get: operations["get_pox_cycle"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/pox/cycles/{cycle_number}/signers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get signers in PoX cycle
* @description Retrieves a list of signers in a PoX cycle
*/
get: operations["get_pox_cycle_signers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get signer in PoX cycle
* @description Retrieves details for a signer in a PoX cycle
*/
get: operations["get_pox_cycle_signer"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get stackers for signer in PoX cycle
* @description Retrieves a list of stackers for a signer in a PoX cycle
*/
get: operations["get_pox_cycle_signer_stackers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/addresses/{address}/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get address transactions
* @description Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.
*
* More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
*/
get: operations["get_address_transactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/extended/v2/addresses/{address}/transactions/{tx_id}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get events for an address transaction
* @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction.
*/
get: operations["get_address_transaction_events"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/names/{name}/zonefile/{zoneFileHash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Historical Zone File
* @description Retrieves the historical zonefile specified by the username and zone hash.
*/
get: operations["get_historical_zone_file"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/names/{name}/subdomains": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**