binance-api-client
Version:
A wrapper which can be used to interact with Binance's API. Entirely developed in TypeScript.
1,659 lines • 106 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BinanceApiClient | 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_binanceapiclient_.html">"src/BinanceApiClient"</a>
</li>
<li>
<a href="_src_binanceapiclient_.binanceapiclient.html">BinanceApiClient</a>
</li>
</ul>
<h1>Class BinanceApiClient</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 Binance API client.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BinanceApiClient</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_binanceapiclient_.binanceapiclient.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 tsd-is-static"><a href="_src_binanceapiclient_.binanceapiclient.html#api_key" class="tsd-kind-icon">API_<wbr>KEY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_src_binanceapiclient_.binanceapiclient.html#api_secret" class="tsd-kind-icon">API_<wbr>SECRET</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_src_binanceapiclient_.binanceapiclient.html#default_ws_timeout" class="tsd-kind-icon">DEFAULT_<wbr>WS_<wbr>TIMEOUT</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_src_binanceapiclient_.binanceapiclient.html#ws_base_url" class="tsd-kind-icon">WS_<wbr>BASE_<wbr>URL</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#cancelorder" class="tsd-kind-icon">cancel<wbr>Order</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#closeuserstream" class="tsd-kind-icon">close<wbr>User<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getaccountdata" class="tsd-kind-icon">get<wbr>Account<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getcandlesticks" class="tsd-kind-icon">get<wbr>Candlesticks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getexchangeinfo" class="tsd-kind-icon">get<wbr>Exchange<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getlastdaytickerstatistics" class="tsd-kind-icon">get<wbr>Last<wbr>Day<wbr>Ticker<wbr>Statistics</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getlatestprices" class="tsd-kind-icon">get<wbr>Latest<wbr>Prices</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getopenorders" class="tsd-kind-icon">get<wbr>Open<wbr>Orders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getorder" class="tsd-kind-icon">get<wbr>Order</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getorderbook" class="tsd-kind-icon">get<wbr>Order<wbr>Book</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getorders" class="tsd-kind-icon">get<wbr>Orders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#getservertime" class="tsd-kind-icon">get<wbr>Server<wbr>Time</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#gettickers" class="tsd-kind-icon">get<wbr>Tickers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#gettrades" class="tsd-kind-icon">get<wbr>Trades</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#keepaliveuserstream" class="tsd-kind-icon">keep<wbr>Alive<wbr>User<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_src_binanceapiclient_.binanceapiclient.html#makerequest" class="tsd-kind-icon">make<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#monitorcandlesticks" class="tsd-kind-icon">monitor<wbr>Candlesticks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#monitororderbook" class="tsd-kind-icon">monitor<wbr>Order<wbr>Book</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#monitortrades" class="tsd-kind-icon">monitor<wbr>Trades</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#monitoruser" class="tsd-kind-icon">monitor<wbr>User</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#openuserstream" class="tsd-kind-icon">open<wbr>User<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#ping" class="tsd-kind-icon">ping</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#placeorder" class="tsd-kind-icon">place<wbr>Order</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_src_binanceapiclient_.binanceapiclient.html#setupauthentication" class="tsd-kind-icon">setup<wbr>Authentication</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_binanceapiclient_.binanceapiclient.html#testorder" class="tsd-kind-icon">test<wbr>Order</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>Binance<wbr>Api<wbr>Client<span class="tsd-signature-symbol">(</span>apiKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, apiSecret<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><a href="_src_binanceapiclient_.binanceapiclient.html" class="tsd-signature-type">BinanceApiClient</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/BinanceApiClient.ts#L46">src/BinanceApiClient.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes a new Binance API client.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> apiKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The personal account API key.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> apiSecret: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The personal account API secret.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_src_binanceapiclient_.binanceapiclient.html" class="tsd-signature-type">BinanceApiClient</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 tsd-is-static">
<a name="api_key" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> API_<wbr>KEY</h3>
<div class="tsd-signature tsd-kind-icon">API_<wbr>KEY<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/BinanceApiClient.ts#L45">src/BinanceApiClient.ts:45</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="api_secret" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> API_<wbr>SECRET</h3>
<div class="tsd-signature tsd-kind-icon">API_<wbr>SECRET<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/BinanceApiClient.ts#L46">src/BinanceApiClient.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="default_ws_timeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> DEFAULT_<wbr>WS_<wbr>TIMEOUT</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>WS_<wbr>TIMEOUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 60000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L43">src/BinanceApiClient.ts:43</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="ws_base_url" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> WS_<wbr>BASE_<wbr>URL</h3>
<div class="tsd-signature tsd-kind-icon">WS_<wbr>BASE_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "wss://stream.binance.com:9443/ws/"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L42">src/BinanceApiClient.ts:42</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="cancelorder" class="tsd-anchor"></a>
<h3>cancel<wbr>Order</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">cancel<wbr>Order<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, oldClientId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, newClientId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_canceledorderdata_.canceledorderdata.html" class="tsd-signature-type">CanceledOrderData</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L391">src/BinanceApiClient.ts:391</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "DELETE v3/order" Binance's API operation.
Cancels a previously placed order.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which the order was originally placed.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> id: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The wanted order ID.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> oldClientId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The pre-cancel client given order ID (its description).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> newClientId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The post-cancel order ID (automatically generated if not passed).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame
(defaults to 5000 ms).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_canceledorderdata_.canceledorderdata.html" class="tsd-signature-type">CanceledOrderData</a><span class="tsd-signature-symbol">></span></h4>
<p>The just-canceled order data.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="closeuserstream" class="tsd-anchor"></a>
<h3>close<wbr>User<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">close<wbr>User<wbr>Stream<span class="tsd-signature-symbol">(</span>streamId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L578">src/BinanceApiClient.ts:578</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "DELETE v1/userDataStream" Binance's API operation.
Closes out a user data stream.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>streamId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string representing the stream's ID
(returned by <a href="_src_binanceapiclient_.binanceapiclient.html#openuserstream">openUserStream</a>).</p>
</div>
</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">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getaccountdata" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Data<span class="tsd-signature-symbol">(</span>timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_account_accountdata_.accountdata.html" class="tsd-signature-type">AccountData</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L485">src/BinanceApiClient.ts:485</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v3/account" Binance's API operation. Get current
account information.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame (defaults to 5000 ms).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_account_accountdata_.accountdata.html" class="tsd-signature-type">AccountData</a><span class="tsd-signature-symbol">></span></h4>
<p>The current account information.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcandlesticks" class="tsd-anchor"></a>
<h3>get<wbr>Candlesticks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Candlesticks<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, interval<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_candlestickinterval_.candlestickinterval.html" class="tsd-signature-type">CandlestickInterval</a>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, startTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, endTime<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_candlestick_candlestick_.candlestick.html" class="tsd-signature-type">Candlestick</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L136">src/BinanceApiClient.ts:136</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/klines" Binance's API operation. Get
candlestick bars for the specified symbol, respecting
all the other given constraints. Candlesticks are uniquely
identified by their opening time.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol for which we want to retrieve the
candlesticks.</p>
</div>
</li>
<li>
<h5>interval: <a href="../enums/_src_enums_candlestickinterval_.candlestickinterval.html" class="tsd-signature-type">CandlestickInterval</a></h5>
<div class="tsd-comment tsd-typography">
<p>The interval which the requested candlesticks refer to.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The maximum number of candlesticks returned.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> startTime: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The time from which the candlesticks are returned.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> endTime: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The time until which the candlesticks are returned.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_candlestick_candlestick_.candlestick.html" class="tsd-signature-type">Candlestick</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>A candlesticks array respecting the given constraints.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getexchangeinfo" class="tsd-anchor"></a>
<h3>get<wbr>Exchange<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Exchange<wbr>Info<span class="tsd-signature-symbol">(</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="_src_models_misc_exchangeinfo_.exchangeinfo.html" class="tsd-signature-type">ExchangeInfo</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L73">src/BinanceApiClient.ts:73</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_misc_exchangeinfo_.exchangeinfo.html" class="tsd-signature-type">ExchangeInfo</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getlastdaytickerstatistics" class="tsd-anchor"></a>
<h3>get<wbr>Last<wbr>Day<wbr>Ticker<wbr>Statistics</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Last<wbr>Day<wbr>Ticker<wbr>Statistics<span class="tsd-signature-symbol">(</span>symbol<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_ticker_tickerstatistics_.tickerstatistics.html" class="tsd-signature-type">TickerStatistics</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L172">src/BinanceApiClient.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/ticker/24hr" Binance's API operation.
Get last 24 hours price change statistics.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol for which we want to retrieve the
last day ticker statistics.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_ticker_tickerstatistics_.tickerstatistics.html" class="tsd-signature-type">TickerStatistics</a><span class="tsd-signature-symbol">></span></h4>
<p>The last 24-hour ticker statistics.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getlatestprices" class="tsd-anchor"></a>
<h3>get<wbr>Latest<wbr>Prices</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Latest<wbr>Prices<span class="tsd-signature-symbol">(</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="_src_models_depth_latestprice_.latestprice.html" class="tsd-signature-type">LatestPrice</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L190">src/BinanceApiClient.ts:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/ticker/allPrices" Binance's API operation.
Get the latest price for all symbols.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_depth_latestprice_.latestprice.html" class="tsd-signature-type">LatestPrice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>A latest prices array for all the symbols.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getopenorders" class="tsd-anchor"></a>
<h3>get<wbr>Open<wbr>Orders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Open<wbr>Orders<span class="tsd-signature-symbol">(</span>market<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_order_.order.html" class="tsd-signature-type">Order</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L420">src/BinanceApiClient.ts:420</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v3/openOrders" Binance's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol for which we want to retrieve the open orders (if any).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame (defaults to 5000 ms).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_order_.order.html" class="tsd-signature-type">Order</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>An array representing all of the account's open orders.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getorder" class="tsd-anchor"></a>
<h3>get<wbr>Order</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Order<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, clientId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_order_.order.html" class="tsd-signature-type">Order</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L359">src/BinanceApiClient.ts:359</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v3/order" Binance's API operation. Gets a
placed order detail given some constraints.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which the order was originally placed.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> id: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The wanted order ID.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> clientId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The wanted client given order ID (its description).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame
(defaults to 5000 ms).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_order_.order.html" class="tsd-signature-type">Order</a><span class="tsd-signature-symbol">></span></h4>
<p>The placed order detail respecting the given constraints.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getorderbook" class="tsd-anchor"></a>
<h3>get<wbr>Order<wbr>Book</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Order<wbr>Book<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_depth_orderbook_.orderbook.html" class="tsd-signature-type">OrderBook</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L108">src/BinanceApiClient.ts:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/depth" Binance's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol for which we want to retrieve the order book.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The maximum number of orders in the returned order book.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_depth_orderbook_.orderbook.html" class="tsd-signature-type">OrderBook</a><span class="tsd-signature-symbol">></span></h4>
<p>The order book respecting the given constraints.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getorders" class="tsd-anchor"></a>
<h3>get<wbr>Orders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Orders<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_order_.order.html" class="tsd-signature-type">Order</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L452">src/BinanceApiClient.ts:452</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v3/allOrders" Binance's API operation. Get all account
orders (active, canceled, or filled).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol for which we want to retrieve the orders.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> id: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The order ID from which we want to retrieve the orders
(if set, the API will retrieve the orders with an ID greater
or equal to the one specified, otherwise the most recent orders).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The maximum number of returned orders.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame (defaults to 5000 ms).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_order_.order.html" class="tsd-signature-type">Order</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>An array representing all of the account's orders in every state.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getservertime" class="tsd-anchor"></a>
<h3>get<wbr>Server<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Server<wbr>Time<span class="tsd-signature-symbol">(</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">Date</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L89">src/BinanceApiClient.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/time" Binance's API operation.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">></span></h4>
<p>The Binance's server time.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettickers" class="tsd-anchor"></a>
<h3>get<wbr>Tickers</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Tickers<span class="tsd-signature-symbol">(</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="_src_models_ticker_ticker_.ticker.html" class="tsd-signature-type">Ticker</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L213">src/BinanceApiClient.ts:213</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/ticker/allBookTickers" Binance's API operation.
Get the best price/quantity in the order book for all symbols.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_ticker_ticker_.ticker.html" class="tsd-signature-type">Ticker</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>The best price/quantity in the order book for all symbols.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettrades" class="tsd-anchor"></a>
<h3>get<wbr>Trades</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trades<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, fromId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_trade_trade_.trade.html" class="tsd-signature-type">Trade</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L509">src/BinanceApiClient.ts:509</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v3/myTrades" Binance's API operation. Get trades for
a specific account and symbol.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which the trades were originally executed.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The maximum number of returned trades.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fromId: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The trade's ID to start fetching from. If not given, the
API will retrieve the most recent trades first.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame (defaults to 5000 ms).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_trade_trade_.trade.html" class="tsd-signature-type">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>The account's trade list respecting the given constraints.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="keepaliveuserstream" class="tsd-anchor"></a>
<h3>keep<wbr>Alive<wbr>User<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">keep<wbr>Alive<wbr>User<wbr>Stream<span class="tsd-signature-symbol">(</span>streamId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L559">src/BinanceApiClient.ts:559</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "PUT v1/userDataStream" Binance's API operation.
Pings a user data stream in order to prevent a time out.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>streamId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string representing the stream's ID
(returned by <a href="_src_binanceapiclient_.binanceapiclient.html#openuserstream">openUserStream</a>).</p>
</div>
</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">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="makerequest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">make<wbr>Request<span class="tsd-signature-symbol">(</span>httpMethod<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_httpmethod_.httpmethod.html" class="tsd-signature-type">HttpMethod</a>, apiVersion<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_apiversion_.apiversion.html" class="tsd-signature-type">ApiVersion</a>, accessedResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requiredAuthentication<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_authenticationmethod_.authenticationmethod.html" class="tsd-signature-type">AuthenticationMethod</a>, <span class="tsd-signature-symbol">...</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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><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">any</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L768">src/BinanceApiClient.ts:768</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Utility method that sets up and sends a request to the Binance's API, handling
the authentication through the API key and API secret parameters possibly given
when instantiating the client itself.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>httpMethod: <a href="../enums/_src_enums_httpmethod_.httpmethod.html" class="tsd-signature-type">HttpMethod</a></h5>
<div class="tsd-comment tsd-typography">
<p>The HTTP method through which the specified API is accessed.</p>
</div>
</li>
<li>
<h5>apiVersion: <a href="../enums/_src_enums_apiversion_.apiversion.html" class="tsd-signature-type">ApiVersion</a></h5>
<div class="tsd-comment tsd-typography">
<p>The API version at which the wanted resource can be accessed.</p>
</div>
</li>
<li>
<h5>accessedResource: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The Binance's API resource that we would like to access.</p>
</div>
</li>
<li>
<h5>requiredAuthentication: <a href="../enums/_src_enums_authenticationmethod_.authenticationmethod.html" class="tsd-signature-type">AuthenticationMethod</a></h5>
<div class="tsd-comment tsd-typography">
<p>The authentication type required in order to access the
specified resource.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>parameters: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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></h5>
<div class="tsd-comment tsd-typography">
<p>The parameters which the accessed resource may use in order to
give us the expected result.</p>
</div>
</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">any</span><span class="tsd-signature-symbol">></span></h4>
<p>Either the promise of the Binance's API JSON response, or the
JSON response if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="monitorcandlesticks" class="tsd-anchor"></a>
<h3>monitor<wbr>Candlesticks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">monitor<wbr>Candlesticks<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, interval<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_candlestickinterval_.candlestickinterval.html" class="tsd-signature-type">CandlestickInterval</a>, onUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, connectionTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, onLostConnection<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">function</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">void</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L641">src/BinanceApiClient.ts:641</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes a web socket data stream that gives us information about
Kline/candlestick updates. Stream keepalive is performed through
<a href="_src_binanceapiclient_.binanceapiclient.html#keepaliveuserstream">keepAliveUserStream</a> following the rules described
<a href="https://github.com/binance-exchange/binance-official-api-docs/blob/master/web-socket-streams.md">here</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol of which we want to get the candlestick updates.</p>
</div>
</li>
<li>
<h5>interval: <a href="../enums/_src_enums_candlestickinterval_.candlestickinterval.html" class="tsd-signature-type">CandlestickInterval</a></h5>
<div class="tsd-comment tsd-typography">
<p>The interval to which the requested candlestick updates
refer to.</p>
</div>
</li>
<li>
<h5>onUpdate: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A function to be called when a new update is received.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">: </span><a href="_src_models_websocket_candlestick_candlestickupdate_.candlestickupdate.html" class="tsd-signature-type">CandlestickUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>update: <a href="_src_models_websocket_candlestick_candlestickupdate_.candlestickupdate.html" class="tsd-signature-type">CandlestickUpdate</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionTimeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Timeout based on which the web socket connection is
considered to be broken based on a heartbeat monitor.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> onLostConnection: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A callback to be invoked when the web socket connection
is detected as broken.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</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">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="monitororderbook" class="tsd-anchor"></a>
<h3>monitor<wbr>Order<wbr>Book</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">monitor<wbr>Order<wbr>Book<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, onUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, connectionTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, onLostConnection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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/BinanceApiClient.ts#L603">src/BinanceApiClient.ts:603</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes a web socket data stream that gives us information about a
single symbol's order book updates. Stream keepalive is performed through
<a href="_src_binanceapiclient_.binanceapiclient.html#keepaliveuserstream">keepAliveUserStream</a> following the rules described
<a href="https://github.com/binance-exchange/binance-official-api-docs/blob/master/web-socket-streams.md">here</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol of which we want to get the order book updates.</p>
</div>
</li>
<li>
<h5>onUpdate: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A function to be called when a new update is received.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">: </span><a href="_src_models_websocket_depth_orderbookupdate_.orderbookupdate.html" class="tsd-signature-type">OrderBookUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>update: <a href="_src_models_websocket_depth_orderbookupdate_.orderbookupdate.html" class="tsd-signature-type">OrderBookUpdate</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5>connectionTimeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Timeout based on which the web socket connection is
considered to be broken based on a heartbeat monitor.</p>
</div>
</li>
<li>
<h5>onLostConnection: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A callback to be invoked when the web socket connection
is detected as broken.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</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-method tsd-parent-kind-class">
<a name="monitortrades" class="tsd-anchor"></a>
<h3>monitor<wbr>Trades</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">monitor<wbr>Trades<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, onUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, connectionTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, onLostConnection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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/BinanceApiClient.ts#L678">src/BinanceApiClient.ts:678</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes a web socket data stream that gives us information about
trade updates. Stream keepalive is performed through
<a href="_src_binanceapiclient_.binanceapiclient.html#keepaliveuserstream">keepAliveUserStream</a> following the rules described
<a href="https://github.com/binance-exchange/binance-official-api-docs/blob/master/web-socket-streams.md">here</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The symbol of which we want to get the trade updates.</p>
</div>
</li>
<li>
<h5>onUpdate: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A function to be called when a new update is received.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">: </span><a href="_src_models_websocket_trade_tradeupdate_.tradeupdate.html" class="tsd-signature-type">TradeUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>update: <a href="_src_models_websocket_trade_tradeupdate_.tradeupdate.html" class="tsd-signature-type">TradeUpdate</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5>connectionTimeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Timeout based on which the web socket connection is
considered to be broken based on a heartbeat monitor.</p>
</div>
</li>
<li>
<h5>onLostConnection: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A callback to be invoked when the web socket connection
is detected as broken.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</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-method tsd-parent-kind-class">
<a name="monitoruser" class="tsd-anchor"></a>
<h3>monitor<wbr>User</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">monitor<wbr>User<span class="tsd-signature-symbol">(</span>listenKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, onUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, connectionTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, onLostConnection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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/BinanceApiClient.ts#L715">src/BinanceApiClient.ts:715</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes a web socket data stream that gives us information about
the personal account updates. Stream keepalive is performed through
<a href="_src_binanceapiclient_.binanceapiclient.html#keepaliveuserstream">keepAliveUserStream</a> following the rules described
<a href="https://github.com/binance-exchange/binance-official-api-docs/blob/master/user-data-stream.md">here</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>listenKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The listen key returned when a user data stream gets
initialized by <a href="_src_binanceapiclient_.binanceapiclient.html#openuserstream">openUserStream</a>.</p>
</div>
</li>
<li>
<h5>onUpdate: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A function to be called when a new update is received.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">: </span><a href="_src_models_websocket_account_accountupdate_.accountupdate.html" class="tsd-signature-type">AccountUpdate</a><span class="tsd-signature-symbol"> | </span><a href="_src_models_websocket_order_orderupdate_.orderupdate.html" class="tsd-signature-type">OrderUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>update: <a href="_src_models_websocket_account_accountupdate_.accountupdate.html" class="tsd-signature-type">AccountUpdate</a><span class="tsd-signature-symbol"> | </span><a href="_src_models_websocket_order_orderupdate_.orderupdate.html" class="tsd-signature-type">OrderUpdate</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5>connectionTimeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Timeout based on which the web socket connection is
considered to be broken based on a heartbeat monitor.</p>
</div>
</li>
<li>
<h5>onLostConnection: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A callback to be invoked when the web socket connection
is detected as broken.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</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-method tsd-parent-kind-class">
<a name="openuserstream" class="tsd-anchor"></a>
<h3>open<wbr>User<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">open<wbr>User<wbr>Stream<span class="tsd-signature-symbol">(</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">string</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L541">src/BinanceApiClient.ts:541</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "POST v1/userDataStream" Binance's API operation.
Initializes a new data stream.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
<p>A listen key to be passed as a parameter when starting a
new data stream.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="ping" class="tsd-anchor"></a>
<h3>ping</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">ping<span class="tsd-signature-symbol">(</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">void</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L62">src/BinanceApiClient.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "GET v1/ping" Binance's API operation.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="placeorder" class="tsd-anchor"></a>
<h3>place<wbr>Order</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">place<wbr>Order<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, side<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_orderside_.orderside.html" class="tsd-signature-type">OrderSide</a>, type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a>, timeInForce<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_timeinforce_.timeinforce.html" class="tsd-signature-type">TimeInForce</a>, quantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, clientOrderId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, stopPrice<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, icebergQuantity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, responseType<span class="tsd-signature-symbol">?: </span><a href="../enums/_src_enums_responsetype_.responsetype.html" class="tsd-signature-type">ResponseType</a><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="_src_models_order_orderacknowledgement_.orderacknowledgement.html" class="tsd-signature-type">OrderAcknowledgement</a><span class="tsd-signature-symbol"> | </span><a href="_src_models_order_orderresult_.orderresult.html" class="tsd-signature-type">OrderResult</a><span class="tsd-signature-symbol"> | </span><a href="_src_models_order_orderfull_.orderfull.html" class="tsd-signature-type">OrderFull</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L248">src/BinanceApiClient.ts:248</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "POST v3/order" Binance's API operation. Places a new order
respecting the given constraints.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which the order is to be placed.</p>
</div>
</li>
<li>
<h5>side: <a href="../enums/_src_enums_orderside_.orderside.html" class="tsd-signature-type">OrderSide</a></h5>
<div class="tsd-comment tsd-typography">
<p>Whether the order is a buy or sell.</p>
</div>
</li>
<li>
<h5>type: <a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a></h5>
<div class="tsd-comment tsd-typography">
<p>Whether the order is at limit or market.</p>
</div>
</li>
<li>
<h5>timeInForce: <a href="../enums/_src_enums_timeinforce_.timeinforce.html" class="tsd-signature-type">TimeInForce</a></h5>
<div class="tsd-comment tsd-typography">
<p>Whether the time in force should be GTC or IOC.</p>
</div>
</li>
<li>
<h5>quantity: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The quantity of assets that is to be moved.</p>
</div>
</li>
<li>
<h5>price: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The price at which the order should be filled.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> clientOrderId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A unique ID associated with the order
(automatically generated if not sent).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> stopPrice: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The price at which a stop order should be filled.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> icebergQuantity: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Only used with iceberg orders.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> responseType: <a href="../enums/_src_enums_responsetype_.responsetype.html" class="tsd-signature-type">ResponseType</a></h5>
<div class="tsd-comment tsd-typography">
<p>Set the response JSON. ACK, RESULT, or FULL; default: RESULT.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_src_models_order_orderacknowledgement_.orderacknowledgement.html" class="tsd-signature-type">OrderAcknowledgement</a><span class="tsd-signature-symbol"> | </span><a href="_src_models_order_orderresult_.orderresult.html" class="tsd-signature-type">OrderResult</a><span class="tsd-signature-symbol"> | </span><a href="_src_models_order_orderfull_.orderfull.html" class="tsd-signature-type">OrderFull</a><span class="tsd-signature-symbol">></span></h4>
<p>The just-placed order data.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="setupauthentication" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> setup<wbr>Authentication</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">setup<wbr>Authentication<span class="tsd-signature-symbol">(</span>httpMethod<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_httpmethod_.httpmethod.html" class="tsd-signature-type">HttpMethod</a>, apiUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URL</span>, authenticationMethod<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_authenticationmethod_.authenticationmethod.html" class="tsd-signature-type">AuthenticationMethod</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/BinanceApiClient.ts#L825">src/BinanceApiClient.ts:825</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Utility method setting up the request in order to handle Binance's various
authentication methods.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>httpMethod: <a href="../enums/_src_enums_httpmethod_.httpmethod.html" class="tsd-signature-type">HttpMethod</a></h5>
<div class="tsd-comment tsd-typography">
<p>The HTTP method used to access the wanted resource
(mainly used for error logging purposes).</p>
</div>
</li>
<li>
<h5>apiUrl: <span class="tsd-signature-type">URL</span></h5>
<div class="tsd-comment tsd-typography">
<p>The URL at which the wanted resource can be accessed.</p>
</div>
</li>
<li>
<h5>authenticationMethod: <a href="../enums/_src_enums_authenticationmethod_.authenticationmethod.html" class="tsd-signature-type">AuthenticationMethod</a></h5>
<div class="tsd-comment tsd-typography">
<p>The authentication method through which the wanted
resource can be accessed through the specified URL.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="testorder" class="tsd-anchor"></a>
<h3>test<wbr>Order</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">test<wbr>Order<span class="tsd-signature-symbol">(</span>symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, side<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_orderside_.orderside.html" class="tsd-signature-type">OrderSide</a>, type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a>, timeInForce<span class="tsd-signature-symbol">: </span><a href="../enums/_src_enums_timeinforce_.timeinforce.html" class="tsd-signature-type">TimeInForce</a>, quantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, clientId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, stopPrice<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, icebergQuantity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, timeout<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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/luzzif/binance-api-client/blob/1e8c252/src/BinanceApiClient.ts#L316">src/BinanceApiClient.ts:316</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "POST v3/order/test" Binance's API operation. Places a new
test order respecting the given constraints.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbol: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which the order is to be placed.</p>
</div>
</li>
<li>
<h5>side: <a href="../enums/_src_enums_orderside_.orderside.html" class="tsd-signature-type">OrderSide</a></h5>
<div class="tsd-comment tsd-typography">
<p>Whether the order is a buy or sell.</p>
</div>
</li>
<li>
<h5>type: <a href="../enums/_src_enums_ordertype_.ordertype.html" class="tsd-signature-type">OrderType</a></h5>
<div class="tsd-comment tsd-typography">
<p>Whether the order is at limit or market.</p>
</div>
</li>
<li>
<h5>timeInForce: <a href="../enums/_src_enums_timeinforce_.timeinforce.html" class="tsd-signature-type">TimeInForce</a></h5>
<div class="tsd-comment tsd-typography">
<p>Whether the time in force should be GTC or IOC.</p>
</div>
</li>
<li>
<h5>quantity: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The quantity of assets that is to be moved.</p>
</div>
</li>
<li>
<h5>price: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The price at which the order should be filled.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> clientId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A unique ID associated with the order.
(automatically generated if not sent).</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> stopPrice: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The price at which a stop order should be filled.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> icebergQuantity: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Only used with iceberg orders.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request validity maximum time frame
(defaults to 5000 ms).</p>
</div>
</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">void</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_src_binanceapiclient_.html">"src/<wbr>Binance<wbr>Api<wbr>Client"</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_binanceapiclient_.binanceapiclient.html" class="tsd-kind-icon">Binance<wbr>Api<wbr>Client</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="_src_binanceapiclient_.binanceapiclient.html#api_key" class="tsd-kind-icon">API_<wbr>KEY</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="_src_binanceapiclient_.binanceapiclient.html#api_secret" class="tsd-kind-icon">API_<wbr>SECRET</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="_src_binanceapiclient_.binanceapiclient.html#default_ws_timeout" class="tsd-kind-icon">DEFAULT_<wbr>WS_<wbr>TIMEOUT</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="_src_binanceapiclient_.binanceapiclient.html#ws_base_url" class="tsd-kind-icon">WS_<wbr>BASE_<wbr>URL</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#cancelorder" class="tsd-kind-icon">cancel<wbr>Order</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#closeuserstream" class="tsd-kind-icon">close<wbr>User<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getaccountdata" class="tsd-kind-icon">get<wbr>Account<wbr>Data</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getcandlesticks" class="tsd-kind-icon">get<wbr>Candlesticks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getexchangeinfo" class="tsd-kind-icon">get<wbr>Exchange<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getlastdaytickerstatistics" class="tsd-kind-icon">get<wbr>Last<wbr>Day<wbr>Ticker<wbr>Statistics</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getlatestprices" class="tsd-kind-icon">get<wbr>Latest<wbr>Prices</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getopenorders" class="tsd-kind-icon">get<wbr>Open<wbr>Orders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getorder" class="tsd-kind-icon">get<wbr>Order</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getorderbook" class="tsd-kind-icon">get<wbr>Order<wbr>Book</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getorders" class="tsd-kind-icon">get<wbr>Orders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#getservertime" class="tsd-kind-icon">get<wbr>Server<wbr>Time</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#gettickers" class="tsd-kind-icon">get<wbr>Tickers</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#gettrades" class="tsd-kind-icon">get<wbr>Trades</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#keepaliveuserstream" class="tsd-kind-icon">keep<wbr>Alive<wbr>User<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_src_binanceapiclient_.binanceapiclient.html#makerequest" class="tsd-kind-icon">make<wbr>Request</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#monitorcandlesticks" class="tsd-kind-icon">monitor<wbr>Candlesticks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#monitororderbook" class="tsd-kind-icon">monitor<wbr>Order<wbr>Book</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#monitortrades" class="tsd-kind-icon">monitor<wbr>Trades</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#monitoruser" class="tsd-kind-icon">monitor<wbr>User</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#openuserstream" class="tsd-kind-icon">open<wbr>User<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#ping" class="tsd-kind-icon">ping</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#placeorder" class="tsd-kind-icon">place<wbr>Order</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_src_binanceapiclient_.binanceapiclient.html#setupauthentication" class="tsd-kind-icon">setup<wbr>Authentication</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_src_binanceapiclient_.binanceapiclient.html#testorder" class="tsd-kind-icon">test<wbr>Order</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>