mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-11 16:25:48 +00:00
340 lines
16 KiB
HTML
340 lines
16 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>AccountInfoRequest | xrpl</title>
|
|
<meta name="description" content="Documentation for xrpl">
|
|
<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">xrpl</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">xrpl</a>
|
|
</li>
|
|
<li>
|
|
<a href="AccountInfoRequest.html">AccountInfoRequest</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface AccountInfoRequest</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>The <code>account_info</code> command retrieves information about an account, its
|
|
activity, and its XRP balance. All information retrieved is relative to a
|
|
particular version of the ledger. Returns an <a href="AccountInfoResponse.html">AccountInfoResponse</a>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="tsd-signature-type">BaseRequest</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">AccountInfoRequest</span>
|
|
</li>
|
|
</ul>
|
|
</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="AccountInfoRequest.html#account" class="tsd-kind-icon">account</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountInfoRequest.html#command" class="tsd-kind-icon">command</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#id" class="tsd-kind-icon">id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#queue" class="tsd-kind-icon">queue</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#signer_lists" class="tsd-kind-icon">signer_<wbr>lists</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#strict" class="tsd-kind-icon">strict</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="account" class="tsd-anchor"></a>
|
|
<h3>account</h3>
|
|
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L16">src/models/methods/accountInfo.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A unique identifier for the account, most commonly the account's address.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="api_version" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
|
|
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseRequest.api_version</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">src/models/methods/baseMethod.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The API version to use. If omitted, use version 1.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="command" class="tsd-anchor"></a>
|
|
<h3>command</h3>
|
|
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"account_info"</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides BaseRequest.command</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L14">src/models/methods/accountInfo.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="id" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseRequest.id</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">src/models/methods/baseMethod.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A unique value to identify this request. The response to this request uses
|
|
the same id field. This way, even if responses arrive out of order, you
|
|
know which request prompted which response.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="ledger_hash" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L18">src/models/methods/accountInfo.ts:18</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A 20-byte hex string for the ledger version to use.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="ledger_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L23">src/models/methods/accountInfo.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The ledger index of the ledger to use, or a shortcut string to choose a
|
|
ledger automatically.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="queue" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> queue</h3>
|
|
<div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L29">src/models/methods/accountInfo.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Whether to get info about this account's queued transactions. Can only be
|
|
used when querying for the data from the current open ledger. Not available
|
|
from servers in Reporting Mode.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="signer_lists" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> signer_<wbr>lists</h3>
|
|
<div class="tsd-signature tsd-kind-icon">signer_<wbr>lists<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L33">src/models/methods/accountInfo.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Request SignerList objects associated with this account.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="strict" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
|
|
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L39">src/models/methods/accountInfo.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>If true, then the account field only accepts a public key or XRP Ledger
|
|
address. Otherwise, account can be a secret or passphrase (not
|
|
recommended). The default is false.</p>
|
|
</div>
|
|
</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">Exports</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">
|
|
<a href="AccountInfoRequest.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Request</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="AccountInfoRequest.html#account" class="tsd-kind-icon">account</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="AccountInfoRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="AccountInfoRequest.html#command" class="tsd-kind-icon">command</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="AccountInfoRequest.html#id" class="tsd-kind-icon">id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="AccountInfoRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="AccountInfoRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="AccountInfoRequest.html#queue" class="tsd-kind-icon">queue</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="AccountInfoRequest.html#signer_lists" class="tsd-kind-icon">signer_<wbr>lists</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="AccountInfoRequest.html#strict" class="tsd-kind-icon">strict</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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> |