API Reference API Reference

Bittrex provides a simple and powerful API consisting of REST endpoints for transactional operations and a complementary Websocket service providing streaming market, order, and balance updates.

Access to and use of the API is governed by our Terms of Service. If you are a user of Bittrex.com, the applicable Terms of Service are available here. If you are a user of Bittrex International, the applicable Terms of Service are available here.

If you have any API questions, feedback, or recommendations please post a question via our Github page

API Endpoint
https://api.bittrex.com/api/v1.1
Response Content-Types: application/json
Schemes: https
Version: v1.1

Getting Started

Keep the following in mind when developing against the Bittrex API:

  • Enable 2FA on your account. API Keys cannot be generated unless 2FA is enabled.
  • All REST requests must be sent to https://api.bittrex.com/api/v1.1 using the application/json content type. Non-HTTPS requests will be redirected to HTTPS, possibly causing functional or performance issues with your application.
  • All REST requests will result in a 200 Ok response unless there is a server or infrastructure error. The API result will be wrapped in a JSON Result object, where the success field indicates response status.
  • The public REST API (https://api.bittrex.com/api/v1.1/public) does not require authentication, all other requests require an API Key and must be properly signed.

Best Practices

Call Limits

The Bittrex API employs call limits on all endpoints to ensure the efficiency and availability of the platform for all customers. In general, API users are permitted to make a maximum of 60 API calls per minute. Calls after the limit will fail, with the limit resetting at the start of the next minute.

Note: Corporate and high-volume accounts may contact customer support for additional information to ensure that they may continue operating at an optimal level.

Example: Many users poll the REST API as quickly as possible for updated order data. At very high call rates, the API most often returns the same data because we only update it once per second. By using the Websocket API's QueryExchangeState and SubscribeToExchangeDeltas functions, developers can maintain their own copies of one or more order books.


Socket Connections

Websocket connections may occasionally need to be recycled. If, for example, you're maintinaing local order book state, and you stop receiving updates even though you know trade activity is occurring, it may be time to resynchronize.

Because v1.1 websocket nonces are server-specific, it's crucial to maintain state on a per-connection basis. For example, to resychronize the BTC-ETH market order book:

  1. Drop existing websocket connections and flush accumulated data and state (e.g. market nonces).
  2. Re-establish websocket connection.
  3. Subscribe to BTC-ETH market deltas, cache received data keyed by nonce.
  4. Query BTC-ETH market state.
  5. Apply cached deltas sequentially, starting with nonces greater than that received in step 4.

Authentication

API Keys

Authenticating to the Bittrex API requires a valid API Key. API Keys have scoped permissions:

  • Read Info - You can only view the balances, orders, and other details of the account
  • Withdraw - We allow you to programatically withdraw any currency to an address you provide. This can be used to quick arbitrage exchanges or move money into cold storage after thresholds.
  • Trade Limit - This allows the API key to place LIMIT buy and sell orders.

If you have enabled 2FA you can check existing or generate new API Keys with the appropriate permissions under Manage API Keys. We strongly recommend minimizing the scope of any given API key to limit the damage done by a leaked key/secret pair.


Request Signing

When required, use the following procedure to sign an API request using a message value generated for the REST or Websocket API as detailed below:

  1. Create a SHA512 HMAC using your API Key secret and the API-specific message value.
  2. Include the resulting hash in your request:
    • REST: in the apisign request header
    • Websocket: passed to the Authenticate call

REST Message

The message value is obtained by concatenating the full request URL including any query-string parameters, your public API Key, and a user-generated nonce (we recommend a UNIX-style timestamp in epoch millisecond format). Below are sample values for the message and secret as well as the HMAC yielded if you've done everything correctly:

 message: https://api.bittrex.com/api/v1.1/path/call?param=value&apikey=0123456789&nonce=1542020339856
 secret: ABCDEFGHIJ 
 hash: FC70DD6467C916FBAA14EB89942644F9CF3F4CBF179923EE677413DC2E1CF2D8C5AA60C85A0A0BB3174960B8AA4FCFB0BC20CDE19BF21D567C671811C52CE631

Websocket Message

The message value is obtained by calling the Websocket GetAuthContext API. Below are sample values for the message and secret as well as the HMAC yielded if you've done everything correctly.

 message: top-secret-and-totally-fake
 secret: ABCDEFGHIJ
 hash: 77FF28CAEDCD944F5E6F0F5DD16B1FFDFC7D5A589B7F2DE4CF722F81EE5580652FA3C85D1EDDE9F497F5B6C792A93DBDBFB9E649D3F9FD7AEBC304C41AA68061

javascript const Crypto = require('crypto'); const message = 'https://api.bittrex.com/api/v1.1/path/call?param=value&apikey=0123456789&nonce=1542020339856'; const secret = 'ABCDEFGHIJ'; const signature = Crypto.createHmac('sha512', secret) .update(message) .digest('hex');

REST API

GET /public/getmarkets

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

Request Url Example
https://api.bittrex.com/api/v1.1/public/getmarkets
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "MarketCurrency": "LTC",
      "BaseCurrency": "BTC",
      "MarketCurrencyLong": "Litecoin",
      "BaseCurrencyLong": "Bitcoin",
      "MinTradeSize": 0.01,
      "MarketName": "BTC-LTC",
      "IsActive": true,
      "IsRestricted": false,
      "Created": "2014-02-13T00:00:00",
      "Notice": "BTC-LTC",
      "IsSponsored": false,
      "LogoUrl": "https://storage.blob.core.windows.net/public/8637ccad-9e7f-45ac-8f03-a41b440e3911.png"
    }
  ]
}

GET /public/getcurrencies

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

Request Url Example
https://api.bittrex.com/api/v1.1/public/getcurrencies
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Currency": "BTC",
      "CurrencyLong": "Bitcoin",
      "CoinType": "BITCOIN",
      "MinConfirmation": 2,
      "TxFee": 0.002,
      "IsActive": true,
      "IsRestricted": false,
      "BaseAddress": null
    }
  ]
}

GET /public/getticker

Used to get the current tick values for a market.

market: string
in query

a string literal for the market (ex: BTC-LTC)

Request Url Example
https://api.bittrex.com/api/v1.1/public/getticker?market=BTC-LTC
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Bid": 2.05670368,
      "Ask": 3.35579531,
      "Last": 3.35579531
    }
  ]
}

GET /public/getmarketsummaries

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

Request Url Example
https://api.bittrex.com/api/v1.1/public/getmarketsummaries
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "MarketName": "BTC-LTC",
      "High": 0.0135,
      "Low": 0.012,
      "Volume": 3833.97619253,
      "Last": 0.01349998,
      "BaseVolume": 47.03987026,
      "TimeStamp": "2014-07-09T07:22:16.72",
      "Bid": 0.01271001,
      "Ask": 0.012911,
      "OpenBuyOrders": 45,
      "OpenSellOrders": 45,
      "PrevDay": 0.01229501,
      "Created": "2014-02-13T00:00:00",
      "DisplayMarketName": "string"
    }
  ]
}

GET /public/getmarketsummary

Used to get the last 24 hour summary of a specific market.

market: string
in query

a string literal for the market (ex: BTC-LTC)

Request Url Example
https://api.bittrex.com/api/v1.1/public/getmarketsummary?market=btc-ltc
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "MarketName": "BTC-LTC",
      "High": 0.0135,
      "Low": 0.012,
      "Volume": 3833.97619253,
      "Last": 0.01349998,
      "BaseVolume": 47.03987026,
      "TimeStamp": "2014-07-09T07:22:16.72",
      "Bid": 0.01271001,
      "Ask": 0.012911,
      "OpenBuyOrders": 45,
      "OpenSellOrders": 45,
      "PrevDay": 0.01229501,
      "Created": "2014-02-13T00:00:00",
      "DisplayMarketName": "string"
    }
  ]
}

GET /public/getorderbook

Used to get retrieve the orderbook for a given market.

market: string
in query

a string literal for the market (ex: BTC-LTC)

type: string
in query

buy, sell or both to identify the type of orderbook to return

Request Url Example
https://api.bittrex.com/api/v1.1/public/getorderbook?market=BTC-LTC&type=both
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "buy": [
        {
          "quantity": 12.37,
          "rate": 32.55412402
        }
      ],
      "sell": [
        {
          "quantity": 12.37,
          "rate": 32.55412402
        }
      ]
    }
  ]
}

GET /public/getmarkethistory

Used to retrieve the latest trades that have occurred for a specific market.

market: string
in query

a string literal for the market (ex: BTC-LTC)

Request Url Example
https://api.bittrex.com/api/v1.1/public/getmarkethistory?market=BTC-DOGE
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Id": 319435,
      "TimeStamp": "2014-07-09T03:21:20.08",
      "Quantity": 0.30802438,
      "Price": 0.012634,
      "Total": 0.00389158,
      "FillType": "FILL",
      "OrderType": "BUY"
    }
  ]
}

GET /market/buylimit

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.

market: string
in query

a string literal for the market (ex: BTC-LTC)

quantity: decimal
in query

the amount to purchase

rate: decimal
in query

the rate at which to place the order

timeInForce: string
in query

[IOC ,GTC]

Request Url Example
https://api.bittrex.com/api/v1.1/market/buylimit?apikey=API_KEY&market=BTC-LTC&quantity=1.2&rate=1.3

Success

Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": {
    "uuid": "614c34e4-8d71-11e3-94b5-425861b86ab6"
  }
}

GET /market/selllimit

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.

market: string
in query

a string literal for the market (ex: BTC-LTC)

quantity: decimal
in query

the amount to purchase

rate: decimal
in query

the rate at which to place the order

timeInForce: string
in query

[IOC ,GTC]

Request Url Example
https://api.bittrex.com/api/v1.1/market/selllimit?apikey=API_KEY&market=BTC-LTC&quantity=1.2&rate=1.3

Success

Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": {
    "uuid": "614c34e4-8d71-11e3-94b5-425861b86ab6"
  }
}

GET /market/cancel

Used to cancel a buy or sell order.

uuid: string
in query

uuid of buy or sell order

Request Url Example
https://api.bittrex.com/api/v1.1/market/cancel?apikey=API_KEY&uuid=ORDER_UUID

Success

Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": {
    "uuid": "614c34e4-8d71-11e3-94b5-425861b86ab6"
  }
}

GET /market/getopenorders

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

market: string
in query

a string literal for the market (ie. BTC-LTC)

Request Url Example
https://api.bittrex.com/api/v1.1/market/getopenorders?apikey=API_KEY&market=BTC-LTC
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Uuid": "string (uuid)",
      "OrderUuid": "8925d746-bc9f-4684-b1aa-e507467aaa99",
      "Exchange": "BTC-LTC",
      "OrderType": "string",
      "Quantity": 100000,
      "QuantityRemaining": 100000,
      "Limit": 1e-8,
      "CommissionPaid": 0,
      "Price": 0,
      "PricePerUnit": null,
      "Opened": "2014-07-09T03:55:48.583",
      "Closed": null,
      "CancelInitiated": "boolean",
      "ImmediateOrCancel": "boolean",
      "IsConditional": "boolean"
    }
  ]
}

GET /account/getbalances

Used to retrieve all balances from your account.

Request Url Example
https://api.bittrex.com/api/v1.1/account/getbalances?apikey=API_KEY
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Currency": "DOGE",
      "Balance": 4.21549076,
      "Available": 4.21549076,
      "Pending": 0,
      "CryptoAddress": "DLxcEt3AatMyr2NTatzjsfHNoB9NT62HiF",
      "Requested": false,
      "Uuid": null
    }
  ]
}

GET /account/getbalance

Used to retrieve the balance from your account for a specific currency.

currency: string
in query

a string literal for the currency (ie. BTC)

Request Url Example
https://api.bittrex.com/api/v1.1/account/getbalance?apikey=API_KEY&currency=BTC
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": {
    "Currency": "DOGE",
    "Balance": 4.21549076,
    "Available": 4.21549076,
    "Pending": 0,
    "CryptoAddress": "DLxcEt3AatMyr2NTatzjsfHNoB9NT62HiF",
    "Requested": false,
    "Uuid": null
  }
}

GET /account/getdepositaddress

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

currency: string
in query

a string literal for the currency (ie. BTC)

Request Url Example
https://api.bittrex.com/api/v1.1/account/getdepositaddress?apikey=API_KEY&currency=BTC
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Currency": "VTC",
      "Address": "Vy5SKeKGXUHKS2WVpJ76HYuKAu3URastUo"
    }
  ]
}

GET /account/withdraw

Used to withdraw funds from your account. Note: please account for txfee.

currency: string
in query

a string literal for the currency (ie. BTC)

quantity: decimal
in query

the quantity of coins to withdraw

address: string
in query

the address where to send the funds

paymentid: string
in query

used for CryptoNotes/BitShareX/Nxt/XRP and any other coin that has a memo/message/tag/paymentid option

Request Url Example
https://api.bittrex.com/api/v1.1/account/withdraw?apikey=API_KEY&currency=EAC&quantity=20.40&address=EAC_ADDRESS

Success

Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": {
    "uuid": "614c34e4-8d71-11e3-94b5-425861b86ab6"
  }
}

GET /account/getorder

Used to retrieve a single order by uuid

uuid: string
in query

the uuid of the buy or sell order

Request Url Example
https://api.bittrex.com/api/v1.1/account/getorder&uuid=0cb4c4e4-bdc7-4e13-8c13-430e587d2cc1
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Uuid": "string (uuid)",
      "OrderUuid": "8925d746-bc9f-4684-b1aa-e507467aaa99",
      "Exchange": "BTC-LTC",
      "OrderType": "string",
      "Quantity": 100000,
      "QuantityRemaining": 100000,
      "Limit": 1e-8,
      "CommissionPaid": 0,
      "Price": 0,
      "PricePerUnit": null,
      "Opened": "2014-07-09T03:55:48.583",
      "Closed": null,
      "CancelInitiated": "boolean",
      "ImmediateOrCancel": "boolean",
      "IsConditional": "boolean"
    }
  ]
}

GET /account/getorderhistory

Used to retrieve your order history.

market: string
in query

a string literal for the market (ie. BTC-LTC). If omitted, will return for all markets

Request Url Example
https://api.bittrex.com/api/v1.1/account/getorderhistory
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "OrderUuid": "fd97d393-e9b9-4dd1-9dbf-f288fc72a185",
      "Exchange": "BTC-LTC",
      "TimeStamp": "string (date-time)",
      "OrderType": "string",
      "Limit": 1e-8,
      "Quantity": 667.03644955,
      "QuantityRemaining": 0,
      "Commission": 0.00004921,
      "Price": 0.01968424,
      "PricePerUnit": 0.0000295,
      "IsConditional": false,
      "Condition": "",
      "ConditionTarget": 0,
      "ImmediateOrCancel": false,
      "Closed": "2014-02-13T00:00:00"
    }
  ]
}

GET /account/getwithdrawalhistory

Used to retrieve your withdrawal history.

currency: string
in query

a string literal for the currency (ie. BTC). If omitted, will return for all currencies

Request Url Example
https://api.bittrex.com/api/v1.1/account/getwithdrawalhistory
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "PaymentUuid": "b52c7a5c-90c6-4c6e-835c-e16df12708b1",
      "Currency": "BTC",
      "Amount": 17,
      "Address": "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
      "Opened": "2014-07-09T04:24:47.217",
      "Authorized": "boolean",
      "PendingPayment": "boolean",
      "TxCost": 0.0002,
      "TxId": "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e",
      "Canceled": "boolean",
      "InvalidAddress": "boolean"
    }
  ]
}

GET /account/getdeposithistory

Used to retrieve your deposit history.

currency: object
in query

a string literal for the currency (ie. BTC). If omitted, will return for all currencies

Request Url Example
https://api.bittrex.com/api/v1.1/account/getdeposithistory?currency=BTC
200 OK

Success

type
object
Response Example (200 OK)
{
  "success": true,
  "message": "''",
  "result": [
    {
      "Id": 1,
      "Amount": 2.12345678,
      "Currency": "BTC",
      "Confirmations": 2,
      "LastUpdated": "2014-02-13T07:38:53.883",
      "TxId": "e26d3b33fcfc2cb0c74d0938034956ea590339170bf4102f080eab4b85da9bde",
      "CryptoAddress": "15VyEAT4uf7ycrNWZVb1eGMzrs21BH95Va"
    }
  ]
}

Websocket API

GetAuthContext

Generates a challenge developers can sign and use in the Authenticate call to verify their identity and begin receiving account-level notifications.

apiKey: string

a valid API key for your account

Request Url Example
https://socket.bittrex.com/signalr
Success

A string of challenge data to be used in Authenticate

type
string

Authenticate

Verifies a user's identity to the server and begins receiving account-level notifications. Users must sign the challenge returned by GetAuthContext before calling this function. To receive the account-level notifications enabled by authenticating, the caller must register callbacks for the uO and uB events through their SignalR client.

apiKey: string

a valid API key for your account

response: string

signed challenge from GetAuthContext

Request Url Example
https://socket.bittrex.com/signalr
Success

Boolean indication of success or failure

type
boolean
Balance Callback
Order Callback

QueryExchangeState

Allows the caller to retrieve the full order book for a specific market.

market: string

the market identifier (e.g. BTC-ETH)

Request Url Example
https://socket.bittrex.com/signalr
Success

JSON object containing market state

type
object

QuerySummaryState

Allows the caller to retrieve the full state for all markets.

market: string

the market identifier (e.g. BTC-ETH)

Request Url Example
https://socket.bittrex.com/signalr
Success

JSON object containing state data for all markets.

type
object

SubscribeToExchangeDeltas

Allows the caller to receive real-time updates to the state of a single market. The caller must register a callback for the uE event through their SignalR client. Upon subscribing, the callback will be invoked with market deltas as they occur.

Note: This feed only contains updates to exchange state. To form a complete picture of exchange state, users must first call QueryExchangeState and merge deltas into the data structure returned in that call.

marketName: string

the market identifier (e.g. BTC-ETH)

Request Url Example
https://socket.bittrex.com/signalr
Success

Boolean indicating whether the user was subscribed to the feed

type
boolean

SubscribeToSummaryDeltas

Allows the caller to receive real-time updates to the state of all markets. The caller must register a callback for the uS event through their SignalR client. Upon subscribing, the callback will be invoked with market deltas as they occur.

Note: Summary delta callbacks are verbose. A subset of the same data limited to the market name, the last price, and the base currency volume can be obtained via SubscribeToSummaryLiteDeltas just use uL instead of uS.

Request Url Example
https://socket.bittrex.com/signalr
Success

Boolean indicating whether the user was subscribed to the feed.

type
boolean

SubscribeToSummaryLiteDeltas

Allows the caller to receive real-time updates to the state of all markets. The caller must register a callback for the uL event through their SignalR client. Upon subscribing, the callback will be invoked with market deltas as they occur.

Request Url Example
https://socket.bittrex.com/signalr
Success

Boolean indicating whether the user was subscribed to the feed.

type
boolean

Schema Definitions

Result

The object that wraps an API response, where the success field indicates response status.

success: boolean
message: string
result: any
Example
{
  "success": true,
  "message": "''",
  "result": "any"
}

Address

Currency: string
Address: string
Example
{
  "Currency": "VTC",
  "Address": "Vy5SKeKGXUHKS2WVpJ76HYuKAu3URastUo"
}

Balance

Currency: string
Balance: number (double)
Available: number (double)
Pending: number (double)
CryptoAddress: string
Requested: boolean
Uuid: string
Example
{
  "Currency": "DOGE",
  "Balance": 4.21549076,
  "Available": 4.21549076,
  "Pending": 0,
  "CryptoAddress": "DLxcEt3AatMyr2NTatzjsfHNoB9NT62HiF",
  "Requested": false,
  "Uuid": null
}

Currency

Currency: string
CurrencyLong: string
CoinType: string ADA, ANTSHARES, BITCOIN, BITCOIN_STEALTH, BITSHAREX, CRYPTO_NOTE_PAYMENTID, ETH, ETH_CONTRACT, FIAT, LISK, LUMEN, NEM, NXT, OMNI, RIPPLE, STEEM, TRON, WAVES, WAVES_ASSET
MinConfirmation: integer (int32)
TxFee: number (double)
IsActive: boolean
IsRestricted: boolean
BaseAddress: string
Example
{
  "Currency": "BTC",
  "CurrencyLong": "Bitcoin",
  "CoinType": "BITCOIN",
  "MinConfirmation": 2,
  "TxFee": 0.002,
  "IsActive": true,
  "IsRestricted": false,
  "BaseAddress": null
}

HistoryEntry

OrderUuid: string (uuid)
Exchange: string
TimeStamp: string (date-time)
OrderType: string BUY_LIMIT, SELL_LIMIT
Limit: number (double)
Quantity: number (double)
QuantityRemaining: number (double)
Commission: number (double)
Price: number (double)
PricePerUnit: number (double)
IsConditional: boolean
Condition: string
ConditionTarget: number
ImmediateOrCancel: boolean
Closed: string (date-time)
Example
{
  "OrderUuid": "fd97d393-e9b9-4dd1-9dbf-f288fc72a185",
  "Exchange": "BTC-LTC",
  "TimeStamp": "string (date-time)",
  "OrderType": "string",
  "Limit": 1e-8,
  "Quantity": 667.03644955,
  "QuantityRemaining": 0,
  "Commission": 0.00004921,
  "Price": 0.01968424,
  "PricePerUnit": 0.0000295,
  "IsConditional": false,
  "Condition": "",
  "ConditionTarget": 0,
  "ImmediateOrCancel": false,
  "Closed": "2014-02-13T00:00:00"
}

Market

MarketCurrency: string
BaseCurrency: string
MarketCurrencyLong: string
BaseCurrencyLong: string
MinTradeSize: number (double)
MarketName: string
IsActive: boolean
IsRestricted: boolean
Created: string (date-time)
Notice: string
IsSponsored: boolean
LogoUrl: string
Example
{
  "MarketCurrency": "LTC",
  "BaseCurrency": "BTC",
  "MarketCurrencyLong": "Litecoin",
  "BaseCurrencyLong": "Bitcoin",
  "MinTradeSize": 0.01,
  "MarketName": "BTC-LTC",
  "IsActive": true,
  "IsRestricted": false,
  "Created": "2014-02-13T00:00:00",
  "Notice": "BTC-LTC",
  "IsSponsored": false,
  "LogoUrl": "https://storage.blob.core.windows.net/public/8637ccad-9e7f-45ac-8f03-a41b440e3911.png"
}

MarketTick

Bid: number (double)
Ask: number (double)
Last: number (double)
Example
{
  "Bid": 2.05670368,
  "Ask": 3.35579531,
  "Last": 3.35579531
}

MarketSummary

MarketName: string
High: number (double)
Low: number (double)
Volume: number (double)
Last: number (double)
BaseVolume: number (double)
TimeStamp: string (date-time)
Bid: number (double)
Ask: number (double)
OpenBuyOrders: integer (int32)
OpenSellOrders: integer (int32)
PrevDay: number (double)
Created: string (date-time)
DisplayMarketName: string
Example
{
  "MarketName": "BTC-LTC",
  "High": 0.0135,
  "Low": 0.012,
  "Volume": 3833.97619253,
  "Last": 0.01349998,
  "BaseVolume": 47.03987026,
  "TimeStamp": "2014-07-09T07:22:16.72",
  "Bid": 0.01271001,
  "Ask": 0.012911,
  "OpenBuyOrders": 45,
  "OpenSellOrders": 45,
  "PrevDay": 0.01229501,
  "Created": "2014-02-13T00:00:00",
  "DisplayMarketName": "string"
}

Order

Uuid: string (uuid)
OrderUuid: string (uuid)
Exchange: string
OrderType: string LIMIT_BUY, LIMIT_SELL
Quantity: number (double)
QuantityRemaining: number (double)
Limit: number (double)
CommissionPaid: number (double)
Price: number (double)
PricePerUnit: number (double)
Opened: string (date-time)
Closed: boolean
CancelInitiated: boolean
ImmediateOrCancel: boolean
IsConditional: boolean
Condition: object
ConditionTarget: object
Example
{
  "Uuid": "string (uuid)",
  "OrderUuid": "8925d746-bc9f-4684-b1aa-e507467aaa99",
  "Exchange": "BTC-LTC",
  "OrderType": "string",
  "Quantity": 100000,
  "QuantityRemaining": 100000,
  "Limit": 1e-8,
  "CommissionPaid": 0,
  "Price": 0,
  "PricePerUnit": null,
  "Opened": "2014-07-09T03:55:48.583",
  "Closed": null,
  "CancelInitiated": "boolean",
  "ImmediateOrCancel": "boolean",
  "IsConditional": "boolean"
}

OrderBook

Example
{
  "buy": [
    {
      "quantity": 12.37,
      "rate": 32.55412402
    }
  ],
  "sell": [
    {
      "quantity": 12.37,
      "rate": 32.55412402
    }
  ]
}

OrderBookEntry

quantity: number (double)
rate: number (double)
Example
{
  "quantity": 12.37,
  "rate": 32.55412402
}

MarketHistoryEntry

Id: integer (int32)
TimeStamp: string (date-time)
Quantity: number (double)
Price: number (double)
Total: number (double)
FillType: string
OrderType: string
Example
{
  "Id": 319435,
  "TimeStamp": "2014-07-09T03:21:20.08",
  "Quantity": 0.30802438,
  "Price": 0.012634,
  "Total": 0.00389158,
  "FillType": "FILL",
  "OrderType": "BUY"
}

DepositHistoryEntry

Id: number (integer)
Amount: number (double)
Currency: string
Confirmations: number
LastUpdated: string (date-time)
TxId: string
CryptoAddress: string
Example
{
  "Id": 1,
  "Amount": 2.12345678,
  "Currency": "BTC",
  "Confirmations": 2,
  "LastUpdated": "2014-02-13T07:38:53.883",
  "TxId": "e26d3b33fcfc2cb0c74d0938034956ea590339170bf4102f080eab4b85da9bde",
  "CryptoAddress": "15VyEAT4uf7ycrNWZVb1eGMzrs21BH95Va"
}

WithdrawalHistoryEntry

PaymentUuid: string (uuid)
Currency: string
Amount: number (double)
Address: string
Opened: string (date-time)
Authorized: boolean
PendingPayment: boolean
TxCost: number (double)
TxId: string
Canceled: boolean
InvalidAddress: boolean
Example
{
  "PaymentUuid": "b52c7a5c-90c6-4c6e-835c-e16df12708b1",
  "Currency": "BTC",
  "Amount": 17,
  "Address": "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
  "Opened": "2014-07-09T04:24:47.217",
  "Authorized": "boolean",
  "PendingPayment": "boolean",
  "TxCost": 0.0002,
  "TxId": "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e",
  "Canceled": "boolean",
  "InvalidAddress": "boolean"
}

ResponseSuccessUuid

Example
{
  "success": true,
  "message": "''",
  "result": {
    "uuid": "614c34e4-8d71-11e3-94b5-425861b86ab6"
  }
}

Balance Delta - uB

Callback For

Authenticate

Example
{
  "Nonce": "int",
  "Delta": {
    "Uuid": "string (uuid)",
    "AccountId": "int",
    "Currency": "string",
    "Balance": "decimal",
    "Available": "decimal",
    "Pending": "decimal",
    "CryptoAddress": "string",
    "Requested": "bool",
    "Updated": "date",
    "AutoSell": "bool"
  }
}

Market Delta - uE

Callback For

SubscribeToExchangeDeltas

Note: The Type key can be one of the following values: 0 = ADD, 1 = REMOVE, 2 = UPDATE

Example
{
  "MarketName": "string",
  "Nonce": "int",
  "Buys": [
    {
      "Type": "int",
      "Rate": "decimal",
      "Quantity": "decimal"
    }
  ],
  "Sells": [
    {
      "Type": "int",
      "Rate": "decimal",
      "Quantity": "decimal"
    }
  ],
  "Fills": [
    {
      "FillId": "int",
      "OrderType": "string",
      "Rate": "decimal",
      "Quantity": "decimal",
      "TimeStamp": "date"
    }
  ]
}

Lite Summary Delta - uL

Example
{
  "Deltas": [
    {
      "MarketName": "string",
      "Last": "decimal",
      "BaseVolume": "decimal"
    }
  ]
}

Order Delta - uO

Callback For

Authenticate

Note: The Type key can be one of the following values: 0 = OPEN, 1 = PARTIAL, 2 = FILL, 3 = CANCEL

Example
{
  "AccountUuid": "string (uuid)",
  "Nonce": "int",
  "Type": "int",
  "Order": {
    "Uuid": "string (uuid)",
    "OrderUuid": "string (uuid)",
    "Id": "long",
    "Exchange": "string",
    "OrderType": "string",
    "Quantity": "decimal",
    "QuantityRemaining": "decimal",
    "Limit": "decimal",
    "CommissionPaid": "decimal",
    "Price": "decimal",
    "PricePerUnit": "decimal",
    "Opened": "date",
    "Closed": "date",
    "IsOpen": "bool",
    "CancelInitiated": "bool",
    "ImmediateOrCancel": "bool",
    "IsConditional": "bool",
    "Condition": "string",
    "ConditionTarget": "decimal",
    "Updated": "date"
  }
}

Summary Delta - uS

Example
{
  "Nonce": "int",
  "Delta": {
    "MarketName": "string",
    "High": "decimal",
    "Low": "decimal",
    "Volume": "decimal",
    "Last": "decimal",
    "BaseVolume": "decimal",
    "TimeStamp": "date",
    "Bid": "decimal",
    "Ask": "decimal",
    "OpenBuyOrders": "int",
    "OpenSellOrders": "int",
    "PrevDay": "decimal",
    "Created": "date"
  }
}

Minified JSON Keys

`A` = `Ask`
`a` = `Available`
`B` = `Bid`
`b` = `Balance`
`C` = `Closed`
`c` = `Currency`
`CI` = `CancelInitiated`
`D` = `Deltas`
`d` = `Delta`
`DT` = `OrderDeltaType`
`E` = `Exchange`
`e` = `ExchangeDeltaType`
`F` = `FillType`
`FI` = `FillId`
`f` = `Fills`
`G` = `OpenBuyOrders`
`g` = `OpenSellOrders`
`H` = `High`
`h` = `AutoSell`
`I` = `Id`
`i` = `IsOpen`
`J` = `Condition`
`j` = `ConditionTarget`
`K` = `ImmediateOrCancel`
`k` = `IsConditional`
`L` = `Low`
`l` = `Last`
`M` = `MarketName`
`m` = `BaseVolume`
`N` = `Nonce`
`n` = `CommissionPaid`
`O` = `Orders`
`o` = `Order`
`OT` = `OrderType`
`OU` = `OrderUuid`
`P` = `Price`
`p` = `CryptoAddress`
`PD` = `PrevDay`
`PU` = `PricePerUnit`
`Q` = `Quantity`
`q` = `QuantityRemaining`
`R` = `Rate`
`r` = `Requested`
`S` = `Sells`
`s` = `Summaries`
`T` = `TimeStamp`
`t` = `Total`
`TY` = `Type`
`U` = `Uuid`
`u` = `Updated`
`V` = `Volume`
`W` = `AccountId`
`w` = `AccountUuid`
`X` = `Limit`
`x` = `Created`
`Y` = `Opened`
`y` = `State`
`Z` = `Buys`
`z` = `Pending`
Example