UNPKG

binance-api-client

Version:

A wrapper which can be used to interact with Binance's API. Entirely developed in TypeScript.

689 lines 42.3 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Symbol | binance-api-client</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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.js" 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">binance-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> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_src_models_misc_symbol_.html">&quot;src/models/misc/Symbol&quot;</a> </li> <li> <a href="_src_models_misc_symbol_.symbol.html">Symbol</a> </li> </ul> <h1>Class Symbol</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>Represents a single symbol.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Symbol</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_baseasset" class="tsd-kind-icon">_base<wbr>Asset</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_baseassetprecision" class="tsd-kind-icon">_base<wbr>Asset<wbr>Precision</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_filters" class="tsd-kind-icon">_filters</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_icebergallowed" class="tsd-kind-icon">_iceberg<wbr>Allowed</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_name" class="tsd-kind-icon">_name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_ordertypes" class="tsd-kind-icon">_order<wbr>Types</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_quoteasset" class="tsd-kind-icon">_quote<wbr>Asset</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_quoteassetprecision" class="tsd-kind-icon">_quote<wbr>Asset<wbr>Precision</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_src_models_misc_symbol_.symbol.html#_status" class="tsd-kind-icon">_status</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#baseasset" class="tsd-kind-icon">base<wbr>Asset</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#baseassetprecision" class="tsd-kind-icon">base<wbr>Asset<wbr>Precision</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#filters" class="tsd-kind-icon">filters</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#icebergallowed" class="tsd-kind-icon">iceberg<wbr>Allowed</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#ordertypes" class="tsd-kind-icon">order<wbr>Types</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#quoteasset" class="tsd-kind-icon">quote<wbr>Asset</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#quoteassetprecision" class="tsd-kind-icon">quote<wbr>Asset<wbr>Precision</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_src_models_misc_symbol_.symbol.html#status" class="tsd-kind-icon">status</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Symbol<span class="tsd-signature-symbol">(</span>json<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_models_misc_symbol_.symbol.html" class="tsd-signature-type">Symbol</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L24">src/models/misc/Symbol.ts:24</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>json: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_src_models_misc_symbol_.symbol.html" class="tsd-signature-type">Symbol</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_baseasset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _base<wbr>Asset</h3> <div class="tsd-signature tsd-kind-icon">_base<wbr>Asset<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/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L18">src/models/misc/Symbol.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_baseassetprecision" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _base<wbr>Asset<wbr>Precision</h3> <div class="tsd-signature tsd-kind-icon">_base<wbr>Asset<wbr>Precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L19">src/models/misc/Symbol.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_filters" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _filters</h3> <div class="tsd-signature tsd-kind-icon">_filters<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_src_models_filter_abstraction_symbolfilter_.symbolfilter.html" class="tsd-signature-type">SymbolFilter</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L24">src/models/misc/Symbol.ts:24</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_icebergallowed" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _iceberg<wbr>Allowed</h3> <div class="tsd-signature tsd-kind-icon">_iceberg<wbr>Allowed<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/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L23">src/models/misc/Symbol.ts:23</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _name</h3> <div class="tsd-signature tsd-kind-icon">_name<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/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L16">src/models/misc/Symbol.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_ordertypes" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _order<wbr>Types</h3> <div class="tsd-signature tsd-kind-icon">_order<wbr>Types<span class="tsd-signature-symbol">:</span> <a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L22">src/models/misc/Symbol.ts:22</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_quoteasset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _quote<wbr>Asset</h3> <div class="tsd-signature tsd-kind-icon">_quote<wbr>Asset<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/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L20">src/models/misc/Symbol.ts:20</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_quoteassetprecision" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _quote<wbr>Asset<wbr>Precision</h3> <div class="tsd-signature tsd-kind-icon">_quote<wbr>Asset<wbr>Precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L21">src/models/misc/Symbol.ts:21</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_status" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _status</h3> <div class="tsd-signature tsd-kind-icon">_status<span class="tsd-signature-symbol">:</span> <a href="../enums/_src_enums_symbolstatus_.symbolstatus.html" class="tsd-signature-type">SymbolStatus</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L17">src/models/misc/Symbol.ts:17</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="baseasset" class="tsd-anchor"></a> <h3>base<wbr>Asset</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> baseAsset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> baseAsset<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L91">src/models/misc/Symbol.ts:91</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L95">src/models/misc/Symbol.ts:95</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="baseassetprecision" class="tsd-anchor"></a> <h3>base<wbr>Asset<wbr>Precision</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> baseAssetPrecision<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> baseAssetPrecision<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L99">src/models/misc/Symbol.ts:99</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L103">src/models/misc/Symbol.ts:103</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="filters" class="tsd-anchor"></a> <h3>filters</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> filters<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_src_models_filter_abstraction_symbolfilter_.symbolfilter.html" class="tsd-signature-type">SymbolFilter</a><span class="tsd-signature-symbol">[]</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> filters<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../interfaces/_src_models_filter_abstraction_symbolfilter_.symbolfilter.html" class="tsd-signature-type">SymbolFilter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L139">src/models/misc/Symbol.ts:139</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_src_models_filter_abstraction_symbolfilter_.symbolfilter.html" class="tsd-signature-type">SymbolFilter</a><span class="tsd-signature-symbol">[]</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L143">src/models/misc/Symbol.ts:143</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <a href="../interfaces/_src_models_filter_abstraction_symbolfilter_.symbolfilter.html" class="tsd-signature-type">SymbolFilter</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="icebergallowed" class="tsd-anchor"></a> <h3>iceberg<wbr>Allowed</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> icebergAllowed<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> icebergAllowed<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L131">src/models/misc/Symbol.ts:131</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L135">src/models/misc/Symbol.ts:135</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="name" class="tsd-anchor"></a> <h3>name</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> name<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L75">src/models/misc/Symbol.ts:75</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L79">src/models/misc/Symbol.ts:79</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="ordertypes" class="tsd-anchor"></a> <h3>order<wbr>Types</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> orderTypes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a><span class="tsd-signature-symbol">[]</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> orderTypes<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L123">src/models/misc/Symbol.ts:123</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a><span class="tsd-signature-symbol">[]</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L127">src/models/misc/Symbol.ts:127</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="quoteasset" class="tsd-anchor"></a> <h3>quote<wbr>Asset</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> quoteAsset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> quoteAsset<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L107">src/models/misc/Symbol.ts:107</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L111">src/models/misc/Symbol.ts:111</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="quoteassetprecision" class="tsd-anchor"></a> <h3>quote<wbr>Asset<wbr>Precision</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> quoteAssetPrecision<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> quoteAssetPrecision<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L115">src/models/misc/Symbol.ts:115</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L119">src/models/misc/Symbol.ts:119</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="status" class="tsd-anchor"></a> <h3>status</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> status<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_symbolstatus_.symbolstatus.html" class="tsd-signature-type">SymbolStatus</a></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> status<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_symbolstatus_.symbolstatus.html" class="tsd-signature-type">SymbolStatus</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L83">src/models/misc/Symbol.ts:83</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../enums/_src_enums_symbolstatus_.symbolstatus.html" class="tsd-signature-type">SymbolStatus</a></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/models/misc/Symbol.ts#L87">src/models/misc/Symbol.ts:87</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <a href="../enums/_src_enums_symbolstatus_.symbolstatus.html" class="tsd-signature-type">SymbolStatus</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_src_models_misc_symbol_.html">"src/models/misc/<wbr>Symbol"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_src_models_misc_symbol_.symbol.html" class="tsd-kind-icon">Symbol</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_baseasset" class="tsd-kind-icon">_base<wbr>Asset</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_baseassetprecision" class="tsd-kind-icon">_base<wbr>Asset<wbr>Precision</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_filters" class="tsd-kind-icon">_filters</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_icebergallowed" class="tsd-kind-icon">_iceberg<wbr>Allowed</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_name" class="tsd-kind-icon">_name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_ordertypes" class="tsd-kind-icon">_order<wbr>Types</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_quoteasset" class="tsd-kind-icon">_quote<wbr>Asset</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_quoteassetprecision" class="tsd-kind-icon">_quote<wbr>Asset<wbr>Precision</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_src_models_misc_symbol_.symbol.html#_status" class="tsd-kind-icon">_status</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#baseasset" class="tsd-kind-icon">base<wbr>Asset</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#baseassetprecision" class="tsd-kind-icon">base<wbr>Asset<wbr>Precision</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#filters" class="tsd-kind-icon">filters</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#icebergallowed" class="tsd-kind-icon">iceberg<wbr>Allowed</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#ordertypes" class="tsd-kind-icon">order<wbr>Types</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#quoteasset" class="tsd-kind-icon">quote<wbr>Asset</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#quoteassetprecision" class="tsd-kind-icon">quote<wbr>Asset<wbr>Precision</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="_src_models_misc_symbol_.symbol.html#status" class="tsd-kind-icon">status</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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>