bittrex-api-client
Version:
A client which can be used to interact with Bittrex's API. Entirely developed in TypeScript.
810 lines • 64.7 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BittrexApiClient | bittrex-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">bittrex-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/_bittrexapiclient_.html">"BittrexApiClient"</a>
</li>
<li>
<a href="_bittrexapiclient_.bittrexapiclient.html">BittrexApiClient</a>
</li>
</ul>
<h1>Class BittrexApiClient</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 Bittrex API client.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BittrexApiClient</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="_bittrexapiclient_.bittrexapiclient.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_bittrexapiclient_.bittrexapiclient.html#apikey" class="tsd-kind-icon">api<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_bittrexapiclient_.bittrexapiclient.html#apisecret" class="tsd-kind-icon">api<wbr>Secret</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="_bittrexapiclient_.bittrexapiclient.html#buywithlimit" class="tsd-kind-icon">buy<wbr>With<wbr>Limit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#cancelorder" class="tsd-kind-icon">cancel<wbr>Order</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getbalance" class="tsd-kind-icon">get<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getbalances" class="tsd-kind-icon">get<wbr>Balances</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getcurrencies" class="tsd-kind-icon">get<wbr>Currencies</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getdepositaddress" class="tsd-kind-icon">get<wbr>Deposit<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getexchangestateupdatesstream" class="tsd-kind-icon">get<wbr>Exchange<wbr>State<wbr>Updates<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getmarkethistory" class="tsd-kind-icon">get<wbr>Market<wbr>History</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getmarketsummaries" class="tsd-kind-icon">get<wbr>Market<wbr>Summaries</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getmarketsummary" class="tsd-kind-icon">get<wbr>Market<wbr>Summary</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getmarkets" class="tsd-kind-icon">get<wbr>Markets</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getopenorders" class="tsd-kind-icon">get<wbr>Open<wbr>Orders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getorder" class="tsd-kind-icon">get<wbr>Order</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getorderbook" class="tsd-kind-icon">get<wbr>Order<wbr>Book</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#getticker" class="tsd-kind-icon">get<wbr>Ticker</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_bittrexapiclient_.bittrexapiclient.html#makerequest" class="tsd-kind-icon">make<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#sellwithlimit" class="tsd-kind-icon">sell<wbr>With<wbr>Limit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bittrexapiclient_.bittrexapiclient.html#withdraw" class="tsd-kind-icon">withdraw</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>Bittrex<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="_bittrexapiclient_.bittrexapiclient.html" class="tsd-signature-type">BittrexApiClient</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L34">BittrexApiClient.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes a new Bittrex 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="_bittrexapiclient_.bittrexapiclient.html" class="tsd-signature-type">BittrexApiClient</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="apikey" class="tsd-anchor"></a>
<h3><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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L29">BittrexApiClient.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The personal account's API key.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="apisecret" class="tsd-anchor"></a>
<h3><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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L34">BittrexApiClient.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The personal account's API secret.</p>
</div>
</div>
</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="buywithlimit" class="tsd-anchor"></a>
<h3>buy<wbr>With<wbr>Limit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">buy<wbr>With<wbr>Limit<span class="tsd-signature-symbol">(</span>market<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, quantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rate<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">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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L188">BittrexApiClient.ts:188</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/buylimit" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which we would like to buy.</p>
</div>
</li>
<li>
<h5>quantity: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The quantity that we would like to buy.</p>
</div>
</li>
<li>
<h5>rate: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The price at which we would like to buy.</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">string</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of the placed order's identifier, or the placed
order's identifier if using the await construct.</p>
</li>
</ul>
</section>
<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>orderId<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">boolean</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L226">BittrexApiClient.ts:226</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/cancelorder" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>orderId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The ID of the order we would like to cancel.</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">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>True if the operation resulted in a success, throws
otherwise.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getbalance" class="tsd-anchor"></a>
<h3>get<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Balance<span class="tsd-signature-symbol">(</span>currency<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="_model_balance_.balance.html" class="tsd-signature-type">Balance</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L285">BittrexApiClient.ts:285</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getbalance" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>currency: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The currency of which we would like to retrieve
the balance.</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="_model_balance_.balance.html" class="tsd-signature-type">Balance</a><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a balance, or a balance if using
the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getbalances" class="tsd-anchor"></a>
<h3>get<wbr>Balances</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Balances<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="_model_balance_.balance.html" class="tsd-signature-type">Balance</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L264">BittrexApiClient.ts:264</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getbalances" Bittrex'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><a href="_model_balance_.balance.html" class="tsd-signature-type">Balance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a balance array, or a balance
array if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcurrencies" class="tsd-anchor"></a>
<h3>get<wbr>Currencies</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Currencies<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="_model_currency_.currency.html" class="tsd-signature-type">Currency</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L70">BittrexApiClient.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getcurrencies" Bittrex'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><a href="_model_currency_.currency.html" class="tsd-signature-type">Currency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a currency array, or a currency array
if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdepositaddress" class="tsd-anchor"></a>
<h3>get<wbr>Deposit<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Deposit<wbr>Address<span class="tsd-signature-symbol">(</span>currency<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">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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L302">BittrexApiClient.ts:302</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getdepositaddress" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>currency: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The currency of which we would like to retrieve
the deposit address.</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">string</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a deposit address, or a deposit
address if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getexchangestateupdatesstream" class="tsd-anchor"></a>
<h3>get<wbr>Exchange<wbr>State<wbr>Updates<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Exchange<wbr>State<wbr>Updates<wbr>Stream<span class="tsd-signature-symbol">(</span>watchableMarkets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, callback<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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L360">BittrexApiClient.ts:360</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the Bittrex's API websockets system.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>watchableMarkets: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>The markets of which we would like
to receive constant updates.</p>
</div>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A callback function invoked as soon as new
updates about the watched markets are received
from Bittrex.</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>marketUpdates<span class="tsd-signature-symbol">: </span><a href="_model_exchangestateupdate_.exchangestateupdate.html" class="tsd-signature-type">ExchangeStateUpdate</a><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-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>marketUpdates: <a href="_model_exchangestateupdate_.exchangestateupdate.html" class="tsd-signature-type">ExchangeStateUpdate</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<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="getmarkethistory" class="tsd-anchor"></a>
<h3>get<wbr>Market<wbr>History</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Market<wbr>History<span class="tsd-signature-symbol">(</span>market<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="_model_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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L165">BittrexApiClient.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getmarkethistory" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market of which we would like
to retrieve the market history.</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="_model_trade_.trade.html" class="tsd-signature-type">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a trade array, or a trade array
if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmarketsummaries" class="tsd-anchor"></a>
<h3>get<wbr>Market<wbr>Summaries</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Market<wbr>Summaries<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="_model_marketsummary_.marketsummary.html" class="tsd-signature-type">MarketSummary</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L104">BittrexApiClient.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getmarketsummaries" Bittrex'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><a href="_model_marketsummary_.marketsummary.html" class="tsd-signature-type">MarketSummary</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a market summary array, or a market summary
array if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmarketsummary" class="tsd-anchor"></a>
<h3>get<wbr>Market<wbr>Summary</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Market<wbr>Summary<span class="tsd-signature-symbol">(</span>market<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="_model_marketsummary_.marketsummary.html" class="tsd-signature-type">MarketSummary</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L125">BittrexApiClient.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getmarketsummary" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market of which we would like
to retrieve the summary.</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="_model_marketsummary_.marketsummary.html" class="tsd-signature-type">MarketSummary</a><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a market summary, or a market summary
if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmarkets" class="tsd-anchor"></a>
<h3>get<wbr>Markets</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Markets<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="_model_market_.market.html" class="tsd-signature-type">Market</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L53">BittrexApiClient.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getmarkets" Bittrex'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><a href="_model_market_.market.html" class="tsd-signature-type">Market</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a market, or a market
if using the await construct.</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><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="_model_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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L244">BittrexApiClient.ts:244</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getopenorders" Bittrex'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 market of which we would like to retrieve
the open orders.</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="_model_order_.order.html" class="tsd-signature-type">Order</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of an open order array, or an open
order array if using the await construct.</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>uuid<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="_model_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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L342">BittrexApiClient.ts:342</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getorder" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uuid: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The uuid of the order of which we would like to get the detail.</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="_model_order_.order.html" class="tsd-signature-type">Order</a><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of an order, or an order if using
the await construct.</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>market<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderBookType.BUY</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OrderBookType.SELL</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OrderBookType.BOTH</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="_model_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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L147">BittrexApiClient.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getorderbook" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market of which we would like
to retrieve the order book.</p>
</div>
</li>
<li>
<h5>type: <span class="tsd-signature-type">OrderBookType.BUY</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OrderBookType.SELL</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OrderBookType.BOTH</span></h5>
<div class="tsd-comment tsd-typography">
<p>The type of the order book that we want to
retrieve, depending on if we want only the
buys, sells, or both.</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="_model_orderbook_.orderbook.html" class="tsd-signature-type">OrderBook</a><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of an order book, or an order book
if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getticker" class="tsd-anchor"></a>
<h3>get<wbr>Ticker</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Ticker<span class="tsd-signature-symbol">(</span>market<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="_model_ticker_.ticker.html" class="tsd-signature-type">Ticker</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L89">BittrexApiClient.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/getticker" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market of which we would like
to retrieve the ticker.</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="_model_ticker_.ticker.html" class="tsd-signature-type">Ticker</a><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of a ticker, or a ticker
if using the await construct.</p>
</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>operation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <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">string</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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L447">BittrexApiClient.ts:447</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Utility method that sends a request to the Bittrex's API, handling the
authentication through the API key and API secret possibly given when
instantiating the client itself.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>operation: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The Bittrex's API operation that we would like to call.</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">string</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 operation takes in.</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 Bittrex'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="sellwithlimit" class="tsd-anchor"></a>
<h3>sell<wbr>With<wbr>Limit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sell<wbr>With<wbr>Limit<span class="tsd-signature-symbol">(</span>market<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, quantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rate<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">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/bittrex-api-client/blob/46fe957/src/main/BittrexApiClient.ts#L208">BittrexApiClient.ts:208</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to the "public/selllimit" Bittrex's API operation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>market: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The market on which we would like to sell.</p>
</div>
</li>
<li>
<h5>quantity: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The quantity that we would like to sell.</p>
</div>
</li>
<li>
<h5>rate: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The price at which we would like to sell.</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">string</span><span class="tsd-signature-symbol">></span></h4>
<p>Either a promise of the placed order's identifier, or the placed
order's identifier if using the await construct.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withdraw" class="tsd-anchor"></a>
<h3>withdraw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">withdraw<span class="tsd-signature-symbol">(</span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, quantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentId<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