{"id":16537346,"url":"https://github.com/harry-sm/bittrexrx","last_synced_at":"2026-02-25T16:32:40.746Z","repository":{"id":51805809,"uuid":"109439461","full_name":"harry-sm/BittrexRx","owner":"harry-sm","description":"BittrexRx is a rxjs node wrapper for the Bittrex Api","archived":false,"fork":false,"pushed_at":"2024-09-12T19:28:31.000Z","size":334,"stargazers_count":16,"open_issues_count":11,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-12T18:35:28.123Z","etag":null,"topics":["bitcoin","bittrex","client","cryptocurrency","exchange","nodejs","observable","rxjs","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harry-sm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-03T20:23:14.000Z","updated_at":"2020-09-04T15:18:30.000Z","dependencies_parsed_at":"2023-11-07T13:32:23.236Z","dependency_job_id":"a5e86c31-0f42-4f91-bf75-6e5c03c7f330","html_url":"https://github.com/harry-sm/BittrexRx","commit_stats":{"total_commits":83,"total_committers":5,"mean_commits":16.6,"dds":0.2650602409638554,"last_synced_commit":"5ae7dd484d4f76753c40c9d214d268b2814649cc"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harry-sm%2FBittrexRx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harry-sm%2FBittrexRx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harry-sm%2FBittrexRx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harry-sm%2FBittrexRx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harry-sm","download_url":"https://codeload.github.com/harry-sm/BittrexRx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221667354,"owners_count":16860605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","bittrex","client","cryptocurrency","exchange","nodejs","observable","rxjs","typescript"],"created_at":"2024-10-11T18:35:31.309Z","updated_at":"2026-02-25T16:32:40.690Z","avatar_url":"https://github.com/harry-sm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BittrexRx\n\nBittrexRx is an Reactive library that was built with TypeScript for the [Bittrex](https://bittrex.com/) API which runs on the node.js platform. I built this library because I couldn't find any other library that uses [rxjs](https://github.com/Reactive-Extensions/RxJS).\n\n---\n[![npm version](https://badge.fury.io/js/bittrex-rx.svg)](https://badge.fury.io/js/bittrex-rx)\n[![npm downloads](https://img.shields.io/npm/dt/bittrex-rx.svg)](https://www.npmjs.com/package/bittrex-rx)\n[![Build Status](https://api.travis-ci.org/harry-sm/BittrexRx.svg?branch=master)](https://travis-ci.org/harry-sm/BittrexRx)\n[![Renovate badge](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)\n[![David](https://img.shields.io/david/harry-sm/BittrexRx.svg)](https://david-dm.org/harry-sm/bittrexRx)\n\n---\n\n\n\n## My Other API Clients\n\n- [CobinhoodRx](https://github.com/harry-sm/CobinhoodRx) (Typescript)  - API client for the [Cobinhood](https://cobinhood.com/) Exchange.\n- [BittrexRxSharp]( https://github.com/harry-sm/BittrexRxSharp) (C#)\n\n\n\n\n## Basic Usage\n\n`npm install bittrex-rx --save`\n\nInclude in your project\n\n```js\nimport {\n    BittrexRxClient,\n    OrderConditionalTypeValue,\n    TickIntervalValue,\n    TimeInEffectValue,\n    MarketOrderValue,\n    OrderTypeValue,\n    FillTypeValue,\n    Model,\n    LogTypeValue\n} from \"bittrex-rx\";\n```\n\n\u003e **Note**: To gain access to rxjs operators such as `map()`, `flatMap()`, `filter()`, you will need to include [rxjs](https://github.com/ReactiveX/RxJS) in your project.\n\nInstall\n\n`npm install rxjs`\n\nInclude in your project\n\n```js\nimport \"rxjs\";\n```\n\n\n\n## Advance Usage\n\nFetch the project via git:\n```\ngit clone https://github.com/harry-sm/BittrexRx.git\n```\nInstall package dependencies:\n```\nnpm install\n```\nBuild Project\n```\nnpm run build\n```\nInclude in your project\n```js\nimport {\n    BittrexRxClient,\n    OrderConditionalTypeValue,\n    TickIntervalValue,\n    TimeInEffectValue,\n    MarketOrderValue,\n    OrderTypeValue,\n    FillTypeValue,\n    Model,\n    LogTypeValue\n} from '\u003cpath to project\u003e';\n```\n\n\n## BittrexRx Settings\n\n### settings(settings: BittrexRxSettings)\n\nSets settings for BittrexRx methods behaviors.\n\n#### Parameters\n\n| Parameter | Type              | Example                                  | Description                              |\n| --------- | ----------------- | ---------------------------------------- | ---------------------------------------- |\n| settings  | BittrexRxSettings | {\u003cbr /\u003e baseUrl:  'https://bittrex.com/api/',\u003cbr /\u003e logType:  LogTypeValue.Debug,\u003cbr /\u003e logWriter: console.log\u003cbr /\u003e} | baseUrl: This is the entry point use to connect to the API server.\u003cbr /\u003elogType: The type of logs that should be displayed.\u003cbr /\u003e\u003cul\u003e\u003cli\u003eDebug: writes all log messages.\u003c/li\u003e\u003cli\u003eError: writes only error messages.\u003c/li\u003e\u003cli\u003eWarning: writes only warning messages.\u003c/li\u003e \u003cli\u003elogWriter:  The function that takes a single string argument and outputs the log message.\u003c/li\u003e\u003c/ul\u003e |\n\n#### Example\n\n```js\nimport {\n    BittrexRxClient,\n    OrderConditionalTypeValue,\n    TickIntervalValue,\n    TimeInEffectValue,\n    MarketOrderValue,\n    Model,\n    LogTypeValue\n} from \"bittrex-rx\";\n\nbittrexRx.settings({\n  logType: LogTypeValue.Warning,\n  logWriter: console.log\n});\n```\n\n\n\n### Api Credentials\n\nSign into your Bittrex account go to settings then API keys and add new key.\n\nThe API key has four access permissions they are:\n- **READ INFO** - Grants access to read private trade data such as orders, transaction history, balances, etc...\n- **TRADE LIMIT** - Grants access to limit order functions, which includes creating and canceling limit buy and sell orders.\n- **TRADE MARKET** - Grants access to other order functions, which includes creating and canceling conditional buy and sell orders.\n- **WITHDRAW** -  Grants access to the withdraw function which allows for withdrawals to another address. (This function is not available via the public interface of this library.)\n\n**For first time use please set API permissions to READ INFO only**.\n\n```js\nbittrexRx.apiCredentials(\"API_KEY\", \"API_SECRET\");\n```\n### Example\n```js\nimport {\n    BittrexRxClient,\n    OrderConditionalTypeValue,\n    TickIntervalValue,\n    TimeInEffectValue,\n    MarketOrderValue,\n    OrderTypeValue,\n    FillTypeValue,\n    Model,\n    LogTypeValue\n} from 'bittrex-rx';\n\nlet bittrexRx = new BittrexClient();\n\nbittrexRx.apiCredentials(\"API_KEY\", \"API_SECRET\");\n\nbittrexRx.getMarkets()\n    .subscribe(\n        data =\u003e {\n            data.forEach(market =\u003e {\n                bittrexRx.getTicker(market.MarketName).subscribe(tickData =\u003e {\n                    console.log(tickData);\n                });\n            });\n        },\n        err =\u003e {\n            console.log('Error', err);\n        },\n        () =\u003e {\n            console.log('Completed');\n        });\n```\n#### Response\n```js\n{\n    Bid: 0.00000345,\n    Ask: 0.00000347,\n    Last: 0.00000349\n}\n```\n\n## Observable Extension\n\n### intervalTime(milliseconds: number)\nThe intervalTime operator returns an observable that emits some sequence of data at specified intervals.\n\n#### Example\n```js\nbittrexRx.getMarkets()\n    .intervalTime(5000)\n    .subscribe(\n        data =\u003e {\n            for (let market of data) {\n                console.log(market);\n            }\n        });\n```\nThe example above fetches market data every 5 seconds.\n\n## Public API Method\n\n### bittrexRx.getMarkets()\nFetches a snapshot of all markets.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Observable\u003cModel.Market[]\u003e`\n\n#### Example\n```js\nbittrexRx.getMarkets()\n    .subscribe(\n        data =\u003e {\n            for (let market of data) {\n                console.log(market);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        MarketCurrency: 'LTC',\n        BaseCurrency: 'BTC',\n        MarketCurrencyLong: 'Litecoin',\n        BaseCurrencyLong: 'Bitcoin',\n        MinTradeSize: 1e-8,\n        MarketName: 'BTC-LTC',\n        IsActive: true,\n        Created: '2014-02-13T05:00:00.000Z',\n        Notice: null,\n        IsSponsored: null,\n        LogoUrl: 'https://bittrexblobstorage.blob.core.windows.net/public/6defbc41-582d-47a6-bb2e-d0fa88663524.png'\n    },\n    ...\n]\n```\n\n### bittrexRx.getCurrencies()\nFetches all the market currencies.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Observable\u003cModel.Currency[]\u003e`\n\n#### Example\n```js\nbittrexRx.getCurrencies()\n    .subscribe(\n        data =\u003e {\n            for (let currency of data) {\n                console.log(currency);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        Currency: 'LTC',\n        CurrencyLong: 'Litecoin',\n        MinConfirmation: 6,\n        TxFee: 0.01,\n        IsActive: true,\n        CoinType: 'BITCOIN',\n        BaseAddress: 'LhyLNfBkoKshT7R8Pce6vkB9T2cP2o84hx',\n        Notice: null\n    },\n...\n]\n```\n\n### bittrexRx.getTicker(market: string)\nFetches the Tick data which consists of the Bid, Ask and Latest Price the market was traded at.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-LTC' |\n\n#### Return Type\n`Observable\u003cModel.Ticker\u003e`\n\n#### Example\n```js\nbittrexRx.getTicker('BTC-LTC')\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    Bid: 0.00966006,\n    Ask: 0.00967006,\n    Last: 0.00966006\n}\n```\n\n### bittrexRx.getMarketSummaries()\nFetches the summary of each market available.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Observable\u003cModel.MarketSummary[]\u003e`\n\n#### Example\n```js\nbittrexRx.getMarketSummaries()\n    .subscribe(\n        data =\u003e {\n            for (let marketSummary of data) {\n                console.log(marketSummary);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        MarketName: 'BTC-LTC',\n        High: 0.01023899,\n        Low: 0.00966416,\n        Volume: 79788.80702209,\n        Last: 0.00970283,\n        BaseVolume: 791.93512777,\n        TimeStamp: '2017-10-26T01:52:30.430Z',\n        Bid: 0.00970283,\n        Ask: 0.00970683,\n        OpenBuyOrders: 2143,\n        OpenSellOrders: 12833,\n        PrevDay: 0.01020636,\n        Created: '2014-02-13T05:00:00.000Z'\n    },\n    ...\n]\n```\n\n### bittrexRx.getMarketSummary(market: string)\nFetches the summary of a specific market.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-LTC' |\n\n#### Return Type\n`Observable\u003cModel.MarketSummary\u003e`\n\n#### Example\n```js\nbittrexRx.getMarketSummary('BTC-LTC')\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    MarketName: 'BTC-LTC',\n    High: 0.01023899,\n    Low: 0.00966416,\n    Volume: 79788.80702209,\n    Last: 0.00970283,\n    BaseVolume: 791.93512777,\n    TimeStamp: '2017-10-26T01:52:30.430Z',\n    Bid: 0.00970283,\n    Ask: 0.00970683,\n    OpenBuyOrders: 2143,\n    OpenSellOrders: 12833,\n    PrevDay: 0.01020636,\n    Created: '2014-02-13T05:00:00.000Z'\n}\n```\n\n### bittrexRx.getOrderBook(market: string)\nFetches both buy and sell orders from the order book for a specific market.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-LTC' |\n\n#### Return Type\n`Observable\u003cModel.OrderBook\u003e`\n\n#### Example\n```js\nbittrexRx.getOrderBook('BTC-LTC')\n    .subscribe(\n        data =\u003e {\n           for (let orderItem of data.buy) {\n                console.log(orderItem);\n            }\n        });\n```\n\n#### Response\n```js\n{\n    buy: [\n        { Quantity: 0.1, Rate: 0.07059785 },\n        ...\n    ],\n    sell: [\n        { Quantity: 1.9251093, Rate: 0.07068 },\n        ...\n    ]\n}\n```\n\n### bittrexRx.getBuyOrderBook(market: string)\nFetches buy orders from the order book for a specific market.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-LTC' |\n\n#### Return Type\n`Observable\u003cModel.OrderBookOrderItem\u003e`\n\n#### Example\n```js\nbittrexRx.getBuyOrderBook('BTC-LTC')\n    .subscribe(\n        data =\u003e {\n           for (let orderItem of data) {\n                console.log(orderItem);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    { Quantity: 0.1, Rate: 0.07059785 },\n    ...\n]\n```\n\n### bittrexRx.getSellOrderBook(market: string)\nFetches sell orders from the order book for a specific market.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-LTC' |\n\n#### Return Type\n`Observable\u003cModel.OrderBookOrderItem\u003e`\n\n#### Example\n```js\nbittrexRx.getSellOrderBook('BTC-LTC')\n    .subscribe(\n        data =\u003e {\n           for (let orderItem of data) {\n                console.log(orderItem);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    { Quantity: 1.9251093, Rate: 0.07068 },\n    ...\n]\n```\n\n### bittrexRx.getMarketHistory(market: string)\nFetches the latest transactions for a specific market.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-LTC' |\n\n#### Return Type\n`Observable\u003cModel.MarketHistory[]\u003e`\n\n#### Example\n```js\nbittrexRx.getMarketHistory('BTC-LTC')\n    .subscribe(\n        data =\u003e {\n            for (let marketHistory of data) {\n                console.log(marketHistory);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        Id: 85963164,\n        TimeStamp: '2017-10-26T02:00:10.273Z',\n        Quantity: 3.29091587,\n        Price: 0.00973473,\n        Total: 0.03203617,\n        FillType: 'PARTIAL_FILL',\n        OrderType: 'BUY'\n    },\n    ...\n]\n```\n\n### bittrexRx.getCandles(market: string, tickIntervalType: TickIntervalValue)\nFetches the OHLC (Open, High, Low, Close) of a market for a given time period.\n\n\u003e **Note:**  This method relies on the v2 API of Bittrex. Very little is known about this version of the API and is subjected to change without warning!\n\n#### Parameters\n\n| Parameter        | Type              | Example                                  |\n| ---------------- | ----------------- | ---------------------------------------- |\n| market           | string            | 'USDT-BTC'                               |\n| tickIntervalType | TickIntervalValue | TickIntervalValue.oneMin, TickIntervalValue.fiveMin, ... |\n\n#### Return Type\n`Observable\u003cModel.Candle[]\u003e`\n\n#### Example\n```js\nbittrexRx.getCandles('BTC-LTC', TickIntervalType.oneMin)\n    .subscribe(\n        data =\u003e {\n            for (let candle of data) {\n                console.log(candle);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        O: 0.01149845,\n        H: 0.0115379,\n        L: 0.01149845,\n        C: 0.0115379,\n        V: 46.98461375,\n        T: '2017-10-16T03:56:00.000Z',\n        BV: 0.5419376\n    },\n    ...\n]\n```\n\n## Account API Methods\n\n### bittrexRx.getBalances()\nFetches all your current currency balances.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Observable\u003cModel.Balance[]\u003e`\n\n#### Example\n```js\nbittrexRx.getBalances()\n    .subscribe(\n        data =\u003e {\n            for (let balance of data) {\n                console.log(balance);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        Currency: 'LTC',\n        Balance: 0,\n        Available: 0,\n        Pending: 0,\n        CryptoAddress: null\n    },\n    ...\n]\n```\n\n\n### bittrexRx.getBalance(currency: string)\nFetches the current balance of a specific currency.\n\n#### Parameters\n\n| Parameter | Type   | Example |\n| --------- | ------ | ------- |\n| currency  | string | 'LTC'   |\n\n#### Return Type\n`Observable\u003cModel.Balance\u003e`\n\n#### Example\n```js\nbittrexRx.getBalance('LTC')\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    Currency: 'LTC',\n    Balance: 0,\n    Available: 0,\n    Pending: 0,\n    CryptoAddress: null\n}\n```\n\n### bittrexRx.getDepositAddress(currency: string)\nFetches the deposit address of a specific currency.\n\n#### Parameters\n\n| Parameter | Type   | Example |\n| --------- | ------ | ------- |\n| currency  | string | 'LTC'   |\n\n#### Return Type\n`Observable\u003cModel.DepositAddress\u003e`\n\n#### Example\n```js\nbittrexRx.getBalance('LTC')\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    Currency: 'LTC',\n    Address: ''\n}\n```\n\n### bittrexRx.getOrder(uuid: string)\nFetches an order by a specific identifier.\n\n#### Return Type\n`Observable\u003cModel.Order\u003e`\n\n#### Parameters\n\n| Parameter | Type   | Example                                |\n| --------- | ------ | -------------------------------------- |\n| uuid      | string | '2968d0f9-2854-48e5-bbbf-18a2b7451140' |\n\n#### Example\n```js\nbittrexRx.getOrder('dc1a6628-7e12-4817-aa16-b5e9860d116c')\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    AccountId: null,\n    OrderUuid: 'dc1a6628-7e12-4817-aa16-b5e9860d116c',\n    Exchange: 'BTC-XVG',\n    Type: 'LIMIT_BUY',\n    Quantity: 326.22641509,\n    QuantityRemaining: 0,\n    Limit: 0.00000159,\n    Reserved: 0.00051869,\n    ReserveRemaining: 0.00051869,\n    CommissionReserved: 0.00000129,\n    CommissionReserveRemaining: 0,\n    CommissionPaid: 0.00000129,\n    Price: 0.00051869,\n    PricePerUnit: 0.00000158,\n    Opened: '2017-09-27T02:47:50.740Z',\n    Closed: '2017-09-27T03:39:30.280Z',\n    IsOpen: false,\n    Sentinel: 'Invalid Date',\n    CancelInitiated: false,\n    ImmediateOrCancel: false,\n    IsConditional: false,\n    Condition: 'NONE',\n    ConditionTarget: null\n}\n```\n\n### bittrexRx.getOrderHistory()\nFetches the total transaction history.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Observable\u003cModel.OrderHistoryOrderItem[]\u003e`\n\n#### Example\n```js\nbittrexRx.getOrderHistory()\n    .subscribe(\n        data =\u003e {\n           for (let orderHistoryItem of data) {\n                console.log(orderHistoryItem);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        OrderUuid: 'dc1a6628-7e12-4817-aa16-b5e9860d116c',\n        Exchange: 'BTC-XVG',\n        TimeStamp: '2017-09-27T02:47:50.740Z',\n        OrderType: 'LIMIT_BUY',\n        Limit: 0.00000159,\n        Quantity: 326.22641509,\n        QuantityRemaining: 0,\n        Commission: 0.00000129,\n        Price: 0.00051869,\n        PricePerUnit: 0.00000158,\n        IsConditional: false,\n        Condition: 'NONE',\n        ConditionTarget: null,\n        ImmediateOrCancel: false,\n        Closed: '2017-09-27T03:39:30.280Z'\n    },\n    ...\n]\n```\n\n\n### bittrexRx.getDepositHistory(currency: string)\nFetches the deposit records of the currency specified.\n\n#### Parameters\n\n| Parameter | Type   | Example |\n| --------- | ------ | ------- |\n| currency  | string | 'LTC'   |\n\n#### Return Type\n`Observable\u003cModel.Transaction[]\u003e`\n\n#### Example\n```js\nbittrexRx.getDepositHistory('LTC')\n    .subscribe(\n        data =\u003e {\n           for (let transactionHistory of data) {\n                console.log(transactionHistory);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        Id: 26972433,\n        Amount: 0.02455098,\n        Currency: 'BTC',\n        Confirmations: 4,\n        LastUpdated: '2017-08-16T22:13:47.783Z',\n        TxId: '8aa448a50b06c0e1436e6e000132d721761e54cac365769ec1136a391df44bfc',\n        CryptoAddress: '138TtdZkyMU8GMY8tzpZuc7xsqrb4CwrGE'\n    },\n    ...\n]\n```\n\n### bittrexRx.getWithdrawalHistory(currency: string)\nFetches the withdrawal records of the currency specified.\n\n#### Parameters\n\n| Parameter | Type   | Example |\n| --------- | ------ | ------- |\n| currency  | string | 'BTC'   |\n\n#### Return Type\n`Observable\u003cModel.WithdrawalTransaction[]\u003e`\n\n#### Example\n```js\nbittrexRx.getWithdrawalHistory('BTC')\n    .subscribe(\n        data =\u003e {\n            for (let transactionHistory of data) {\n                console.log(transactionHistory);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        PaymentUuid: \"b14f86bb-b15b-4177-9779-5466eb3a0fbc\",\n        Currency: \"BTC\",\n        Amount: 0.02039674,\n        Address: \"1Fo8nz1m4fBb7iDKWDghiA6YSEsg4HZJxD\",\n        Opened: \"2017-08-18T04:40:44.737\",\n        Authorized: true,\n        PendingPayment: false,\n        TxCost: 0.001,\n        TxId: \"38a3147f51b8c4798d1a5b3e2712bd7b7177fa99d6457af45a84e56664b6bbc6\",\n        Canceled: false,\n        InvalidAddress: false\n    },\n    ...\n]\n```\n\n## Market API Methods\n\n### bittrexRx.setBuyOrder(market: string, quantity: number, rate: number)\nPlace buy limit order for a market pair at a rate and quantity specified.\n\n#### Parameters\n\n| Parameter | Type   | Example    |\n| --------- | ------ | ---------- |\n| market    | string | 'BTC-LTC'  |\n| quantity  | number | 0.05849296 |\n| rate      | number | 0.00869720 |\n\n\n#### Return Type\n`Observable\u003cModel.OrderResult\u003e`\n\n#### Example\n```js\nbittrexRx.setBuyOrder('BTC-LTC', 0.05849296, 0.00869720)\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    uuid: '54a1cc8f-10dc-49de-bb52-f5d70b1c84ec'\n}\n```\n\n### bittrexRx.setSellOrder(market: string, quantity: number, rate: number)\nPlace sell limit order for a market pair at a rate and quantity specified.\n\n#### Parameters\n\n| Parameter | Type   | Example    |\n| --------- | ------ | ---------- |\n| market    | string | 'USDT-BTC' |\n| quantity  | number | 0.0051     |\n| rate      | number | 7000       |\n\n#### Return Type\n`Observable\u003cModel.OrderResult\u003e`\n\n#### Example\n```js\nbittrexRx.setSellOrder('USDT-BTC', 0.0051, 7000)\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    uuid: '2968d0f9-2854-48e5-bbbf-18a2b7451140'\n}\n```\n\n### bittrexRx.getOpenOrders(market: string)\nFetch orders that has not been executed for specific market.\n\n#### Parameters\n\n| Parameter | Type   | Example   |\n| --------- | ------ | --------- |\n| market    | string | 'BTC-GNT' |\n\n#### Return Type\n`Observable\u003cModel.OpenOrder[]\u003e`\n\n#### Example\n```js\nbittrexRx.getOpenOrders('BTC-GNT')\n    .subscribe(\n        data =\u003e {\n            for (let openOrder of data) {\n                console.log(openOrder);\n            }\n        });\n```\n\n#### Response\n```js\n[\n    {\n        Uuid: null,\n        OrderUuid: '9a6e6f63-de19-475a-ad81-c85129681253',\n        Exchange: 'BTC-GNT',\n        OrderType: 'LIMIT_BUY',\n        Quantity: 16.14487464,\n        QuantityRemaining: 16.14487464,\n        Limit: 0.00003151,\n        CommissionPaid: 0,\n        Price: 0,\n        PricePerUnit: null,\n        Opened: '2017-10-24T03:50:26.250Z',\n        Closed: null,\n        CancelInitiated: false,\n        ImmediateOrCancel: false,\n        IsConditional: false,\n        Condition: 'NONE',\n        ConditionTarget: null\n    }\n]\n```\n\n### bittrexRx.cancelOrder(uuid: string)\nCancel order returns null.\n\n#### Parameters\n\n| Parameter | Type   | Example                                |\n| --------- | ------ | -------------------------------------- |\n| uuid      | string | '2968d0f9-2854-48e5-bbbf-18a2b7451140' |\n\n#### Return Type\n`Observable\u003cvoid\u003e`\n\n#### Example\n```js\nbittrexRx.cancelOrder('54a1cc8f-10dc-49de-bb52-f5d70b1c84ec')\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\nnull\n```\n\n### bittrexRx.setConditionalBuyOrder(market: string, marketOrderType: MarketOrderValue, quantity: number, rate: number, timeInEffect: TimeInEffectValue, conditionType: OrderConditionalTypeValue, target: number)\nExecutes buy orders under the conditions specified.\n\n\u003e **Note:**  This method relies on the v2 API of Bittrex. Very little is known about this version of the API and is subjected to change without warning!\n\n#### Parameter\n\n| Parameter       | Type                      | Example                                  | Description                              |\n| --------------- | ------------------------- | ---------------------------------------- | ---------------------------------------- |\n| market          | string                    | 'BTC-ETH'                                |                                          |\n| marketOrderType | MarketOrderValue          | MarketOrderValue.LIMIT                   | LIMIT: The order will be executed at a specific price. |\n| quantity        | number                    | 0.01162237                               | -                                        |\n| rate            | number                    | 0.04377120                               | -                                        |\n| timeInEffect    | TimeInEffectValue         | TimeInEffectValue.IMMEDIATE_OR_CANCEL,\u003cbr\u003e TimeInEffectValue.GOOD_TIL_CANCELLED, \u003cbr\u003eTimeInEffectValue.FILL_OR_KILL | IMMEDIATE_OR_CANCEL: The order must be executed immediately or else it is canceled. Partial fills are accepted .\u003cbr\u003e GOOD_TIL_CANCELLED:,The order is placed until the user cancels it. \u003cbr\u003eFILL_OR_KILL: The order must be completed in its entirety. The full quantity of the order at a fixed prices must be executed or canceled. |\n| conditionType   | OrderConditionalTypeValue | OrderConditionalTypeValue.NONE, \u003cbr\u003eOrderConditionalTypeValue.GREATER_THAN,\u003cbr\u003e OrderConditionalTypeValue.LESS_THAN | GREATER_THAN: The order will be executed if the price of the security is greater than the price specified in the target parameter. \u003cbr\u003eLESS_THAN: The order will be executed if the price of the security is less than the price specified in the target parameter. |\n| target          | number                    | 0.0                                      | -                                        |\n\n\n#### Return Type\n`Observable\u003cModel.ConditionalOrder\u003e`\n\n#### Example\n```js\nbittrexRx.setConditionalBuyOrder('BTC-ETH', MarketOrderValue.LIMIT, 0.01162237, 0.04377120, TimeInEffectValue.GOOD_TIL_CANCELLED, OrderConditionalTypeValue.NONE, 0.0)\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    OrderId: 'ac983afd-6852-478e-8415-d6e30615ea9c',\n    MarketName: 'BTC-ETH',\n    MarketCurrency: 'ETH',\n    BuyOrSell: 'Buy',\n    OrderType: 'LIMIT',\n    Quantity: 0.01162237,\n    Rate: 0.0437712\n}\n```\n\n### bittrexRx.setConditionalSellOrder(market: string, marketOrderType: MarketOrderValue, quantity: number, rate: number, timeInEffect: TimeInEffectValue, conditionType: OrderConditionalTypeValue, target: number)\nExecutes sell orders under the conditions specified.\n\n\u003e **Note:**  This method relies on the v2 API of Bittrex. Very little is known about this version of the API and is subjected to change without warning!\n\n#### Parameter\n\n| Parameter       | Type                      | Example                                  | Description                              |\n| --------------- | ------------------------- | ---------------------------------------- | ---------------------------------------- |\n| market          | string                    | 'USDT-ETH'                               |                                          |\n| marketOrderType | MarketOrderValue          | MarketOrderValue.LIMIT                   | LIMIT: The order will be executed at a specific price. |\n| quantity        | number                    | 0.01574783                               | -                                        |\n| rate            | number                    | 400                                      | -                                        |\n| timeInEffect    | TimeInEffectValue         | TimeInEffectValue.IMMEDIATE_OR_CANCEL,\u003cbr\u003e TimeInEffectValue.GOOD_TIL_CANCELLED, \u003cbr\u003eTimeInEffectValue.FILL_OR_KILL | IMMEDIATE_OR_CANCEL: The order must be executed immediately or else it is canceled. Partial fills are accepted .\u003cbr\u003e GOOD_TIL_CANCELLED:,The order is placed until the user cancels it. \u003cbr\u003eFILL_OR_KILL: The order must be completed in its entirety. The full quantity of the order at a fixed prices must be executed or canceled. |\n| conditionType   | OrderConditionalTypeValue | OrderConditionalTypeValue.NONE, \u003cbr\u003eOrderConditionalTypeValue.GREATER_THAN,\u003cbr\u003e OrderConditionalTypeValue.LESS_THAN | GREATER_THAN: The order will be executed if the price of the security is greater than the price specified in the target parameter. \u003cbr\u003eLESS_THAN: The order will be executed if the price of the security is less than the price specified in the target parameter. |\n| target          | number                    | 0.0                                      | -                                        |\n\n#### Return Type\n`Observable\u003cModel.ConditionalOrder\u003e`\n\n#### Example\n```js\nbittrexRx.setConditionalSellOrder('BTC-ETH', MarketOrderValue.LIMIT, 0.01162237, 0.04377120, TimeInEffectValue.GOOD_TIL_CANCELLED,  OrderConditionalTypeValue.NONE, 0.0)\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    OrderId: 'b27a6b86-bae6-4b04-be2d-6726e717e53e',\n    MarketName: 'USDT-ETH',\n    MarketCurrency: 'ETH',\n    BuyOrSell: 'Sell',\n    OrderType: 'LIMIT',\n    Quantity: 0.01574783,\n    Rate: 400\n}\n```\n\n\n### customRequest(url: string, queryOptions: Object, useCredentials: Boolean)\nThis method is not dependent on the API version and allows for the sending of custom requests.\n\n#### Parameters\n\n| Parameter      | Type    | Example                                  | Description                              |\n| -------------- | ------- | ---------------------------------------- | ---------------------------------------- |\n| url            | string  | https://bittrex.com/api/v1.1/public/getmarketsummary | API endpoint.                            |\n| queryOptions   | Object  | { market: 'BTC-LTC' }                    | Query string parameters.                 |\n| useCredentials | Boolean | false                                    | Specify whether the API credentials should be enabled or not. |\n\n#### Return Type\n`Observable\u003cany\u003e`\n\n#### Example\n```js\nbittrexRx.customRequest('https://bittrex.com/api/v1.1/public/getmarketsummary', { market: 'BTC-LTC' }, false)\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n[\n    {\n        MarketName: 'BTC-LTC',\n        High: 0.00908,\n        Low: 0.0076,\n        Volume: 291758.48361243,\n        Last: 0.0084773,\n        BaseVolume: 2464.80235543,\n        TimeStamp: '2017-11-08T00:32:02.203',\n        Bid: 0.00846202,\n        Ask: 0.0084773,\n        OpenBuyOrders: 2964,\n        OpenSellOrders: 13074,\n        PrevDay: 0.00775,\n        Created: '2014-02-13T00:00:00'\n    }\n]\n```\n\n## Web Socket\n\n\n### bittrexRx.Socket.summaryState()\nConnect to a live stream of market summary data.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Observable\u003cModel.SummaryStateDelta\u003e`\n\n#### Example\n```js\nbittrexRx.Socket.summaryState()\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    Nounce: 51705,\n    Deltas: [\n        {\n            MarketName: 'USDT-BTC',\n            High: 6002,\n            Low: 5410.36691866,\n            Volume: 9899.62086304,\n            Last: 5693.9,\n            BaseVolume: 56483410.89562297,\n            TimeStamp: '2017-10-23T18:25:14.817Z',\n            Bid: 5689,\n            Ask: 5693.9,\n            OpenBuyOrders: 7611,\n            OpenSellOrders: 3541,\n            PrevDay: 5850,\n            Created: '2015-12-11T06:31:40.633Z'\n        },\n        ...\n    ]\n}\n```\n\n### bittrexRx.Socket.exchangeState(market: string[])\nConnect to a live stream of specific market data. The data consists of the order books and market history.\n\n#### Parameters\n\n| Parameter | Type     | Example      |\n| --------- | -------- | ------------ |\n| market    | string[] | ['BTC-L TC'] |\n\n#### Return Type\n`Observable\u003cModel.OrderBookStream\u003e`\n\n#### Example\n```js\nbittrexRx.Socket.exchangeState(['BTC-ETH'])\n    .subscribe(\n        data =\u003e {\n            console.log(data);\n        });\n```\n\n#### Response\n```js\n{\n    MarketName: 'BTC-ETH',\n    Nounce: 40393,\n    Buys:[\n        { Type: 1, Rate: 0.053516, Quantity: 0 },\n        { Type: 1, Rate: 0.05344106, Quantity: 0 },\n        { Type: 2, Rate: 0.05188199, Quantity: 0.04339557 },\n        { Type: 2, Rate: 0.05170671, Quantity: 0.04354268 },\n        { Type: 2, Rate: 0.05153143, Quantity: 0.04369078 },\n        { Type: 2, Rate: 0.05135616, Quantity: 0.0438399 },\n        { Type: 2, Rate: 0.05118088, Quantity: 0.04399003 },\n        { Type: 2, Rate: 0.0510056, Quantity: 0.0441412 }\n    ],\n    Sells: [\n        { Type: 2, Rate: 0.05382, Quantity: 10.18061112 },\n        { Type: 2, Rate: 0.05434562, Quantity: 4.83608199 },\n        { Type: 0, Rate: 0.05450161, Quantity: 8.71091193 },\n        { Type: 1, Rate: 0.05450262, Quantity: 0 }\n    ],\n    Fills: [\n        {\n            OrderType: 'BUY',\n            Rate: 0.05382,\n            Quantity: 0.42158507,\n            TimeStamp: '2017-10-24T20:16:12.213Z'\n        }\n    ]\n}\n```\n\n### bittrexRx.Socket.close()\nCloses socket connection.\n\n#### Parameters\n\n| Parameter | Type | Example |\n| --------- | ---- | ------- |\n| none      | -    | -       |\n\n#### Return Type\n`Void`\n\n#### Example\n```js\nbittrexRx.Socket.close();\n```\n\n\n### Websockets ServiceHandlers\n\n#### Example\n\n```js\nbittrexRx.Socket.Status.Connected = function ( connection ){\n    console.log('connection start', connection);\n}\n\nbittrexRx.Socket.Status.ConnectionFailed = function ( connection ){\n    console.log('connection failed', connection);\n}\n\nbittrexRx.Socket.Status.Disconnected = function (){\n    console.log(\"disconnected\");\n}\n\nbittrexRx.Socket.Status.Error = function ( error ){\n    console.log(\"error: \", error);\n}\n\nbittrexRx.Socket.Status.BindingError = function ( error ){\n    console.log(\"bindingError: \", error)\n}\n\nbittrexRx.Socket.Status.ConnectionLost = function ( error ){\n    console.log(\"connection lost: \", error);\n}\n\nbittrexRx.Socket.Status.Reconnecting = function ( retry ){\n    console.log('connection retry ', retry);\n    return true;\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharry-sm%2Fbittrexrx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharry-sm%2Fbittrexrx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharry-sm%2Fbittrexrx/lists"}