binance-api-client
Version:
A wrapper which can be used to interact with Binance's API. Entirely developed in TypeScript.
324 lines • 17.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>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>
</ul>
<h1> binance-api-client</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="binance-api-client">Binance API client</h1>
<p>This module is intended as an interface to the Binance API (documentation <a href="https://www.binance.com/restapipub.html">here</a>), which
lets you manage your account through simple REST requests.</p>
<h2 id="installation">Installation</h2>
<p>The installation step is really straight-forward. Just execute the following command:</p>
<p><code>npm install binance-api-client</code></p>
<h2 id="documentation">Documentation</h2>
<p>You can find the documentation to this project <a href="https://luzzif.github.io/binance-api-client/">here</a>.</p>
<h2 id="donations">Donations</h2>
<p>Please if you like my work consider donating something. Every offer helps me giving out the best software!</p>
<ul>
<li>Bitcoin: <code>3JFXQE6mQibmrxoq3YHKqRUHAvmXxuY8r9</code></li>
<li>Ethereum: <code>0x35E2acD3f46B13151BC941daa44785A38F3BD97A</code></li>
</ul>
<p>Thank you all <3</p>
</div>
</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="label tsd-is-external">
<span>Internals</span>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_binanceapiclient_.html">"src/<wbr>Binance<wbr>Api<wbr>Client"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_apiversion_.html">"src/enums/<wbr>Api<wbr>Version"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_authenticationmethod_.html">"src/enums/<wbr>Authentication<wbr>Method"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_candlestickinterval_.html">"src/enums/<wbr>Candlestick<wbr>Interval"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_filtertype_.html">"src/enums/<wbr>Filter<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_httpmethod_.html">"src/enums/<wbr>Http<wbr>Method"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_orderexecutionstatus_.html">"src/enums/<wbr>Order<wbr>Execution<wbr>Status"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_orderrejectionmotive_.html">"src/enums/<wbr>Order<wbr>Rejection<wbr>Motive"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_orderside_.html">"src/enums/<wbr>Order<wbr>Side"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_orderstatus_.html">"src/enums/<wbr>Order<wbr>Status"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_ordertype_.html">"src/enums/<wbr>Order<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_ratelimitinterval_.html">"src/enums/<wbr>Rate<wbr>Limit<wbr>Interval"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_ratelimittype_.html">"src/enums/<wbr>Rate<wbr>Limit<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_responsetype_.html">"src/enums/<wbr>Response<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_symbolstatus_.html">"src/enums/<wbr>Symbol<wbr>Status"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_symboltype_.html">"src/enums/<wbr>Symbol<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_enums_timeinforce_.html">"src/enums/<wbr>Time<wbr>InForce"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_errors_apierror_.html">"src/errors/<wbr>Api<wbr>Error"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_errors_authenticationerror_.html">"src/errors/<wbr>Authentication<wbr>Error"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_account_accountdata_.html">"src/models/account/<wbr>Account<wbr>Data"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_account_balance_.html">"src/models/account/<wbr>Balance"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_candlestick_candlestick_.html">"src/models/candlestick/<wbr>Candlestick"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_depth_latestprice_.html">"src/models/depth/<wbr>Latest<wbr>Price"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_depth_orderbook_.html">"src/models/depth/<wbr>Order<wbr>Book"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_lotsizefilter_.html">"src/models/filter/<wbr>Lot<wbr>Size<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_maxalgoordersfilter_.html">"src/models/filter/<wbr>Max<wbr>Algo<wbr>Orders<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_maxordersfilter_.html">"src/models/filter/<wbr>Max<wbr>Orders<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_minimumnotionalfilter_.html">"src/models/filter/<wbr>Minimum<wbr>Notional<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_pricefilter_.html">"src/models/filter/<wbr>Price<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_ratelimit_.html">"src/models/filter/<wbr>Rate<wbr>Limit"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_abstraction_exchangefilter_.html">"src/models/filter/abstraction/<wbr>Exchange<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_filter_abstraction_symbolfilter_.html">"src/models/filter/abstraction/<wbr>Symbol<wbr>Filter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_misc_exchangeinfo_.html">"src/models/misc/<wbr>Exchange<wbr>Info"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_misc_symbol_.html">"src/models/misc/<wbr>Symbol"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_canceledorderdata_.html">"src/models/order/<wbr>Canceled<wbr>Order<wbr>Data"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_order_.html">"src/models/order/<wbr>Order"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_orderacknowledgement_.html">"src/models/order/<wbr>Order<wbr>Acknowledgement"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_orderfull_.html">"src/models/order/<wbr>Order<wbr>Full"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_orderresult_.html">"src/models/order/<wbr>Order<wbr>Result"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_placedorder_.html">"src/models/order/<wbr>Placed<wbr>Order"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_order_placedorderfill_.html">"src/models/order/<wbr>Placed<wbr>Order<wbr>Fill"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_ticker_ticker_.html">"src/models/ticker/<wbr>Ticker"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_ticker_tickerstatistics_.html">"src/models/ticker/<wbr>Ticker<wbr>Statistics"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_trade_trade_.html">"src/models/trade/<wbr>Trade"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_websocket_account_accountupdate_.html">"src/models/websocket/account/<wbr>Account<wbr>Update"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_websocket_candlestick_candlestickupdate_.html">"src/models/websocket/candlestick/<wbr>Candlestick<wbr>Update"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_websocket_depth_orderbookupdate_.html">"src/models/websocket/depth/<wbr>Order<wbr>Book<wbr>Update"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_websocket_order_orderupdate_.html">"src/models/websocket/order/<wbr>Order<wbr>Update"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_models_websocket_trade_tradeupdate_.html">"src/models/websocket/trade/<wbr>Trade<wbr>Update"</a>
</li>
<li class="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="modules/_node_modules_websocket_heartbeats_index_.html">"node_<wbr>modules/websocket-<wbr>heartbeats/index"</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="modules/_node_modules_websocket_heartbeats_src_main_heartbeathandler_.html">"node_<wbr>modules/websocket-<wbr>heartbeats/src/main/<wbr>Heartbeat<wbr>Handler"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-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>