@stacks/blockchain-api-client 9.0.0-pox5.7 → 9.0.0-pox5.9

package/lib/generated/schema.d.ts

@@ -1188,6 +1188,33 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/extended/v1/faucets/sbtc": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Get sBTC testnet tokens
+         * @description Add sBTC tokens to the specified testnet address. The endpoint performs a SIP-010 `transfer`
+         *             contract call on the configured testnet sBTC token contract. Testnet STX addresses begin with `ST`.
+         *
+         *             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 a block.
+         *
+         *             **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet.
+         */
+        post: operations["run_faucet_sbtc"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/extended/v2/blocks/": {
         parameters: {
             query?: never;
@@ -1750,7 +1777,127 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/extended/v3/principals/{principal}/balances/staking": {
+    "/extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal transaction balance changes
+         * @description Returns the balance changes for a principal's transaction
+         */
+        get: operations["get_principal_transaction_balance_changes"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balance-changes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal balance changes
+         * @description Returns the balance changes for a principal across one or more transactions, as a single paginated flat array ordered by chain position descending then by asset.
+         */
+        get: operations["get_principal_balance_changes"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/staking": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal staking summary
+         * @description A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions. The per-bond breakdown is paginated at `/principals/:principal/staking/bonds`.
+         */
+        get: operations["get_principal_staking_summary"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/staking/bonds": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal bond positions
+         * @description Get a principal's bond positions — its enrollment, lock, status, and sBTC rewards in each bond it participates in.
+         */
+        get: operations["get_principal_bond_positions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/stx": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal STX balance
+         * @description Get a principal's STX balance: its total and spendable (available) balance, any locked STX, and the projected balance from pending mempool transactions.
+         */
+        get: operations["get_principal_balances_stx"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/ft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal FT balances
+         * @description Get a principal's fungible-token balances, sorted by balance descending.
+         */
+        get: operations["get_principal_balances_ft"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/nft": {
         parameters: {
             query?: never;
             header?: never;
@@ -1758,10 +1905,10 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get principal staking balances
-         * @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
+         * Get principal NFT balances
+         * @description Get the non-fungible token instances currently owned by a principal, ordered by asset identifier and value.
          */
-        get: operations["get_principal_staking_balances"];
+        get: operations["get_principal_balances_nft"];
         put?: never;
         post?: never;
         delete?: never;
@@ -1890,6 +2037,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/extended/v3/staking/signers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get staking signers
+         * @description Get the registered pox-5 staking signers and their current signing keys.
+         */
+        get: operations["get_staking_signers"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/staking/signers/{principal}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get staking signer
+         * @description Get a registered pox-5 staking signer along with the details of the transaction that registered its current key.
+         */
+        get: operations["get_staking_signer"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/extended/v3/transactions": {
         parameters: {
             query?: never;
@@ -27703,6 +27890,59 @@ export interface operations {
             };
         };
     };
+    run_faucet_sbtc: {
+        parameters: {
+            query?: {
+                /**
+                 * @description A valid testnet STX address
+                 * @example ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ
+                 */
+                address?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description POST request that initiates a transfer of tokens to a specified testnet address */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Indicates if the faucet call was successful
+                         * @enum {boolean}
+                         */
+                        success: true;
+                        /** @description The transaction ID for the faucet call */
+                        txId: string;
+                        /** @description Raw transaction in hex string representation */
+                        txRaw: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Indicates if the faucet call was successful
+                         * @enum {boolean}
+                         */
+                        success: false;
+                        /** @description Error message */
+                        error: string;
+                    };
+                };
+            };
+        };
+    };
     get_blocks: {
         parameters: {
             query?: {
@@ -32798,12 +33038,22 @@ export interface operations {
             };
         };
     };
-    get_principal_staking_balances: {
+    get_principal_transaction_balance_changes: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating principal transaction balance changes. Format: `<asset_type>:<asset_identifier>` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `<stx>` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT. */
+                cursor?: string;
+            };
             header?: never;
             path: {
                 principal: string;
+                /**
+                 * @description Transaction ID
+                 * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
+                 */
+                tx_id: string;
             };
             cookie?: never;
         };
@@ -32816,40 +33066,38 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** @description The index of the bond in the PoX-5 bond list */
-                        bond_index: number;
-                        status: "enrolled" | "running" | "early_exit" | "unlocked";
-                        /** @description Whether the position is active */
-                        active: boolean;
-                        balances: {
-                            locked: {
-                                /** @description The total amount of BTC that is locked up for this bond */
-                                btc: string;
-                                /** @description The total amount of STX that is locked up for this bond */
-                                stx: string;
-                            };
-                            paid_out: {
-                                /** @description The total amount of BTC that has been paid out for this bond */
-                                btc: string;
-                            };
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 20
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
                         };
-                        enrollment: {
-                            /**
-                             * Transaction ID
-                             * @description Transaction ID
-                             * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
-                             */
-                            tx_id: string;
-                            btc_lockup: {
-                                /** @description The amount of BTC that is locked up for this principal */
-                                amount: string;
+                        results: {
+                            asset: {
+                                /** @enum {string} */
+                                type: "stx";
+                            } | {
+                                /** @description The asset type that was affected by the balance change. */
+                                type: "ft" | "nft";
+                                /** @description The identifier of the asset that was affected by the balance change. */
+                                identifier: string;
                             };
-                        };
-                        /** @description The amount of STX that is locked up for this principal */
-                        amount: string;
-                        /** @description The sBTC reward sats accrued to this participant's position */
-                        accrued_rewards: string;
-                    }[];
+                            balance_change: {
+                                /** @description Amount sent by the principal */
+                                sent: string;
+                                /** @description Amount received by the principal */
+                                received: string;
+                                /** @description Net balance change for the principal */
+                                net: string;
+                            };
+                        }[];
+                    };
                 };
             };
             /** @description Default Response */
@@ -32868,9 +33116,445 @@ export interface operations {
             };
         };
     };
-    get_bonds: {
+    get_principal_balance_changes: {
         parameters: {
-            query?: {
+            query: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating principal balance changes across multiple transactions. Format: `<block_height>:<microblock_sequence>:<tx_index>:<asset_type>:<asset_identifier>`. */
+                cursor?: string;
+                /** @description Transaction IDs to query balance changes for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). */
+                tx_id: string[];
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 20
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * Transaction ID
+                             * @description Transaction ID
+                             * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
+                             */
+                            tx_id: string;
+                            asset: {
+                                /** @enum {string} */
+                                type: "stx";
+                            } | {
+                                /** @description The asset type that was affected by the balance change. */
+                                type: "ft" | "nft";
+                                /** @description The identifier of the asset that was affected by the balance change. */
+                                identifier: string;
+                            };
+                            balance_change: {
+                                /** @description Amount sent by the principal */
+                                sent: string;
+                                /** @description Amount received by the principal */
+                                received: string;
+                                /** @description Net balance change for the principal */
+                                net: string;
+                            };
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_staking_summary: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        stx: {
+                            /** @description The amount of uSTX currently locked in pox-5 STX staking */
+                            locked: string;
+                            rewards: {
+                                btc: {
+                                    /** @description The lifetime sBTC reward sats accrued to this position */
+                                    accrued: string;
+                                    /** @description The lifetime sBTC reward sats already claimed against this position */
+                                    claimed: string;
+                                    /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
+                                    claimable: string;
+                                };
+                            };
+                        };
+                        bonds: {
+                            /** @description Number of bonds this principal has a position in */
+                            count: number;
+                            locked: {
+                                /** @description Total BTC locked across all bond positions */
+                                btc: string;
+                                /** @description Total STX locked across all bond positions */
+                                stx: string;
+                            };
+                            rewards: {
+                                btc: {
+                                    /** @description The lifetime sBTC reward sats accrued to this position */
+                                    accrued: string;
+                                    /** @description The lifetime sBTC reward sats already claimed against this position */
+                                    claimed: string;
+                                    /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
+                                    claimable: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_bond_positions: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating bonds. Format: bond_index */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 20
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /** @description The index of the bond in the PoX-5 bond list */
+                            bond_index: number;
+                            status: "enrolled" | "running" | "early_exit" | "unlocked";
+                            /** @description Whether the position is active */
+                            active: boolean;
+                            enrollment: {
+                                /**
+                                 * Transaction ID
+                                 * @description Transaction ID
+                                 * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
+                                 */
+                                tx_id: string;
+                                btc_lockup: {
+                                    /** @description The amount of BTC that is locked up for this principal */
+                                    amount: string;
+                                };
+                            };
+                            locked: {
+                                /** @description The amount of BTC locked in this bond position */
+                                btc: string;
+                                /** @description The amount of STX locked in this bond position */
+                                stx: string;
+                            };
+                            rewards: {
+                                btc: {
+                                    /** @description The lifetime sBTC reward sats accrued to this position */
+                                    accrued: string;
+                                    /** @description The lifetime sBTC reward sats already claimed against this position */
+                                    claimed: string;
+                                    /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
+                                    claimable: string;
+                                };
+                            };
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_stx: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Total micro-STX balance (available plus locked) */
+                        balance: string;
+                        /** @description Spendable micro-STX balance (balance minus locked) */
+                        available: string;
+                        locked: {
+                            /** @description The amount of locked micro-STX */
+                            amount: string;
+                            /** @description The PoX contract version that created the lock (e.g. 4, 5) */
+                            pox_version: number;
+                            /**
+                             * Transaction ID
+                             * @description Transaction ID
+                             */
+                            lock_tx_id: string;
+                            /** @description The Stacks block height at which the lock was created */
+                            stacks_lock_height: number;
+                            /** @description The burnchain block height at which the lock was created */
+                            burn_lock_height: number;
+                            /** @description The burnchain block height at which the locked STX unlocks */
+                            burn_unlock_height: number;
+                        } | null;
+                        mempool: {
+                            /** @description Estimated spendable micro-STX balance once pending mempool txs confirm */
+                            estimated_balance: string;
+                            /** @description Pending inbound micro-STX from the mempool */
+                            inbound: string;
+                            /** @description Pending outbound micro-STX from the mempool (transfers plus fees) */
+                            outbound: string;
+                        } | null;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_ft: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * @description Fungible token asset identifier
+                             * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
+                             */
+                            asset_identifier: string;
+                            /** @description The principal's balance of this token, as a string-quoted integer in base units */
+                            balance: string;
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_nft: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * @description Non-fungible token asset identifier
+                             * @example SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild
+                             */
+                            asset_identifier: string;
+                            /** @description The NFT instance identifier, as a Clarity value */
+                            value: {
+                                hex: string;
+                                repr: string;
+                            };
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_bonds: {
+        parameters: {
+            query?: {
                 /** @description Number of results per page */
                 limit?: number;
                 /** @description Cursor for paginating bonds. Format: bond_index */
@@ -33339,6 +34023,135 @@ export interface operations {
             };
         };
     };
+    get_staking_signers: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating staking signers (sorted by signer). Format: signer principal */
+                cursor?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            signer: string;
+                            /**
+                             * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string
+                             * @example 0x03a0f9e1...
+                             */
+                            signer_key: string;
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_staking_signer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        signer: string;
+                        /**
+                         * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string
+                         * @example 0x03a0f9e1...
+                         */
+                        signer_key: string;
+                        transaction: {
+                            /**
+                             * Transaction ID
+                             * @description Transaction ID
+                             * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
+                             */
+                            tx_id: string;
+                            block: {
+                                /** @description Height of the block this transactions was associated with */
+                                height: number;
+                                /** @description Hash of the blocked this transactions was associated with */
+                                hash: string;
+                                /** @description Hash of the index block this transactions was associated with */
+                                index_hash: string;
+                                /** @description Unix timestamp (in seconds) indicating when this block was mined. */
+                                time: number;
+                                /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
+                                tx_index: number;
+                            };
+                            bitcoin_block: {
+                                /** @description Height of the anchor burn block. */
+                                height: number;
+                                /** @description Unix timestamp (in seconds) indicating when this block was mined. */
+                                time: number;
+                            };
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
     get_transactions: {
         parameters: {
             query?: {