Files
stacks-blockchain-api/client/classes/generated.transactionsapi.html

1104 lines
90 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TransactionsApi | @stacks/blockchain-api-client</title>
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@stacks/blockchain-api-client</a>
</li>
<li>
<a href="../modules/generated.html">generated</a>
</li>
<li>
<a href="generated.transactionsapi.html">TransactionsApi</a>
</li>
</ul>
<h1>Class TransactionsApi</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">TransactionsApi</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/generated.transactionsapiinterface.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionsApiInterface</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="generated.transactionsapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="generated.transactionsapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getaddressmempooltransactions" class="tsd-kind-icon">get<wbr>Address<wbr>Mempool<wbr>Transactions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getaddressmempooltransactionsraw" class="tsd-kind-icon">get<wbr>Address<wbr>Mempool<wbr>Transactions<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getdroppedmempooltransactionlist" class="tsd-kind-icon">get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getdroppedmempooltransactionlistraw" class="tsd-kind-icon">get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getmempooltransactionlist" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getmempooltransactionlistraw" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getrawtransactionbyid" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>ById</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#getrawtransactionbyidraw" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>ById<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionbyid" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionbyidraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionlist" class="tsd-kind-icon">get<wbr>Transaction<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionlistraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>List<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionsbyblockhash" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Hash</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionsbyblockhashraw" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Hash<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionsbyblockheight" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettransactionsbyblockheightraw" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Height<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettxlistdetails" class="tsd-kind-icon">get<wbr>TxList<wbr>Details</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#gettxlistdetailsraw" class="tsd-kind-icon">get<wbr>TxList<wbr>Details<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#postcorenodetransactions" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.transactionsapi.html#postcorenodetransactionsraw" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="generated.transactionsapi.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.transactionsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.transactionsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.transactionsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Transactions<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.transactionsapi.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionsApi</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L25">src/generated/runtime.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>configuration: <a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="generated.transactionsapi.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionsApi</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="configuration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#configuration">configuration</a></p>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getaddressmempooltransactions" class="tsd-anchor"></a>
<h3>get<wbr>Address<wbr>Mempool<wbr>Transactions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Address<wbr>Mempool<wbr>Transactions<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getaddressmempooltransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAddressMempoolTransactionsRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getaddressmempooltransactions">getAddressMempoolTransactions</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L331">src/generated/apis/TransactionsApi.ts:331</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all transactions for a given address that are currently in mempool
Transactions for address</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getaddressmempooltransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAddressMempoolTransactionsRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getaddressmempooltransactionsraw" class="tsd-anchor"></a>
<h3>get<wbr>Address<wbr>Mempool<wbr>Transactions<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Address<wbr>Mempool<wbr>Transactions<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getaddressmempooltransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAddressMempoolTransactionsRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getaddressmempooltransactionsraw">getAddressMempoolTransactionsRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L296">src/generated/apis/TransactionsApi.ts:296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all transactions for a given address that are currently in mempool
Transactions for address</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getaddressmempooltransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAddressMempoolTransactionsRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdroppedmempooltransactionlist" class="tsd-anchor"></a>
<h3>get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getdroppedmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDroppedMempoolTransactionListRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getdroppedmempooltransactionlist">getDroppedMempoolTransactionList</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L367">src/generated/apis/TransactionsApi.ts:367</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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 dropped mempool transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getdroppedmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDroppedMempoolTransactionListRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdroppedmempooltransactionlistraw" class="tsd-anchor"></a>
<h3>get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getdroppedmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDroppedMempoolTransactionListRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getdroppedmempooltransactionlistraw">getDroppedMempoolTransactionListRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L340">src/generated/apis/TransactionsApi.ts:340</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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 dropped mempool transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getdroppedmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDroppedMempoolTransactionListRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmempooltransactionlist" class="tsd-anchor"></a>
<h3>get<wbr>Mempool<wbr>Transaction<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetMempoolTransactionListRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getmempooltransactionlist">getMempoolTransactionList</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L419">src/generated/apis/TransactionsApi.ts:419</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
Get mempool transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetMempoolTransactionListRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmempooltransactionlistraw" class="tsd-anchor"></a>
<h3>get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetMempoolTransactionListRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getmempooltransactionlistraw">getMempoolTransactionListRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L376">src/generated/apis/TransactionsApi.ts:376</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
Get mempool transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getmempooltransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetMempoolTransactionListRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.mempooltransactionlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getrawtransactionbyid" class="tsd-anchor"></a>
<h3>get<wbr>Raw<wbr>Transaction<wbr>ById</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>ById<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getrawtransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionByIdRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.getrawtransactionresult.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getrawtransactionbyid">getRawTransactionById</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L451">src/generated/apis/TransactionsApi.ts:451</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves a hex encoded serialized transaction for a given ID
Get Raw Transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getrawtransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionByIdRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.getrawtransactionresult.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getrawtransactionbyidraw" class="tsd-anchor"></a>
<h3>get<wbr>Raw<wbr>Transaction<wbr>ById<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>ById<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.getrawtransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionByIdRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.getrawtransactionresult.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#getrawtransactionbyidraw">getRawTransactionByIdRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L428">src/generated/apis/TransactionsApi.ts:428</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves a hex encoded serialized transaction for a given ID
Get Raw Transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.getrawtransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionByIdRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.getrawtransactionresult.html" class="tsd-signature-type" data-tsd-kind="Interface">GetRawTransactionResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionbyid" class="tsd-anchor"></a>
<h3>get<wbr>Transaction<wbr>ById</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>ById<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionByIdRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionbyid">getTransactionById</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L495">src/generated/apis/TransactionsApi.ts:495</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves transaction details for a given transaction ID <code>import type { Transaction } from \&#39;@stacks/stacks-blockchain-api-types\&#39;;</code>
Get transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionByIdRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionbyidraw" class="tsd-anchor"></a>
<h3>get<wbr>Transaction<wbr>ById<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>ById<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionByIdRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionbyidraw">getTransactionByIdRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L460">src/generated/apis/TransactionsApi.ts:460</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves transaction details for a given transaction ID <code>import type { Transaction } from \&#39;@stacks/stacks-blockchain-api-types\&#39;;</code>
Get transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionbyidrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionByIdRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionlist" class="tsd-anchor"></a>
<h3>get<wbr>Transaction<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionListRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionlist">getTransactionList</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L539">src/generated/apis/TransactionsApi.ts:539</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all recently mined transactions If using TypeScript, import typings for this response from our types package: <code>import type { TransactionResults } from \&#39;@stacks/stacks-blockchain-api-types\&#39;;</code>
Get recent transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionListRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionlistraw" class="tsd-anchor"></a>
<h3>get<wbr>Transaction<wbr>List<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionListRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionlistraw">getTransactionListRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L504">src/generated/apis/TransactionsApi.ts:504</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all recently mined transactions If using TypeScript, import typings for this response from our types package: <code>import type { TransactionResults } from \&#39;@stacks/stacks-blockchain-api-types\&#39;;</code>
Get recent transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionlistrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionListRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionsbyblockhash" class="tsd-anchor"></a>
<h3>get<wbr>Transactions<wbr>ByBlock<wbr>Hash</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Hash<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionsbyblockhashrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHashRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionsbyblockhash">getTransactionsByBlockHash</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L579">src/generated/apis/TransactionsApi.ts:579</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves a list of all transactions within a block for a given block hash.
Transactions by block hash</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionsbyblockhashrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHashRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionsbyblockhashraw" class="tsd-anchor"></a>
<h3>get<wbr>Transactions<wbr>ByBlock<wbr>Hash<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Hash<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionsbyblockhashrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHashRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionsbyblockhashraw">getTransactionsByBlockHashRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L548">src/generated/apis/TransactionsApi.ts:548</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves a list of all transactions within a block for a given block hash.
Transactions by block hash</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionsbyblockhashrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHashRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionsbyblockheight" class="tsd-anchor"></a>
<h3>get<wbr>Transactions<wbr>ByBlock<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Height<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionsbyblockheightrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHeightRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionsbyblockheight">getTransactionsByBlockHeight</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L623">src/generated/apis/TransactionsApi.ts:623</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all transactions within a block at a given height
Transactions by block height</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionsbyblockheightrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHeightRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransactionsbyblockheightraw" class="tsd-anchor"></a>
<h3>get<wbr>Transactions<wbr>ByBlock<wbr>Height<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Height<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettransactionsbyblockheightrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHeightRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettransactionsbyblockheightraw">getTransactionsByBlockHeightRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L588">src/generated/apis/TransactionsApi.ts:588</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves all transactions within a block at a given height
Transactions by block height</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettransactionsbyblockheightrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTransactionsByBlockHeightRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated.transactionresults.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionResults</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettxlistdetails" class="tsd-anchor"></a>
<h3>get<wbr>TxList<wbr>Details</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>TxList<wbr>Details<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettxlistdetailsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTxListDetailsRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettxlistdetails">getTxListDetails</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L671">src/generated/apis/TransactionsApi.ts:671</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves a list of transactions for a given list of transaction IDs If using TypeScript, import typings for this response from our types package: <code>import type { Transaction } from \&#39;@stacks/stacks-blockchain-api-types\&#39;;</code>
Get list of details for transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettxlistdetailsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTxListDetailsRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettxlistdetailsraw" class="tsd-anchor"></a>
<h3>get<wbr>TxList<wbr>Details<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>TxList<wbr>Details<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.gettxlistdetailsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTxListDetailsRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#gettxlistdetailsraw">getTxListDetailsRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L632">src/generated/apis/TransactionsApi.ts:632</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves a list of transactions for a given list of transaction IDs If using TypeScript, import typings for this response from our types package: <code>import type { Transaction } from \&#39;@stacks/stacks-blockchain-api-types\&#39;;</code>
Get list of details for transactions</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.gettxlistdetailsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetTxListDetailsRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="postcorenodetransactions" class="tsd-anchor"></a>
<h3>post<wbr>Core<wbr>Node<wbr>Transactions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.postcorenodetransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PostCoreNodeTransactionsRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#postcorenodetransactions">postCoreNodeTransactions</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L702">src/generated/apis/TransactionsApi.ts:702</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Broadcasts raw transactions on the network. You can use the <a href="https://github.com/blockstack/stacks.js">@stacks/transactions</a> project to generate a raw transaction payload.
Broadcast raw transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.postcorenodetransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PostCoreNodeTransactionsRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="postcorenodetransactionsraw" class="tsd-anchor"></a>
<h3>post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.postcorenodetransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PostCoreNodeTransactionsRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/generated.transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/generated.transactionsapiinterface.html#postcorenodetransactionsraw">postCoreNodeTransactionsRaw</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/TransactionsApi.ts#L680">src/generated/apis/TransactionsApi.ts:680</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Broadcasts raw transactions on the network. You can use the <a href="https://github.com/blockstack/stacks.js">@stacks/transactions</a> project to generate a raw transaction payload.
Broadcast raw transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestParameters: <a href="../interfaces/generated.postcorenodetransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PostCoreNodeTransactionsRequest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#request">request</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L47">src/generated/runtime.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>context: <a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="withmiddleware" class="tsd-anchor"></a>
<h3>with<wbr>Middleware</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware&lt;T&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#withmiddleware">withMiddleware</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L31">src/generated/runtime.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="withpostmiddleware" class="tsd-anchor"></a>
<h3>with<wbr>Post<wbr>Middleware</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware&lt;T&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-signature-type" data-tsd-kind="Interface">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L42">src/generated/runtime.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-signature-type" data-tsd-kind="Interface">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="withpremiddleware" class="tsd-anchor"></a>
<h3>with<wbr>Pre<wbr>Middleware</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware&lt;T&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchParams</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#withpremiddleware">withPreMiddleware</a></p>
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L37">src/generated/runtime.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchParams</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/generated.html">generated</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/generated_runtime.html">generated/runtime</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/socket_io.html">socket-<wbr>io</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/ws.html">ws</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="generated.transactionsapi.html" class="tsd-kind-icon">Transactions<wbr>Api</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="generated.transactionsapi.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="generated.transactionsapi.html#configuration" class="tsd-kind-icon">configuration</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getaddressmempooltransactions" class="tsd-kind-icon">get<wbr>Address<wbr>Mempool<wbr>Transactions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getaddressmempooltransactionsraw" class="tsd-kind-icon">get<wbr>Address<wbr>Mempool<wbr>Transactions<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getdroppedmempooltransactionlist" class="tsd-kind-icon">get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getdroppedmempooltransactionlistraw" class="tsd-kind-icon">get<wbr>Dropped<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getmempooltransactionlist" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getmempooltransactionlistraw" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getrawtransactionbyid" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>ById</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#getrawtransactionbyidraw" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>ById<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionbyid" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionbyidraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionlist" class="tsd-kind-icon">get<wbr>Transaction<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionlistraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>List<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionsbyblockhash" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Hash</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionsbyblockhashraw" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Hash<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionsbyblockheight" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Height</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettransactionsbyblockheightraw" class="tsd-kind-icon">get<wbr>Transactions<wbr>ByBlock<wbr>Height<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettxlistdetails" class="tsd-kind-icon">get<wbr>TxList<wbr>Details</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#gettxlistdetailsraw" class="tsd-kind-icon">get<wbr>TxList<wbr>Details<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#postcorenodetransactions" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="generated.transactionsapi.html#postcorenodetransactionsraw" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="generated.transactionsapi.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="generated.transactionsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="generated.transactionsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="generated.transactionsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>