q.md

Bittrex API

• About

  • 1

• REST

  • v1.1
    • getCurrencies()
    • getMarkets()
    • getMarketSummaries({market?})
    • getTicker({market})
    • getOrderBook({market,type})
    • getMarketHistory({market})
    • buyLimit({market,quantity,rate})
    • sellLimit({market,quantity,rate})
    • buyMarket({market,quantity}) DEPRECATED!
    • sellMarket({market,quantity}) DEPRECATED!
    • cancel({uuid})
    • getOrder({uuid})
    • getOpenOrders({market?})
    • getCloseOrders({market?})
    • getBalances({currency?})
    • getDepositAddress({currency})
    • withdraw({currency,quantity,address,paymentid?})
    • getDepositHistory({currency?})
    • getWithdrawalHistory({currency?})
  • v2.0
    • getBTCPrice()
    • getCurrencies({currency?}) getcurrenciescurrency
    • getWalletHealth({currency?})
    • getMarkets()
    • getMarketSummaries()
    • getMarketSummary({marketName}) UNSTABLE!
    • getTicks({market,interval})
    • getLatestTick({market,interval})
    • buy({market,type,quantity,rate,immediate?,condition?,target?})
    • sell({market,type,quantity,rate,immediate?,condition?,target?})
    • cancel({uuid})
    • getOrder({uuid})
    • getOpenOrders({market?})
    • getCloseOrder({market?})
    • getBalances({currency?})
    • getDepositAddress({currency})
    • getFiatAddresses({currency}) UNKNOWN!
    • withdraw({currency,quantity,address,paymentId?,2fa?})
    • getDepositHistory()
    • getWithdrawalHistory()
    • getPendingDeposits()
    • getPendingWithdrawals()

• WebSocket

  • Queries
    • QuerySummaryState()
    • QueryExchangeState([market])
    • QueryBalanceState([market])
    • QueryOrderState([market])
  • Subscribes
    • SubscribeToSummaryDeltas()
    • SubscribeToExchangeDeltas()
    • SubscribeToUserDeltas()

About

REST

v1.1

getCurrencies()

Used to get all supported currencies at Bittrex along with other meta data.

Parameters: NONE

Response:

[
  {
    Currency: "BTC",
    CurrencyLong: "Bitcoin",
    MinConfirmation: 2,
    TxFee: 0.0005,
    IsActive: true,
    CoinType: "BITCOIN",
    BaseAddress: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    Notice: null
  },
  ...
]

Explanation:

Field	Type	Description
Currency	String	Currency Short Name
CurrencyLong	String	Currency Long Name
MinConfirmation	Integer	???
TxFee	Float	Tax Fee
IsActive	Boolean	Determines, whether it is active
CoinType	String	Coin Type
BaseAddress	String	???
Notice	String?	Information about coin (why it's inactive etc)

getMarkets()

Used to get the open and available trading markets at Bittrex along with other meta data.

Parameters: NONE

Response:

[
  {
    MarketName: 'BTC-LTC',
    IsActive: true,
    MinTradeSize: 0.01435906,
    Created: '2014-02-13T00:00:00',
    MarketCurrency: 'LTC',
    BaseCurrency: 'BTC',
    MarketCurrencyLong: 'Litecoin',
    BaseCurrencyLong: 'Bitcoin',
    Notice: null,
    IsSponsored: null,
    LogoUrl: 'https://bittrexblobstorage.blob.core.windows.net/public/6defbc41-582d-47a6-bb2e-d0fa88663524.png'
  },

Explanation:

Field	Type	Description
MarketName	String	BaseCurrency + MarketCurrency
IsActive	Boolean	Determines, whether market is active
MinTradeSize	Float	Minimum trade size
Created	ISODate	When Created
MarketCurrency	String	Market Currency Short Name
BaseCurrency	String	Base Currency Short Name
MarketCurrencyLong	String	Market Currency Long Name
BaseCurrencyLong	String	Base Currency Long Name
Notice	String?	Information about market (delisting etc)
LogoUrl	String	Url to icon of the coin

getMarketSummaries({market?})

Used to get the last 24 hour summary of markets. A specific market can be requested.

Parameters:

Name	Type	Required	Description
market	String	false	A string literal for the market (ex: BTC-LTC)

Response:

NOTE: If the market is not specified - the result will be an Array of Summaries.

 {
   MarketName: 'BTC-LTC',
   Bid: 0.01234063,
   Ask: 0.01237,
   Low: 0.01231215,
   High: 0.0125996,
   Last: 0.012316,
   Volume: 11027.32460863,
   BaseVolume: 137.34228718,
   TimeStamp: '2018-07-17T09:55:26.917',
   OpenBuyOrders: 873,
   OpenSellOrders: 2963,
   PrevDay: 0.01255,
   Created: '2014-02-13T00:00:00'
 }

Explanation:

Field	Type	Description
MarketName	String	Market name
Bid	Float	Max price to sell
Ask	Float	Min price to buy
Low	Float	Minimum price for 24h
High	Float	Maximum price for 24h
Last	Float	Volume of market coin
Volume	Float	Last price
BaseVolume	Float	Volume of base coin (BTC)
TimeStamp	ISODate	Timestamp
OpenBuyOrders	Integer	Number of Open Buy Orders
OpenSellOrders	Integer	Number of Open Sell Orders
PrevDay	Float	Previous Date Price
Created	ISODate	When Created

getTicker({market})

Used to get the current tick values for a market.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)

Response:

{
  Bid: 0.012075,
  Ask: 0.012085,
  Last: 0.01209878 
}

Explanation:

Field	Type	Description
Bid	Float	Max price to sell
Ask	Float	Min price to buy
Last	Float	Last price of completed order

getOrderBook({market,type})

Used to get retrieve the orderbook for a given market. NOTE: If type is buy or sell then result will by array of orders (depth - 500), otherwise - object with two keys buy and sell (depth of each - 100).

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
type	String	true	buy, sell or both to identify the type of orderbook to return.

Response:

// Type `both`
{
  buy: [
    {
      Quantity: 481.59681381,
      Rate: 0.021501
    },
    ...
  ],
  sell: [
    {
      Quantity: 481.59681381,
      Rate: 0.021501
    },
    ...
  ]
}

// Type `buy` or `sell`
[
  {
    Quantity: 481.59681381,
    Rate: 0.021501
  },
  ...
]

Explanation:

Field	Type	Description
Quantity	Float	Amount of coin
Rate	Float	Price per one coin

getMarketHistory({market})

Used to retrieve the latest trades that have occurred for a specific market. Depth of array - 100.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)

Response:

[
  {
    Id: 171869812,
    TimeStamp: '2018-07-11T21:25:26.743',
    Quantity: 0.58729302,
    Price: 0.01211148,
    Total: 0.00711298,
    FillType: 'PARTIAL_FILL',
    OrderType: 'SELL'
  },
  ...
]

Explanation:

Field	Type	Description
Id	Integer	Identificator
TimeStamp	ISODate	Date of the order
Quantity	Float	Amount of coin
Price	Float	Rate of one coin
Total	Float	Total price of order (must be quantity*price)
FillType	String	PARTIAL_FILL - mean only part of order was filled. FILL - order was filled fully
OrderType	String	SELL or BUY

buyLimit({market,quantity,rate})

Used to place a buy order in a specific market. Use buyLimit to place limit orders. Make sure you have the proper permissions set on your API keys for this call to work.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
quantity	Float	true	The amount to purchase
rate	Float	true	The rate at which to place the order

Response:

{
  uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Identificator of the order

sellLimit({market,quantity,rate})

Used to place an sell order in a specific market. Use sellLimit to place limit orders. Make sure you have the proper permissions set on your API keys for this call to work.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
quantity	Float	true	The amount to purchase
rate	Float	true	The rate at which to place the order

Response:

{
	uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Identificator of the order

buyMarket({market,quantity}) DEPRECATED!

Used to place a buy order in a specific market. Use buyMarket to place market orders. Make sure you have the proper permissions set on your API keys for this call to work.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
quantity	Float	true	The amount to purchase

Response:

{
  uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Identificator of the order

sellMarket({market,quantity}) DEPRECATED!

Used to place an sell order in a specific market. Use sellMarket to place market orders. Make sure you have the proper permissions set on your API keys for this call to work.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
quantity	Float	true	The amount to purchase

Response:

{
	uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Identificator of the order

cancel({uuid})

Used to cancel an open order.

Parameters:

Name	Type	Required	Description
uuid	String	true	uuid of the order

Response:

null

getOrder({uuid})

Used to retrieve a single order by uuid.

Parameters:

Name	Type	Required	Description
uuid	String	true	uuid of the order

Response:

{ 
  AccountId: null,
  OrderUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  Exchange: 'USDT-BTC',
  Type: 'LIMIT_BUY',
  Quantity: 1,
  QuantityRemaining: 1,
  Limit: 1,
  Reserved: 1,
  ReserveRemaining: 1,
  CommissionReserved: 0.0025,
  CommissionReserveRemaining: 0.0025,
  CommissionPaid: 0,
  Price: 0,
  PricePerUnit: null,
  Opened: '2018-07-13T12:53:25.503',
  Closed: null,
  IsOpen: true,
  Sentinel: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  CancelInitiated: false,
  ImmediateOrCancel: false,
  IsConditional: false,
  Condition: 'NONE',
  ConditionTarget: null
}

Explanation:

Field	Type	Description
AccountId	String?	User uuid (always null)
OrderUuid	String	Order uuid
Exchange	String	String literal for the market
Type	String	Type of order: LIMIT_BUY or LIMIT_SELL. (Maybe also: MARKET_BUY or MARKET_SELL)
Quantity	Float	Total Quantity
QuantityRemaining	Float	Remaining Quantity
Limit	Float	Limit of Order
Reserved	Float	???
ReserveRemaining	Float	???
CommissionReserved	Float	???
CommissionReserveRemaining	Float	???
CommissionPaid	Float	Commission Paid
Price	Float	Order Price
PricePerUnit	Float?	Average Price Per Unit
Opened	ISODate	Date of opening order
Closed	ISODate?	Date of closing order (null if opened yet)
IsOpen	Boolean	???
Sentinel	String	???
CancelInitiated	Boolean	Determines, if Cancel was Initiated
ImmediateOrCancel	Boolean	Determines, if it is Immediate or Cancel Order
IsConditional	Boolean	Determines, if it is Conditional Order
Condition	String	NONE, GREATER_THAN or LESS_THAN
ConditionTarget	Float?	Condition Target, which is checked in Condition, if Condition is set.

getOpenOrders({market?})

Get all orders that you currently have opened. A specific market can be requested.

Parameters:

Name	Type	Required	Description
market	String	false	A string literal for the market (ex: BTC-LTC)

Response:

[
  {
    Uuid: null,
    OrderUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Exchange: 'USDT-BTC',
    OrderType: 'LIMIT_BUY',
    Quantity: 1,
    QuantityRemaining: 1,
    Limit: 1,
    CommissionPaid: 0,
    Price: 0,
    PricePerUnit: null,
    Opened: '2018-07-13T12:53:25.503',
    Closed: null,
    CancelInitiated: false,
    ImmediateOrCancel: false,
    IsConditional: false,
    Condition: 'NONE',
    ConditionTarget: null
  },
  ...
]

Explanation:

Field	Type	Description
Uuid	String?	User uuid (always null)
OrderUuid	String	Order uuid
Exchange	String	String literal for the market
OrderType	String	Type of order: LIMIT_BUY or LIMIT_SELL.
Quantity	Float	Total Quantity
QuantityRemaining	Float	Remaining Quantity
Limit	Float	Limit of Order (Rate)
CommissionPaid	Float	Commission Paid
Price	Float	Order Price
PricePerUnit	Float?	Average Price Per Unit
Opened	ISODate	Date of opening order
Closed	ISODate?	Date of closing order (null if opened yet)
CancelInitiated	Boolean	Determines, if Cancel was Initiated
ImmediateOrCancel	Boolean	Determines, if it is Immediate or Cancel Order
IsConditional	Boolean	Determines, if it is Conditional Order
Condition	String	NONE, GREATER_THAN or LESS_THAN
ConditionTarget	Float?	Condition Target, which is checked in Condition, if Condition is set.

getCloseOrders({market?})

Get all orders that you currently have opened. A specific market can be requested.

Parameters:

Name	Type	Required	Description
market	String	false	A string literal for the market (ie. BTC-LTC). If omitted, will return for all markets

Response:

[
  {
	OrderUuid: '660ba937-fad4-4c98-a8dd-bcf0a850c910',
	Exchange: 'USDT-BTC',
	OrderType: 'LIMIT_SELL',
	Limit: 7350,
	Quantity: 0.00679265,
	QuantityRemaining: 0,
	Commission: 0.12481494,
	Price: 49.9259775,
	PricePerUnit: 7350,
	TimeStamp: '2018-07-17T22:11:38.367',
	Closed: '2018-07-17T22:12:40.243',
	ImmediateOrCancel: false,
	IsConditional: false,
	Condition: 'NONE',
	ConditionTarget: null
  },
  ...
]

Explanation:

Field	Type	Description
OrderUuid	String	Order uuid
Exchange	String	String literal for the market
OrderType	String	Type of order: LIMIT_BUY or LIMIT_SELL.
Quantity	Float	Total Quantity
QuantityRemaining	Float	Remaining Quantity
Limit	Float	Limit of Order (Rate)
Commission	Float	Commission Paid
Price	Float	Order Price
PricePerUnit	Float?	Average Price Per Unit
TimeStamp	ISODate	Date of opening order
Closed	ISODate	Date of closing order
ImmediateOrCancel	Boolean	Determines, if it is Immediate or Cancel Order
IsConditional	Boolean	Determines, if it is Conditional Order
Condition	String	NONE, GREATER_THAN or LESS_THAN
ConditionTarget	Float?	Condition Target, which is checked in Condition, if Condition is set.

getBalances({currency?})

Used to retrieve all balances from your account. A specific currency can be requested.

Parameters:

Name	Type	Required	Description
currency	String	false	A string literal for the currency (ex: BTC)

Response:

NOTE: If the currency is not specified - the result will be an Array of Currencies.

{
  Currency: 'BTC',
  Balance: 1,
  Available: 0.5,
  Pending: 0.1,
  CryptoAddress: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
Currency	String	Currency
Balance	Float	All money including on orders
Available	Float	Only free money
Pending	Float	Money on pending
CryptoAddress	String?	Address (null if not generated yet)

getDepositAddress({currency})

Used to retrieve or generate an address for a specific currency. If one does not exist, the call will throw ADDRESS_GENERATING until one is available.

Parameters:

Name	Type	Required	Description
currency	String	true	A string literal for the currency (ex: BTC)

Response:

{
  Currency: 'BTC',
  CryptoAddress: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
Currency	String	Currency title
CryptoAddress	String	Address of wallet

withdraw({currency,quantity,address,paymentid?})

Used to withdraw funds from your account. Note: account for tax fee.

Parameters:

Name	Type	Required	Description
currency	String	true	A string literal for the currency (ex: BTC)
quantity	Float	true	The quantity of coins to withdraw
address	String	true	The address where to send the funds
paymentid	String	false	Used for CryptoNotes/BitShareX/Nxt optional field (memo/paymentid)

Response:

{
  uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Uuid of action

getDepositHistory({currency?})

Used to retrieve your deposit history. A specific currency can be requested.

Parameters:

Name	Type	Required	Description
currency	String	false	A string literal for the currency (ex. BTC). If omitted, will return for all currencies.

Response:

[
  {
    Id: 25641439,
    Currency: 'BTC',
    Amount: 0.01125375,
    Confirmations: 2,
    LastUpdated: '2017-08-07T13:47:06.513',
    TxId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    CryptoAddress: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  },
  ...
]

Explanation:

Field	Type	Description
Id	Integer	ID of payment
Currency	String	Coin title
Amount	Float	Amount
Confirmations	Integer	Count of confirmations
LastUpdated	ISODate	When was open
TxId	String	Tax ID
CryptoAddress	String	Where was sent

getWithdrawalHistory({currency?})

Used to retrieve your withdrawal history. A specific currency can be requested.

Parameters:

Name	Type	Required	Description
currency	String	false	A string literal for the currency (ex. BTC). If omitted, will return for all currencies.

Response:

[
  {
    PaymentUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Currency: 'BTC',
    Amount: 0.02,
    Address: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    Opened: '2017-11-21T16:38:26.4',
    Authorized: true,
    PendingPayment: false,
    TxCost: 0.001,
    TxId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    Canceled: false,
    InvalidAddress: false
  },
  ...
]

Explanation:

Field	Type	Description
PaymentUuid	String	ID of payment
Currency	String	Coin title
Amount	Float	Amount
Address	String	Where was sent
Opened	ISODate	When was open
Authorized	Bool	-
PendingPayment	Bool	-
TxCost	Float	Tax fee
TxId	String	Tax ID
Canceled	Bool	-
InvalidAddress	Bool	-

v2.0

getBTCPrice()

Used to get the Bittrex BTC Price in USD.

Parameters: NONE

Response:

{
  bpi: {
    USD: {
      rate_float: 6250.485
    }
  }
}

Explanation:

Field	Type	Description
bpi.USD.rate_float	Float	Price of Bitcoin in USD

getCurrencies({currency?})

Used to get all supported currencies at Bittrex along with other meta data. A specific currency can be requested.

Parameters:

Name	Type	Required	Description
currency	String	false	A string literal for the currency (ex: BTC). If omitted, will return for all currencies.

Response:

NOTE: If the currency is not specified - the result will be an Array of Currency.

{
  Currency: 'BTC',
  CurrencyLong: 'Bitcoin',
  MinConfirmation: 2,
  TxFee: 0.0005,
  IsActive: true,
  CoinType: 'BITCOIN',
  BaseAddress: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  Notice: null
}

Explanation:

Field	Type	Description
Currency	String	Currency Short Name
CurrencyLong	String	Currency Long Name
MinConfirmation	Integer	???
TxFee	Float	Tax Fee
IsActive	Boolean	Determines, whether it is active
CoinType	String	Coin Type
BaseAddress	String	Address of the base wallet of Bittrex
Notice	String?	Information about coin (why it's inactive etc)

getWalletHealth({currency?})

Used to get the detail information of a single coin. A specific currency can be requested.

Parameters:

Name	Type	Required	Description
currency	String	false	A string literal for the currency (ex: BTC). If omitted, will return for all currencies.

Response:

NOTE: If the currency is not specified - the result will be an Array of Health.

{
  Currency: 'BTC',
  DepositQueueDepth: 0,
  WithdrawQueueDepth: 8,
  BlockHeight: 532983,
  WalletBalance: 0,
  WalletConnections: 8,
  MinutesSinceBHUpdated: 2,
  LastChecked: '2018-07-21T20:41:38',
  IsActive: true
}

Explanation:

Field	Type	Description
Currency	String	???
DepositQueueDepth	Integer	???
WithdrawQueueDepth	Integer	???
BlockHeight	Integer	???
WalletBalance	Float	???
WalletConnections	Integer	???
MinutesSinceBHUpdated	Integer	???
LastChecked	ISODate	???
IsActive	Boolean	???

getMarkets()

Used to get the open and available trading markets at Bittrex along with other meta data.

Parameters: NONE

Response:

[
  {
    MarketName: 'BTC-LTC',
    IsActive: true,
    MinTradeSize: 0.01435906,
    Created: '2014-02-13T00:00:00',
    MarketCurrency: 'LTC',
    BaseCurrency: 'BTC',
    MarketCurrencyLong: 'Litecoin',
    BaseCurrencyLong: 'Bitcoin',
    Notice: null,
    IsSponsored: null,
    LogoUrl: 'https://bittrexblobstorage.blob.core.windows.net/public/6defbc41-582d-47a6-bb2e-d0fa88663524.png'
  },
  ...
]

Explanation:

Field	Type	Description
MarketName	String	BaseCurrency + MarketCurrency
IsActive	Boolean	Determines, whether market is active
MinTradeSize	Float	Minimum trade size
Created	ISODate	When Created
MarketCurrency	String	Market Currency Short Name
BaseCurrency	String	Base Currency Short Name
MarketCurrencyLong	String	Market Currency Long Name
BaseCurrencyLong	String	Base Currency Long Name
Notice	String?	Information about market (delisting etc)
LogoUrl	String	Url to icon of the coin

getMarketSummaries()

Used to get the last 24 hour summary and markets of all active markets.

Parameters: NONE

Response:

[
  {
    MarketName: 'BTC-LTC',
    Bid: 0.01133,
    Ask: 0.01133528,
    Low: 0.010969,
    High: 0.01144425,
    Last: 0.01133,
    Volume: 7991.64608454,
    BaseVolume: 89.31572617,
    TimeStamp: '2018-07-21T18:46:38.787',
    OpenBuyOrders: 774,
    OpenSellOrders: 3039,
    PrevDay: 0.01124658,
    Created: '2014-02-13T00:00:00'
  },
  ...
]

Explanation:

Field	Type	Description
MarketName	String	Market name
Bid	Float	Max price to sell
Ask	Float	Min price to buy
Low	Float	Minimum price for 24h
High	Float	Maximum price for 24h
Last	Float	Volume of market coin
Volume	Float	Last price
BaseVolume	Float	Volume of base coin (BTC)
TimeStamp	ISODate	Timestamp
OpenBuyOrders	Integer	Number of Open Buy Orders
OpenSellOrders	Integer	Number of Open Sell Orders
PrevDay	Float	Previous Date Price
Created	ISODate	When Created

getMarketSummary({marketName}) UNSTABLE!

getTicks({market,interval})

Used to get the candles for a market.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
interval	String	true	An interval of candles (1m, 5m, 30m, 1h, 1d)

Response:

[
  {
    O: 0.01225131,
    H: 0.01225377,
    L: 0.01225131,
    C: 0.01225377,
    V: 2.1254766,
    BV: 0.0260444,
    T: '2018-07-11T23:38:00'
  },
  ...
]

Explanation:

Field	Type	Description
O	Float	Open
C	Float	Close
L	Float	Low
H	Float	High
V	Float	Volume
BV	Float	Base volume
T	ISODate	Candle start date

getLatestTick({market,interval})

Used to get the last candle for a market.

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
interval	String	true	An interval of candles (1m, 5m, 30m, 1h, 1d)

Response:

{
  O: 0.01225131,
  H: 0.01225377,
  L: 0.01225131,
  C: 0.01225377,
  V: 2.1254766,
  BV: 0.0260444,
  T: '2018-07-11T23:38:00'
}

Explanation:

Field	Type	Description
O	Float	Open
C	Float	Close
L	Float	Low
H	Float	High
V	Float	Volume
BV	Float	Base volume
T	ISODate	Candle start date

buy({market,type,quantity,rate,immediate?,condition?,target?})

Used to place a buy order in a specific market. ???

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
type	String	true	LIMIT or MARKET
quantity	Float	true	The amount to purchase
rate	Float	true	The rate at which to place the order
immediate	Boolean	false	If true - order will be IOC, otherwise GTC (Default: false)
condition	Integer	false	0 - none, 1 - greater then, -1 - less then (Default: 0)
target	Float	false	(Default: 0)

Response:

{
  uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Identificator of the order

sell({market,type,quantity,rate,immediate?,condition?,target?})

Used to place a sell order in a specific market. ???

Parameters:

Name	Type	Required	Description
market	String	true	A string literal for the market (ex: BTC-LTC)
type	String	true	LIMIT or MARKET
quantity	Float	true	The amount to purchase
rate	Float	true	The rate at which to place the order
immediate	Boolean	false	If true - order will be IOC, otherwise GTC (Default: false)
condition	Integer	false	0 - none, 1 - greater then, -1 - less then (Default: 0)
target	Float	false	(Default: 0)

Response:

{
  uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}

Explanation:

Field	Type	Description
uuid	String	Identificator of the order

cancel({uuid})

Used to cancel an open order.

Parameters:

Name	Type	Required	Description
uuid	String	true	uuid of the order
market	String	false	A string literal for the market (ex: BTC-LTC). I don't sure that it's needed. But i found it in their scripts

Response:

null

getOrder({uuid})

Used to retrieve a single order by uuid.

Parameters:

Name	Type	Required	Description
uuid	String	true	uuid of the order

Response:

{
  AccountId: null,
  OrderUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  Exchange: 'USDT-BTC',
  Type: 'LIMIT_BUY',
  Quantity: 1,
  QuantityRemaining: 1,
  Limit: 1,
  Reserved: 1,
  ReserveRemaining: 1,
  CommissionReserved: 0.0025,
  CommissionReserveRemaining: 0.0025,
  CommissionPaid: 0,
  Price: 0,
  PricePerUnit: null,
  Opened: '2018-07-22T10:34:30.477',
  Closed: '2018-07-22T10:34:50.273',
  IsOpen: false,
  Sentinel: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  CancelInitiated: true,
  ImmediateOrCancel: false,
  IsConditional: false,
  Condition: 'NONE',
  ConditionTarget: null
}

Explanation:

Field	Type	Description
AccountId	String?	User uuid (always null)
OrderUuid	String	Order uuid
Exchange	String	String literal for the market
Type	String	Type of order: LIMIT_BUY or LIMIT_SELL. (Maybe also: MARKET_BUY or MARKET_SELL)
Quantity	Float	Total Quantity
QuantityRemaining	Float	Remaining Quantity
Limit	Float	Limit of Order
Reserved	Float	???
ReserveRemaining	Float	???
CommissionReserved	Float	???
CommissionReserveRemaining	Float	???
CommissionPaid	Float	Commission Paid
Price	Float	Order Price
PricePerUnit	Float?	Average Price Per Unit
Opened	ISODate	Date of opening order
Closed	ISODate?	Date of closing order (null if opened yet)
IsOpen	Boolean	???
Sentinel	String	???
CancelInitiated	Boolean	Determines, if Cancel was Initiated
ImmediateOrCancel	Boolean	Determines, if it is Immediate or Cancel Order
IsConditional	Boolean	Determines, if it is Conditional Order
Condition	String	NONE, GREATER_THAN or LESS_THAN
ConditionTarget	Float?	Condition Target, which is checked in Condition, if Condition is set.

getOpenOrders({market?})

Get all orders that you currently have opened. A specific market can be requested.

Parameters:

Name	Type	Required	Description
market	String	false	A string literal for the market (ex: BTC-LTC). If omitted, will return for all markets.

Response:

[
  {
    Uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Id: 1,
    OrderUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Exchange: 'USDT-BTC',
    OrderType: 'LIMIT_BUY',
    Quantity: 1,
    QuantityRemaining: 1,
    Limit: 1,
    CommissionPaid: 0,
    Price: 0,
    PricePerUnit: null,
    Opened: '2018-07-22T17:52:50.513',
    Closed: null,
    Updated: '2018-07-22T17:52:50.5155596',
    IsOpen: true,
    CancelInitiated: false,
    ImmediateOrCancel: false,
    IsConditional: false,
    Condition: 'NONE',
    ConditionTarget: null
  },
  ...
]

Explanation:

Field	Type	Description
Uuid	String	User uuid
Id	Integer	Integer order id
OrderUuid	String	Order uuid
Exchange	String	String literal for the market
OrderType	String	Type of order: LIMIT_BUY or LIMIT_SELL. (Maybe also: MARKET_BUY or MARKET_SELL)
Quantity	Float	Total Quantity
QuantityRemaining	Float	Remaining Quantity
Limit	Float	Limit of Order (Rate)
CommissionPaid	Float	Commission Paid
Price	Float	Order Price
PricePerUnit	Float?	Average Price Per Unit
Opened	ISODate	Date of opening order
Closed	ISODate?	Date of closing order (always null)
Updated	ISODate	Date of last updating
CancelInitiated	Boolean	Determines, if Cancel was Initiated
ImmediateOrCancel	Boolean	Determines, if it is Immediate or Cancel Order
IsConditional	Boolean	Determines, if it is Conditional Order
Condition	String	NONE, GREATER_THAN or LESS_THAN
ConditionTarget	Float?	Condition Target, which is checked in Condition, if Condition is set.

getCloseOrder({market?})

Used to retrieve user order history. A specific market can be requested.

Parameters:

Name	Type	Required	Description
market	String	false	A string literal for the market (ex: BTC-LTC). If omitted, will return for all markets.

Response:

[
  {
    OrderUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Exchange: 'USDT-BTC',
    OrderType: 'LIMIT_SELL',
    Quantity: 0.00679265,
    QuantityRemaining: 0,
    Limit: 7350,
    Commission: 0.12481494,
    Price: 49.9259775,
    PricePerUnit: 7350,
    TimeStamp: '2018-07-17T22:11:38.367',
    Closed: '2018-07-17T22:12:40.243',
    IsConditional: false,
    ImmediateOrCancel: false,
    Condition: 'NONE',
    ConditionTarget: null
  },
  ...
]

Explanation:

Field	Type	Description
OrderUuid	String	Order uuid
Exchange	String	String literal for the market
OrderType	String	Type of order: LIMIT_BUY or LIMIT_SELL.
Quantity	Float	Total Quantity
QuantityRemaining	Float	Remaining Quantity
Limit	Float	Limit of Order (Rate)
Commission	Float	Commission Paid
Price	Float	Order Price
PricePerUnit	Float?	Average Price Per Unit
TimeStamp	ISODate	Date of opening order
Closed	ISODate	Date of closing order
CancelInitiated	Boolean	Determines, if Cancel was Initiated
ImmediateOrCancel	Boolean	Determines, if it is Immediate or Cancel Order
IsConditional	Boolean	Determines, if it is Conditional Order
Condition	String	NONE, GREATER_THAN or LESS_THAN
ConditionTarget	Float?	Condition Target, which is checked in Condition, if Condition is set.

getBalances({currency?})

Used to retrieve all balances from your account with markets. A specific currency can be requested.

Parameters:

Name	Type	Required	Description
currency	String	false	A string literal for the currency (ex: BTC). If omitted, will return for all currencies.

Response:

NOTE: If the currency is not specified - the result will be an Array of Currency.

{
  Uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  AccountId: 1,
  Currency: 'USDT',
  Balance: 1,
  Available: 1,
  Pending: 0,
  CryptoAddress: null,
  Requested: false,
  Updated: '2018-07-13T13:04:27.793',
  AutoSell: null
}

Explanation:

Field	Type	Description
Uuid	String	User uuid
Id	Integer	Integer user id
Currency	String	Currency
Balance	Float	All money including on orders
Available	Float	Only free money
Pending	Float	Money on pending
CryptoAddress	String?	Address (null if not generated yet)
Requested	Boolean?	??? (null or true)
Updated	ISODate?	Last date of updating
AutoSell	Boolean?	Is turned on autoselling (null or true)

getDepositAddress({currency})

Used to retrieve or generate an address for a specific currency. If one does not exist, the call will throw ADDRESS_GENERATING until one is available.

Parameters:

Name	Type	Required	Description
currency	String	true	A string literal for the currency (ex: BTC)

Response:

{
  Currency: 'BTC',
  Address: '1K8KAxNBXEnYcMQitTAtZEXdVhmtPzYqSb',
  BaseAddress: '1N52wHoVR79PMDishab2XmRHsbekCdGquK'
}

Explanation:

Field	Type	Description
Currency	String	Currency title
CryptoAddress	String	Address of wallet
BaseAddress	String	Address of the base wallet of Bittrex

UNKNOWN getFiatAddresses({currency})

withdraw({currency,quantity,address,paymentId?,2fa?})

Used to withdraw funds from your account. Note: account for tax fee.

Parameters:

Name	Type	Required	Description
currency	String	true	A string literal for the currency (ex: BTC)
quantity	Float	true	The quantity of coins to withdraw
address	String	true	The address where to send the funds
paymentid	String	false	Used for CryptoNotes/BitShareX/Nxt optional field (memo/paymentid)
2fa	String	false	Two-factor authentication code

Response:

{
  WithdrawalId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  Currency: 'BTC',
  Quantity: 1
}

Explanation:

Field	Type	Description
WithdrawalId	String	Uuid of action
Currency	String	Currency name
Quantity	Float	Amount of coins

getDepositHistory()

???

Parameters: NONE

Response:

[
  {
    Id: 1,
    Amount: 0.1,
    Currency: 'BTC',
    Confirmations: 2,
    LastUpdated: '2017-08-07T13:47:06.513',
    CryptoAddress: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
    TxId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  },
  ...
]

Explanation:

Field	Type	Description

getWithdrawalHistory()

???

Parameters: NONE

Response:

[
  {
    PaymentUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Currency: 'GRC',
    Amount: 0.8,
    Address: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    Opened: '2018-07-23T12:03:10.16',
    Authorized: true,
    PendingPayment: false,
    TxCost: 0.2,
    TxId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    Canceled: false,
    InvalidAddress: false
  },
  ...
]

Explanation:

Field	Type	Description

getPendingDeposits()

???

Parameters: NONE

Response:

[
  {
    Currency: 'GRC',
    Amount: 1,
    Confirmations: 1,
    MinConfirmation: 2,
    LastUpdated: '2018-07-23T12:03:10.16',
    CryptoAddress: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    TxId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    ???
  },
  ...
]

Explanation:

Field	Type	Description

getPendingWithdrawals()

???

Parameters: NONE

Response:

[
  {
    PaymentUuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    Currency: 'GRC',
    Amount: 0.8,
    Address: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    Opened: '2018-07-23T12:03:10.16',
    Authorized: true,
    PendingPayment: false,
    InvalidAddress: false
  },
  ...
]

Explanation:

Field	Type	Description