kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-05-29 00:21:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
0880faf7e6316250ee7897e9d3a696c2ef226c19
stacks-blockchain-api/client/interfaces/generated.getstxsupplylegacyformatresponse.html

319 lines
13 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>GetStxSupplyLegacyFormatResponse | @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.getstxsupplylegacyformatresponse.html">GetStxSupplyLegacyFormatResponse</a>
</li>
</ul>
<h1>Interface GetStxSupplyLegacyFormatResponse</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>GET request that returns network target block times</p>
</div>
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>interface</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">GetStxSupplyLegacyFormatResponse</span>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.getstxsupplylegacyformatresponse.html#blockheight" class="tsd-kind-icon">block<wbr>Height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.getstxsupplylegacyformatresponse.html#totalstacks" class="tsd-kind-icon">total<wbr>Stacks</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.getstxsupplylegacyformatresponse.html#totalstacksformatted" class="tsd-kind-icon">total<wbr>Stacks<wbr>Formatted</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.getstxsupplylegacyformatresponse.html#unlockedpercent" class="tsd-kind-icon">unlocked<wbr>Percent</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.getstxsupplylegacyformatresponse.html#unlockedsupply" class="tsd-kind-icon">unlocked<wbr>Supply</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.getstxsupplylegacyformatresponse.html#unlockedsupplyformatted" class="tsd-kind-icon">unlocked<wbr>Supply<wbr>Formatted</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="blockheight" class="tsd-anchor"></a>
<h3>block<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">block<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/GetStxSupplyLegacyFormatResponse.ts:57</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The block height at which this information was queried</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="totalstacks" class="tsd-anchor"></a>
<h3>total<wbr>Stacks</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Stacks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/GetStxSupplyLegacyFormatResponse.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>String quoted decimal number of the total possible number of STX</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="totalstacksformatted" class="tsd-anchor"></a>
<h3>total<wbr>Stacks<wbr>Formatted</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Stacks<wbr>Formatted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/GetStxSupplyLegacyFormatResponse.ts:39</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Same as <code>totalStacks</code> but formatted with comma thousands separators</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="unlockedpercent" class="tsd-anchor"></a>
<h3>unlocked<wbr>Percent</h3>
<div class="tsd-signature tsd-kind-icon">unlocked<wbr>Percent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/GetStxSupplyLegacyFormatResponse.ts:27</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>String quoted decimal number of the percentage of STX that have unlocked</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="unlockedsupply" class="tsd-anchor"></a>
<h3>unlocked<wbr>Supply</h3>
<div class="tsd-signature tsd-kind-icon">unlocked<wbr>Supply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/GetStxSupplyLegacyFormatResponse.ts:45</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>String quoted decimal number of the STX that have been mined or unlocked</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="unlockedsupplyformatted" class="tsd-anchor"></a>
<h3>unlocked<wbr>Supply<wbr>Formatted</h3>
<div class="tsd-signature tsd-kind-icon">unlocked<wbr>Supply<wbr>Formatted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/GetStxSupplyLegacyFormatResponse.ts:51</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Same as <code>unlockedSupply</code> but formatted with comma thousands separators</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>GetStxSupplyLegacyFormatResponse</p>
</dd>
</dl>
</div>
</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.getstxsupplylegacyformatresponse.html" class="tsd-kind-icon">Get<wbr>Stx<wbr>Supply<wbr>Legacy<wbr>Format<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.getstxsupplylegacyformatresponse.html#blockheight" class="tsd-kind-icon">block<wbr>Height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.getstxsupplylegacyformatresponse.html#totalstacks" class="tsd-kind-icon">total<wbr>Stacks</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.getstxsupplylegacyformatresponse.html#totalstacksformatted" class="tsd-kind-icon">total<wbr>Stacks<wbr>Formatted</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.getstxsupplylegacyformatresponse.html#unlockedpercent" class="tsd-kind-icon">unlocked<wbr>Percent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.getstxsupplylegacyformatresponse.html#unlockedsupply" class="tsd-kind-icon">unlocked<wbr>Supply</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.getstxsupplylegacyformatresponse.html#unlockedsupplyformatted" class="tsd-kind-icon">unlocked<wbr>Supply<wbr>Formatted</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
Reference in New Issue View Git Blame Copy Permalink