mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-01-12 22:43:34 +08:00
1001 lines
71 KiB
HTML
1001 lines
71 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>AccountsApiInterface | @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.accountsapiinterface.html">AccountsApiInterface</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface AccountsApiInterface</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>AccountsApi - interface</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>export</dt>
|
|
<dd></dd>
|
|
<dt>interface</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">AccountsApiInterface</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implemented by</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../classes/generated.accountsapi.html" class="tsd-signature-type" data-tsd-kind="Class">AccountsApi</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 ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountassets" class="tsd-kind-icon">get<wbr>Account<wbr>Assets</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountassetsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Assets<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Balance<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountinbound" class="tsd-kind-icon">get<wbr>Account<wbr>Inbound</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountinboundraw" class="tsd-kind-icon">get<wbr>Account<wbr>Inbound<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountinfo" class="tsd-kind-icon">get<wbr>Account<wbr>Info</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountinforaw" class="tsd-kind-icon">get<wbr>Account<wbr>Info<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountnft" class="tsd-kind-icon">get<wbr>Account<wbr>Nft</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountnftraw" class="tsd-kind-icon">get<wbr>Account<wbr>Nft<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountnonces" class="tsd-kind-icon">get<wbr>Account<wbr>Nonces</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountnoncesraw" class="tsd-kind-icon">get<wbr>Account<wbr>Nonces<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountstxbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccountstxbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccounttransactions" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccounttransactionsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccounttransactionswithtransfers" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getaccounttransactionswithtransfersraw" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getsingletransactionwithtransfers" class="tsd-kind-icon">get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.accountsapiinterface.html#getsingletransactionwithtransfersraw" class="tsd-kind-icon">get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers<wbr>Raw</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</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-interface">
|
|
<a name="getaccountassets" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Assets</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Assets<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountassetsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountAssetsRequest</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"><</span><a href="generated.addressassetslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L144">src/generated/apis/AccountsApi.ts:144</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
|
|
Get account assets</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountassetsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountAssetsRequest</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"><</span><a href="generated.addressassetslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountassetsraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Assets<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Assets<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountassetsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountAssetsRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressassetslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L138">src/generated/apis/AccountsApi.ts:138</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account assets</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountassetsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountAssetsRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressassetslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountbalance" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Balance</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Balance<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountBalanceRequest</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"><</span><a href="generated.addressbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L162">src/generated/apis/AccountsApi.ts:162</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
|
|
Get account balances</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountBalanceRequest</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"><</span><a href="generated.addressbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountbalanceraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Balance<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Balance<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountBalanceRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L156">src/generated/apis/AccountsApi.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>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.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account balances</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountBalanceRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountinbound" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Inbound</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Inbound<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountinboundrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInboundRequest</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"><</span><a href="generated.addressstxinboundlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressStxInboundListResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L183">src/generated/apis/AccountsApi.ts:183</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>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 <code>send-many-memo</code> bulk sending contract.
|
|
Get inbound STX transfers</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountinboundrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInboundRequest</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"><</span><a href="generated.addressstxinboundlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressStxInboundListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountinboundraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Inbound<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Inbound<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountinboundrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInboundRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressstxinboundlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressStxInboundListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L177">src/generated/apis/AccountsApi.ts:177</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>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 <code>send-many-memo</code> bulk sending contract.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get inbound STX transfers</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountinboundrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInboundRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressstxinboundlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressStxInboundListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Info<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountinforequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInfoRequest</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"><</span><a href="generated.accountdataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDataResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L201">src/generated/apis/AccountsApi.ts:201</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the account data for a given Account or a Contract Identifier Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
|
|
Get account info</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountinforequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInfoRequest</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"><</span><a href="generated.accountdataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDataResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountinforaw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Info<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Info<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountinforequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInfoRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.accountdataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDataResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L195">src/generated/apis/AccountsApi.ts:195</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the account data for a given Account or a Contract Identifier Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account info</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountinforequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInfoRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.accountdataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDataResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountnft" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Nft</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Nft<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountnftrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNftRequest</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"><</span><a href="generated.addressnftlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNftListResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L221">src/generated/apis/AccountsApi.ts:221</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
|
|
Get nft events</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountnftrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNftRequest</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"><</span><a href="generated.addressnftlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNftListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountnftraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Nft<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Nft<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountnftrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNftRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressnftlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNftListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L215">src/generated/apis/AccountsApi.ts:215</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get nft events</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountnftrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNftRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressnftlistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNftListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountnonces" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Nonces</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Nonces<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountnoncesrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNoncesRequest</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"><</span><a href="generated.addressnonces.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNonces</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L239">src/generated/apis/AccountsApi.ts:239</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
|
|
Get the latest nonce used by an account</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountnoncesrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNoncesRequest</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"><</span><a href="generated.addressnonces.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNonces</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountnoncesraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Nonces<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Nonces<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountnoncesrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNoncesRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressnonces.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNonces</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L233">src/generated/apis/AccountsApi.ts:233</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get the latest nonce used by an account</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountnoncesrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountNoncesRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addressnonces.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressNonces</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountstxbalance" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Stx<wbr>Balance</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountstxbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountStxBalanceRequest</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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L257">src/generated/apis/AccountsApi.ts:257</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves STX token balance for a given Address or Contract Identifier.
|
|
Get account STX balance</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountstxbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountStxBalanceRequest</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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccountstxbalanceraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccountstxbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountStxBalanceRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L251">src/generated/apis/AccountsApi.ts:251</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves STX token balance for a given Address or Contract Identifier.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account STX balance</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccountstxbalancerequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountStxBalanceRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccounttransactions" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Transactions</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Transactions<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccounttransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsRequest</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"><</span><a href="generated.addresstransactionslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L278">src/generated/apis/AccountsApi.ts:278</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found <a href="https://docs.stacks.co/understand-stacks/transactions#types">here</a>.
|
|
Get account transactions</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccounttransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsRequest</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"><</span><a href="generated.addresstransactionslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccounttransactionsraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Transactions<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccounttransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addresstransactionslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L272">src/generated/apis/AccountsApi.ts:272</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found <a href="https://docs.stacks.co/understand-stacks/transactions#types">here</a>.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account transactions</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccounttransactionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addresstransactionslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccounttransactionswithtransfers" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccounttransactionswithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsWithTransfersRequest</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"><</span><a href="generated.addresstransactionswithtransferslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsWithTransfersListResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L299">src/generated/apis/AccountsApi.ts:299</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
|
|
Get account transactions including STX transfers for each transaction.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccounttransactionswithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsWithTransfersRequest</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"><</span><a href="generated.addresstransactionswithtransferslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsWithTransfersListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getaccounttransactionswithtransfersraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getaccounttransactionswithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsWithTransfersRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addresstransactionswithtransferslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsWithTransfersListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L293">src/generated/apis/AccountsApi.ts:293</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account transactions including STX transfers for each transaction.</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getaccounttransactionswithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountTransactionsWithTransfersRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addresstransactionswithtransferslistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionsWithTransfersListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getsingletransactionwithtransfers" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getsingletransactionwithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetSingleTransactionWithTransfersRequest</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"><</span><a href="generated.addresstransactionwithtransfers.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionWithTransfers</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L316">src/generated/apis/AccountsApi.ts:316</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves transaction details for a given Transcation Id <code>tx_id</code>, for a given account or contract Identifier.
|
|
Get account transaction information for specific transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getsingletransactionwithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetSingleTransactionWithTransfersRequest</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"><</span><a href="generated.addresstransactionwithtransfers.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionWithTransfers</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="getsingletransactionwithtransfersraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="generated.getsingletransactionwithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetSingleTransactionWithTransfersRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addresstransactionwithtransfers.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionWithTransfers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/AccountsApi.ts#L310">src/generated/apis/AccountsApi.ts:310</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves transaction details for a given Transcation Id <code>tx_id</code>, for a given account or contract Identifier.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>summary</dt>
|
|
<dd><p>Get account transaction information for specific transaction</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>{RequiredError}</p>
|
|
</dd>
|
|
<dt>memberof</dt>
|
|
<dd><p>AccountsApiInterface</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="generated.getsingletransactionwithtransfersrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetSingleTransactionWithTransfersRequest</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"><</span><a href="generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="generated.addresstransactionwithtransfers.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressTransactionWithTransfers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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-interface tsd-parent-kind-module">
|
|
<a href="generated.accountsapiinterface.html" class="tsd-kind-icon">Accounts<wbr>Api<wbr>Interface</a>
|
|
<ul>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountassets" class="tsd-kind-icon">get<wbr>Account<wbr>Assets</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountassetsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Assets<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Balance<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountinbound" class="tsd-kind-icon">get<wbr>Account<wbr>Inbound</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountinboundraw" class="tsd-kind-icon">get<wbr>Account<wbr>Inbound<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountinfo" class="tsd-kind-icon">get<wbr>Account<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountinforaw" class="tsd-kind-icon">get<wbr>Account<wbr>Info<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountnft" class="tsd-kind-icon">get<wbr>Account<wbr>Nft</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountnftraw" class="tsd-kind-icon">get<wbr>Account<wbr>Nft<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountnonces" class="tsd-kind-icon">get<wbr>Account<wbr>Nonces</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountnoncesraw" class="tsd-kind-icon">get<wbr>Account<wbr>Nonces<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountstxbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccountstxbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccounttransactions" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccounttransactionsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccounttransactionswithtransfers" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getaccounttransactionswithtransfersraw" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>With<wbr>Transfers<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getsingletransactionwithtransfers" class="tsd-kind-icon">get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="generated.accountsapiinterface.html#getsingletransactionwithtransfersraw" class="tsd-kind-icon">get<wbr>Single<wbr>Transaction<wbr>With<wbr>Transfers<wbr>Raw</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-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>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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> |