@stacks/blockchain-api-client 9.0.0-pox5.11 → 9.0.0-pox5.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/lib/generated/schema.d.ts +174 -18
  2. package/package.json +5 -5
  3. package/src/generated/schema.d.ts +174 -18
package/lib/generated/schema.d.ts CHANGED
@@ -33,7 +33,8 @@ export interface paths {
33
33
  };
34
34
  /**
35
35
  * Get recent transactions
36
- * @description Retrieves all recently mined transactions
36
+ * @deprecated
37
+ * @description Retrieves all recently mined transactions. **Deprecated:** use `GET /extended/v3/transactions` instead.
37
38
  */
38
39
  get: operations["get_transaction_list"];
39
40
  put?: never;
@@ -73,9 +74,12 @@ export interface paths {
73
74
  };
74
75
  /**
75
76
  * Get mempool transactions
77
+ * @deprecated
76
78
  * @description Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
77
79
  *
78
80
  * 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.
81
+ *
82
+ * **Deprecated:** use `GET /extended/v3/mempool/transactions` instead.
79
83
  */
80
84
  get: operations["get_mempool_transaction_list"];
81
85
  put?: never;
@@ -137,7 +141,8 @@ export interface paths {
137
141
  };
138
142
  /**
139
143
  * Get transaction
140
- * @description Retrieves transaction details for a given transaction ID
144
+ * @deprecated
145
+ * @description Retrieves transaction details for a given transaction ID. **Deprecated:** use `GET /extended/v3/transactions/{tx_id}` instead.
141
146
  */
142
147
  get: operations["get_transaction_by_id"];
143
148
  put?: never;
@@ -157,7 +162,8 @@ export interface paths {
157
162
  };
158
163
  /**
159
164
  * Get raw transaction
160
- * @description Retrieves a hex encoded serialized transaction for a given ID
165
+ * @deprecated
166
+ * @description Retrieves a hex encoded serialized transaction for a given ID. **Deprecated:** use the Stacks node RPC endpoint `GET /v3/transaction/{tx_id}` to fetch a single raw transaction instead.
161
167
  */
162
168
  get: operations["get_raw_transaction_by_id"];
163
169
  put?: never;
@@ -178,7 +184,7 @@ export interface paths {
178
184
  /**
179
185
  * Transactions by block hash
180
186
  * @deprecated
181
- * @description Retrieves a list of all transactions within a block for a given block hash. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
187
+ * @description Retrieves a list of all transactions within a block for a given block hash. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
182
188
  */
183
189
  get: operations["get_transactions_by_block_hash"];
184
190
  put?: never;
@@ -199,7 +205,7 @@ export interface paths {
199
205
  /**
200
206
  * Transactions by block height
201
207
  * @deprecated
202
- * @description Retrieves all transactions within a block at a given height. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
208
+ * @description Retrieves all transactions within a block at a given height. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
203
209
  */
204
210
  get: operations["get_transactions_by_block_height"];
205
211
  put?: never;
@@ -783,7 +789,7 @@ export interface paths {
783
789
  /**
784
790
  * Get account STX balance
785
791
  * @deprecated
786
- * @description Retrieves STX token balance for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_principal_stx_balance`.**
792
+ * @description Retrieves STX token balance for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
787
793
  */
788
794
  get: operations["get_account_stx_balance"];
789
795
  put?: never;
@@ -804,7 +810,7 @@ export interface paths {
804
810
  /**
805
811
  * Get account balances
806
812
  * @deprecated
807
- * @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. **This endpoint is deprecated in favor of `get_principal_ft_balances`.**
813
+ * @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. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx`, `GET /extended/v3/principals/{principal}/balances/ft`, and `GET /extended/v3/principals/{principal}/balances/nft` instead.
808
814
  */
809
815
  get: operations["get_account_balance"];
810
816
  put?: never;
@@ -825,7 +831,7 @@ export interface paths {
825
831
  /**
826
832
  * Get account transactions
827
833
  * @deprecated
828
- * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_address_transactions`.**
834
+ * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
829
835
  */
830
836
  get: operations["get_account_transactions"];
831
837
  put?: never;
@@ -846,7 +852,7 @@ export interface paths {
846
852
  /**
847
853
  * Get account transaction information for specific transaction
848
854
  * @deprecated
849
- * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
855
+ * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
850
856
  */
851
857
  get: operations["get_single_transaction_with_transfers"];
852
858
  put?: never;
@@ -867,7 +873,7 @@ export interface paths {
867
873
  /**
868
874
  * Get account transactions including STX transfers for each transaction.
869
875
  * @deprecated
870
- * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **This endpoint is deprecated in favor of `get_address_transactions`.**
876
+ * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
871
877
  */
872
878
  get: operations["get_account_transactions_with_transfers"];
873
879
  put?: never;
@@ -888,7 +894,7 @@ export interface paths {
888
894
  /**
889
895
  * Get account assets
890
896
  * @deprecated
891
- * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
897
+ * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **Deprecated:** this endpoint has no direct v3 replacement; the closest equivalent is `GET /extended/v3/principals/{principal}/balance-changes`.
892
898
  */
893
899
  get: operations["get_account_assets"];
894
900
  put?: never;
@@ -909,7 +915,7 @@ export interface paths {
909
915
  /**
910
916
  * Get inbound STX transfers
911
917
  * @deprecated
912
- * @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. **This endpoint is deprecated in favor of `get_address_transactions`.**
918
+ * @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 at the `send-many-memo` bulk sending contract. **Deprecated:** this endpoint has no direct v3 replacement.
913
919
  */
914
920
  get: operations["get_account_inbound"];
915
921
  put?: never;
@@ -949,7 +955,8 @@ export interface paths {
949
955
  };
950
956
  /**
951
957
  * Get the latest nonce used by an account
952
- * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
958
+ * @deprecated
959
+ * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions. **Deprecated:** use `GET /extended/v3/principals/{principal}/nonces` instead.
953
960
  */
954
961
  get: operations["get_account_nonces"];
955
962
  put?: never;
@@ -1304,7 +1311,8 @@ export interface paths {
1304
1311
  };
1305
1312
  /**
1306
1313
  * Get transactions by block
1307
- * @description Retrieves transactions confirmed in a single block
1314
+ * @deprecated
1315
+ * @description Retrieves transactions confirmed in a single block. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
1308
1316
  */
1309
1317
  get: operations["get_transactions_by_block"];
1310
1318
  put?: never;
@@ -1604,9 +1612,12 @@ export interface paths {
1604
1612
  };
1605
1613
  /**
1606
1614
  * Get address transactions
1615
+ * @deprecated
1607
1616
  * @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.
1608
1617
  *
1609
1618
  * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).
1619
+ *
1620
+ * **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
1610
1621
  */
1611
1622
  get: operations["get_address_transactions"];
1612
1623
  put?: never;
@@ -1626,7 +1637,8 @@ export interface paths {
1626
1637
  };
1627
1638
  /**
1628
1639
  * Get events for an address transaction
1629
- * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction.
1640
+ * @deprecated
1641
+ * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
1630
1642
  */
1631
1643
  get: operations["get_address_transaction_events"];
1632
1644
  put?: never;
@@ -1646,7 +1658,8 @@ export interface paths {
1646
1658
  };
1647
1659
  /**
1648
1660
  * Get principal STX balance
1649
- * @description Retrieves STX account balance information for a given Address or Contract Identifier.
1661
+ * @deprecated
1662
+ * @description Retrieves STX account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
1650
1663
  */
1651
1664
  get: operations["get_principal_stx_balance"];
1652
1665
  put?: never;
@@ -1666,7 +1679,8 @@ export interface paths {
1666
1679
  };
1667
1680
  /**
1668
1681
  * Get principal FT balances
1669
- * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier.
1682
+ * @deprecated
1683
+ * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft` instead.
1670
1684
  */
1671
1685
  get: operations["get_principal_ft_balances"];
1672
1686
  put?: never;
@@ -1686,7 +1700,8 @@ export interface paths {
1686
1700
  };
1687
1701
  /**
1688
1702
  * Get principal FT balance
1689
- * @description Retrieves a specific fungible-token balance for a given principal.
1703
+ * @deprecated
1704
+ * @description Retrieves a specific fungible-token balance for a given principal. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft/{asset_identifier}` instead.
1690
1705
  */
1691
1706
  get: operations["get_principal_ft_balance"];
1692
1707
  put?: never;
@@ -1897,6 +1912,26 @@ export interface paths {
1897
1912
  patch?: never;
1898
1913
  trace?: never;
1899
1914
  };
1915
+ "/extended/v3/principals/{principal}/balances/ft/{asset_identifier}": {
1916
+ parameters: {
1917
+ query?: never;
1918
+ header?: never;
1919
+ path?: never;
1920
+ cookie?: never;
1921
+ };
1922
+ /**
1923
+ * Get principal FT balance
1924
+ * @description Get a principal's balance of a single fungible token. Returns a zero balance if the principal does not currently hold the token.
1925
+ */
1926
+ get: operations["get_principal_balance_ft"];
1927
+ put?: never;
1928
+ post?: never;
1929
+ delete?: never;
1930
+ options?: never;
1931
+ head?: never;
1932
+ patch?: never;
1933
+ trace?: never;
1934
+ };
1900
1935
  "/extended/v3/principals/{principal}/balances/nft": {
1901
1936
  parameters: {
1902
1937
  query?: never;
@@ -1917,6 +1952,26 @@ export interface paths {
1917
1952
  patch?: never;
1918
1953
  trace?: never;
1919
1954
  };
1955
+ "/extended/v3/principals/{principal}/nonces": {
1956
+ parameters: {
1957
+ query?: never;
1958
+ header?: never;
1959
+ path?: never;
1960
+ cookie?: never;
1961
+ };
1962
+ /**
1963
+ * Get principal nonces
1964
+ * @description Get a Stacks account's latest nonce state by inspecting its confirmed (anchored + microblock) transactions and the mempool, including the nonce to use for its next transaction. Only standard principals have nonces; contract principals are not valid.
1965
+ */
1966
+ get: operations["get_principal_nonces"];
1967
+ put?: never;
1968
+ post?: never;
1969
+ delete?: never;
1970
+ options?: never;
1971
+ head?: never;
1972
+ patch?: never;
1973
+ trace?: never;
1974
+ };
1920
1975
  "/extended/v3/staking/bonds": {
1921
1976
  parameters: {
1922
1977
  query?: never;
@@ -38106,6 +38161,55 @@ export interface operations {
38106
38161
  };
38107
38162
  };
38108
38163
  };
38164
+ get_principal_balance_ft: {
38165
+ parameters: {
38166
+ query?: never;
38167
+ header?: never;
38168
+ path: {
38169
+ principal: string;
38170
+ /**
38171
+ * @description Asset Identifier
38172
+ * @example SP000000000000000000002Q6VF78.pox-3::stx-token
38173
+ */
38174
+ asset_identifier: string;
38175
+ };
38176
+ cookie?: never;
38177
+ };
38178
+ requestBody?: never;
38179
+ responses: {
38180
+ /** @description Default Response */
38181
+ 200: {
38182
+ headers: {
38183
+ [name: string]: unknown;
38184
+ };
38185
+ content: {
38186
+ "application/json": {
38187
+ /**
38188
+ * @description Fungible token asset identifier
38189
+ * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
38190
+ */
38191
+ asset_identifier: string;
38192
+ /** @description The principal's balance of this token, as a string-quoted integer in base units */
38193
+ balance: string;
38194
+ };
38195
+ };
38196
+ };
38197
+ /** @description Default Response */
38198
+ "4XX": {
38199
+ headers: {
38200
+ [name: string]: unknown;
38201
+ };
38202
+ content: {
38203
+ "application/json": {
38204
+ error: string;
38205
+ message?: string;
38206
+ } & {
38207
+ [key: string]: unknown;
38208
+ };
38209
+ };
38210
+ };
38211
+ };
38212
+ };
38109
38213
  get_principal_balances_nft: {
38110
38214
  parameters: {
38111
38215
  query?: {
@@ -38172,6 +38276,58 @@ export interface operations {
38172
38276
  };
38173
38277
  };
38174
38278
  };
38279
+ get_principal_nonces: {
38280
+ parameters: {
38281
+ query?: never;
38282
+ header?: never;
38283
+ path: {
38284
+ /**
38285
+ * @description Stacks Address
38286
+ * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP
38287
+ */
38288
+ principal: string;
38289
+ };
38290
+ cookie?: never;
38291
+ };
38292
+ requestBody?: never;
38293
+ responses: {
38294
+ /** @description Default Response */
38295
+ 200: {
38296
+ headers: {
38297
+ [name: string]: unknown;
38298
+ };
38299
+ content: {
38300
+ "application/json": {
38301
+ /** @description The nonce to use for this principal's next transaction, derived from the latest confirmed and mempool nonces. May be inaccurate if the API is not fully synchronized. */
38302
+ next_nonce: number;
38303
+ last_confirmed_nonce: number | null;
38304
+ /** PrincipalMempoolNonces */
38305
+ mempool: {
38306
+ last_nonce: number | null;
38307
+ /** @description Intermediate nonces found in the mempool between the last confirmed nonce and the highest mempool nonce. */
38308
+ pending_nonces: number[];
38309
+ /** @description Expected intermediate nonces between the last confirmed nonce and the highest mempool nonce that are absent from the mempool — likely stalling transactions. */
38310
+ missing_nonces: number[];
38311
+ };
38312
+ };
38313
+ };
38314
+ };
38315
+ /** @description Default Response */
38316
+ "4XX": {
38317
+ headers: {
38318
+ [name: string]: unknown;
38319
+ };
38320
+ content: {
38321
+ "application/json": {
38322
+ error: string;
38323
+ message?: string;
38324
+ } & {
38325
+ [key: string]: unknown;
38326
+ };
38327
+ };
38328
+ };
38329
+ };
38330
+ };
38175
38331
  get_bonds: {
38176
38332
  parameters: {
38177
38333
  query?: {
package/package.json CHANGED
@@ -1,18 +1,18 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "9.0.0-pox5.11",
3
+ "version": "9.0.0-pox5.13",
4
4
  "access": "public",
5
5
  "description": "Client for the Stacks Blockchain API",
6
- "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",
7
- "author": "Hiro Systems PBC <engineering@hiro.so> (https://hiro.so)",
6
+ "homepage": "https://github.com/stx-labs/stacks-blockchain-api/tree/master/client#readme",
7
+ "author": "Stacks Labs",
8
8
  "license": "GPL-3.0",
9
9
  "repository": {
10
10
  "type": "git",
11
- "url": "https://github.com/hirosystems/stacks-blockchain-api.git",
11
+ "url": "https://github.com/stx-labs/stacks-blockchain-api.git",
12
12
  "directory": "client"
13
13
  },
14
14
  "bugs": {
15
- "url": "https://github.com/hirosystems/stacks-blockchain-api/issues"
15
+ "url": "https://github.com/stx-labs/stacks-blockchain-api/issues"
16
16
  },
17
17
  "main": "lib/index.js",
18
18
  "unpkg": "lib/index.umd.js",
package/src/generated/schema.d.ts CHANGED
@@ -33,7 +33,8 @@ export interface paths {
33
33
  };
34
34
  /**
35
35
  * Get recent transactions
36
- * @description Retrieves all recently mined transactions
36
+ * @deprecated
37
+ * @description Retrieves all recently mined transactions. **Deprecated:** use `GET /extended/v3/transactions` instead.
37
38
  */
38
39
  get: operations["get_transaction_list"];
39
40
  put?: never;
@@ -73,9 +74,12 @@ export interface paths {
73
74
  };
74
75
  /**
75
76
  * Get mempool transactions
77
+ * @deprecated
76
78
  * @description Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
77
79
  *
78
80
  * 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.
81
+ *
82
+ * **Deprecated:** use `GET /extended/v3/mempool/transactions` instead.
79
83
  */
80
84
  get: operations["get_mempool_transaction_list"];
81
85
  put?: never;
@@ -137,7 +141,8 @@ export interface paths {
137
141
  };
138
142
  /**
139
143
  * Get transaction
140
- * @description Retrieves transaction details for a given transaction ID
144
+ * @deprecated
145
+ * @description Retrieves transaction details for a given transaction ID. **Deprecated:** use `GET /extended/v3/transactions/{tx_id}` instead.
141
146
  */
142
147
  get: operations["get_transaction_by_id"];
143
148
  put?: never;
@@ -157,7 +162,8 @@ export interface paths {
157
162
  };
158
163
  /**
159
164
  * Get raw transaction
160
- * @description Retrieves a hex encoded serialized transaction for a given ID
165
+ * @deprecated
166
+ * @description Retrieves a hex encoded serialized transaction for a given ID. **Deprecated:** use the Stacks node RPC endpoint `GET /v3/transaction/{tx_id}` to fetch a single raw transaction instead.
161
167
  */
162
168
  get: operations["get_raw_transaction_by_id"];
163
169
  put?: never;
@@ -178,7 +184,7 @@ export interface paths {
178
184
  /**
179
185
  * Transactions by block hash
180
186
  * @deprecated
181
- * @description Retrieves a list of all transactions within a block for a given block hash. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
187
+ * @description Retrieves a list of all transactions within a block for a given block hash. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
182
188
  */
183
189
  get: operations["get_transactions_by_block_hash"];
184
190
  put?: never;
@@ -199,7 +205,7 @@ export interface paths {
199
205
  /**
200
206
  * Transactions by block height
201
207
  * @deprecated
202
- * @description Retrieves all transactions within a block at a given height. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
208
+ * @description Retrieves all transactions within a block at a given height. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
203
209
  */
204
210
  get: operations["get_transactions_by_block_height"];
205
211
  put?: never;
@@ -783,7 +789,7 @@ export interface paths {
783
789
  /**
784
790
  * Get account STX balance
785
791
  * @deprecated
786
- * @description Retrieves STX token balance for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_principal_stx_balance`.**
792
+ * @description Retrieves STX token balance for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
787
793
  */
788
794
  get: operations["get_account_stx_balance"];
789
795
  put?: never;
@@ -804,7 +810,7 @@ export interface paths {
804
810
  /**
805
811
  * Get account balances
806
812
  * @deprecated
807
- * @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. **This endpoint is deprecated in favor of `get_principal_ft_balances`.**
813
+ * @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. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx`, `GET /extended/v3/principals/{principal}/balances/ft`, and `GET /extended/v3/principals/{principal}/balances/nft` instead.
808
814
  */
809
815
  get: operations["get_account_balance"];
810
816
  put?: never;
@@ -825,7 +831,7 @@ export interface paths {
825
831
  /**
826
832
  * Get account transactions
827
833
  * @deprecated
828
- * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_address_transactions`.**
834
+ * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
829
835
  */
830
836
  get: operations["get_account_transactions"];
831
837
  put?: never;
@@ -846,7 +852,7 @@ export interface paths {
846
852
  /**
847
853
  * Get account transaction information for specific transaction
848
854
  * @deprecated
849
- * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
855
+ * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
850
856
  */
851
857
  get: operations["get_single_transaction_with_transfers"];
852
858
  put?: never;
@@ -867,7 +873,7 @@ export interface paths {
867
873
  /**
868
874
  * Get account transactions including STX transfers for each transaction.
869
875
  * @deprecated
870
- * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **This endpoint is deprecated in favor of `get_address_transactions`.**
876
+ * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
871
877
  */
872
878
  get: operations["get_account_transactions_with_transfers"];
873
879
  put?: never;
@@ -888,7 +894,7 @@ export interface paths {
888
894
  /**
889
895
  * Get account assets
890
896
  * @deprecated
891
- * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
897
+ * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **Deprecated:** this endpoint has no direct v3 replacement; the closest equivalent is `GET /extended/v3/principals/{principal}/balance-changes`.
892
898
  */
893
899
  get: operations["get_account_assets"];
894
900
  put?: never;
@@ -909,7 +915,7 @@ export interface paths {
909
915
  /**
910
916
  * Get inbound STX transfers
911
917
  * @deprecated
912
- * @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. **This endpoint is deprecated in favor of `get_address_transactions`.**
918
+ * @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 at the `send-many-memo` bulk sending contract. **Deprecated:** this endpoint has no direct v3 replacement.
913
919
  */
914
920
  get: operations["get_account_inbound"];
915
921
  put?: never;
@@ -949,7 +955,8 @@ export interface paths {
949
955
  };
950
956
  /**
951
957
  * Get the latest nonce used by an account
952
- * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
958
+ * @deprecated
959
+ * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions. **Deprecated:** use `GET /extended/v3/principals/{principal}/nonces` instead.
953
960
  */
954
961
  get: operations["get_account_nonces"];
955
962
  put?: never;
@@ -1304,7 +1311,8 @@ export interface paths {
1304
1311
  };
1305
1312
  /**
1306
1313
  * Get transactions by block
1307
- * @description Retrieves transactions confirmed in a single block
1314
+ * @deprecated
1315
+ * @description Retrieves transactions confirmed in a single block. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
1308
1316
  */
1309
1317
  get: operations["get_transactions_by_block"];
1310
1318
  put?: never;
@@ -1604,9 +1612,12 @@ export interface paths {
1604
1612
  };
1605
1613
  /**
1606
1614
  * Get address transactions
1615
+ * @deprecated
1607
1616
  * @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.
1608
1617
  *
1609
1618
  * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).
1619
+ *
1620
+ * **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
1610
1621
  */
1611
1622
  get: operations["get_address_transactions"];
1612
1623
  put?: never;
@@ -1626,7 +1637,8 @@ export interface paths {
1626
1637
  };
1627
1638
  /**
1628
1639
  * Get events for an address transaction
1629
- * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction.
1640
+ * @deprecated
1641
+ * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
1630
1642
  */
1631
1643
  get: operations["get_address_transaction_events"];
1632
1644
  put?: never;
@@ -1646,7 +1658,8 @@ export interface paths {
1646
1658
  };
1647
1659
  /**
1648
1660
  * Get principal STX balance
1649
- * @description Retrieves STX account balance information for a given Address or Contract Identifier.
1661
+ * @deprecated
1662
+ * @description Retrieves STX account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
1650
1663
  */
1651
1664
  get: operations["get_principal_stx_balance"];
1652
1665
  put?: never;
@@ -1666,7 +1679,8 @@ export interface paths {
1666
1679
  };
1667
1680
  /**
1668
1681
  * Get principal FT balances
1669
- * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier.
1682
+ * @deprecated
1683
+ * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft` instead.
1670
1684
  */
1671
1685
  get: operations["get_principal_ft_balances"];
1672
1686
  put?: never;
@@ -1686,7 +1700,8 @@ export interface paths {
1686
1700
  };
1687
1701
  /**
1688
1702
  * Get principal FT balance
1689
- * @description Retrieves a specific fungible-token balance for a given principal.
1703
+ * @deprecated
1704
+ * @description Retrieves a specific fungible-token balance for a given principal. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft/{asset_identifier}` instead.
1690
1705
  */
1691
1706
  get: operations["get_principal_ft_balance"];
1692
1707
  put?: never;
@@ -1897,6 +1912,26 @@ export interface paths {
1897
1912
  patch?: never;
1898
1913
  trace?: never;
1899
1914
  };
1915
+ "/extended/v3/principals/{principal}/balances/ft/{asset_identifier}": {
1916
+ parameters: {
1917
+ query?: never;
1918
+ header?: never;
1919
+ path?: never;
1920
+ cookie?: never;
1921
+ };
1922
+ /**
1923
+ * Get principal FT balance
1924
+ * @description Get a principal's balance of a single fungible token. Returns a zero balance if the principal does not currently hold the token.
1925
+ */
1926
+ get: operations["get_principal_balance_ft"];
1927
+ put?: never;
1928
+ post?: never;
1929
+ delete?: never;
1930
+ options?: never;
1931
+ head?: never;
1932
+ patch?: never;
1933
+ trace?: never;
1934
+ };
1900
1935
  "/extended/v3/principals/{principal}/balances/nft": {
1901
1936
  parameters: {
1902
1937
  query?: never;
@@ -1917,6 +1952,26 @@ export interface paths {
1917
1952
  patch?: never;
1918
1953
  trace?: never;
1919
1954
  };
1955
+ "/extended/v3/principals/{principal}/nonces": {
1956
+ parameters: {
1957
+ query?: never;
1958
+ header?: never;
1959
+ path?: never;
1960
+ cookie?: never;
1961
+ };
1962
+ /**
1963
+ * Get principal nonces
1964
+ * @description Get a Stacks account's latest nonce state by inspecting its confirmed (anchored + microblock) transactions and the mempool, including the nonce to use for its next transaction. Only standard principals have nonces; contract principals are not valid.
1965
+ */
1966
+ get: operations["get_principal_nonces"];
1967
+ put?: never;
1968
+ post?: never;
1969
+ delete?: never;
1970
+ options?: never;
1971
+ head?: never;
1972
+ patch?: never;
1973
+ trace?: never;
1974
+ };
1920
1975
  "/extended/v3/staking/bonds": {
1921
1976
  parameters: {
1922
1977
  query?: never;
@@ -38106,6 +38161,55 @@ export interface operations {
38106
38161
  };
38107
38162
  };
38108
38163
  };
38164
+ get_principal_balance_ft: {
38165
+ parameters: {
38166
+ query?: never;
38167
+ header?: never;
38168
+ path: {
38169
+ principal: string;
38170
+ /**
38171
+ * @description Asset Identifier
38172
+ * @example SP000000000000000000002Q6VF78.pox-3::stx-token
38173
+ */
38174
+ asset_identifier: string;
38175
+ };
38176
+ cookie?: never;
38177
+ };
38178
+ requestBody?: never;
38179
+ responses: {
38180
+ /** @description Default Response */
38181
+ 200: {
38182
+ headers: {
38183
+ [name: string]: unknown;
38184
+ };
38185
+ content: {
38186
+ "application/json": {
38187
+ /**
38188
+ * @description Fungible token asset identifier
38189
+ * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
38190
+ */
38191
+ asset_identifier: string;
38192
+ /** @description The principal's balance of this token, as a string-quoted integer in base units */
38193
+ balance: string;
38194
+ };
38195
+ };
38196
+ };
38197
+ /** @description Default Response */
38198
+ "4XX": {
38199
+ headers: {
38200
+ [name: string]: unknown;
38201
+ };
38202
+ content: {
38203
+ "application/json": {
38204
+ error: string;
38205
+ message?: string;
38206
+ } & {
38207
+ [key: string]: unknown;
38208
+ };
38209
+ };
38210
+ };
38211
+ };
38212
+ };
38109
38213
  get_principal_balances_nft: {
38110
38214
  parameters: {
38111
38215
  query?: {
@@ -38172,6 +38276,58 @@ export interface operations {
38172
38276
  };
38173
38277
  };
38174
38278
  };
38279
+ get_principal_nonces: {
38280
+ parameters: {
38281
+ query?: never;
38282
+ header?: never;
38283
+ path: {
38284
+ /**
38285
+ * @description Stacks Address
38286
+ * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP
38287
+ */
38288
+ principal: string;
38289
+ };
38290
+ cookie?: never;
38291
+ };
38292
+ requestBody?: never;
38293
+ responses: {
38294
+ /** @description Default Response */
38295
+ 200: {
38296
+ headers: {
38297
+ [name: string]: unknown;
38298
+ };
38299
+ content: {
38300
+ "application/json": {
38301
+ /** @description The nonce to use for this principal's next transaction, derived from the latest confirmed and mempool nonces. May be inaccurate if the API is not fully synchronized. */
38302
+ next_nonce: number;
38303
+ last_confirmed_nonce: number | null;
38304
+ /** PrincipalMempoolNonces */
38305
+ mempool: {
38306
+ last_nonce: number | null;
38307
+ /** @description Intermediate nonces found in the mempool between the last confirmed nonce and the highest mempool nonce. */
38308
+ pending_nonces: number[];
38309
+ /** @description Expected intermediate nonces between the last confirmed nonce and the highest mempool nonce that are absent from the mempool — likely stalling transactions. */
38310
+ missing_nonces: number[];
38311
+ };
38312
+ };
38313
+ };
38314
+ };
38315
+ /** @description Default Response */
38316
+ "4XX": {
38317
+ headers: {
38318
+ [name: string]: unknown;
38319
+ };
38320
+ content: {
38321
+ "application/json": {
38322
+ error: string;
38323
+ message?: string;
38324
+ } & {
38325
+ [key: string]: unknown;
38326
+ };
38327
+ };
38328
+ };
38329
+ };
38330
+ };
38175
38331
  get_bonds: {
38176
38332
  parameters: {
38177
38333
  query?: {