Bittrex.API

Overview

Bittrex provides a simple and powerful REST API to allow you to programmatically perform nearly all actions you can from our web interface.

All requests use the application/json content type and go over HTTPS. The base url is https://bittrex.com/api/{version}/.

All requests are GET requests and all responses come in a default response object with the result in the result field. Always check the success flag to ensure that your API call succeeded.

We are currently restricting orders to 500 open orders and 200,000 orders a day. We reserve the right to change these settings as we tune the system. If you are affected by these limits as an active trader, please email [e-mail].

If you have any questions, feedback or recommendation for API support you can post a question in our support center.

Public

getMarkets :: IO (Either ErrorMessage [Market])

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

getCurrencies :: IO (Either ErrorMessage [Currency])

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

getTicker

Arguments

:: MarketName

A string literal for the market (e.g.: BTC-LTC).

-> IO (Either ErrorMessage Ticker)

Used to get the current tick values for a market.

getMarketSummaries :: IO (Either ErrorMessage [MarketSummary])

This function returns a summary of the last 24 hours for all active exchanges.

getMarketSummary

Arguments

:: MarketName

A string literal for the market (e.g.: BTC-LTC).

-> IO (Either ErrorMessage [MarketSummary])

This function returns a summary of the last 24 hours for the given market.

getOrderBookBuys

Arguments

:: MarketName

A string literal for the market (e.g.: BTC-LTC). -> OrderBookType -- ^ buy, sell or both to identify the type of orderbook to return.

-> IO (Either ErrorMessage [OrderBookEntry])

Used to get retrieve the orderbook for a given market

getOrderBookSells

Arguments

:: MarketName

A string literal for the market (e.g.: BTC-LTC). -> OrderBookType -- ^ buy, sell or both to identify the type of orderbook to return.

-> IO (Either ErrorMessage [OrderBookEntry])

Used to get retrieve the orderbook for a given market

getMarketHistory

Arguments

:: MarketName

A string literal for the market (e.g.: BTC-LTC).

-> IO (Either ErrorMessage [MarketHistory])

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

Market

buyLimit

Arguments

:: APIKeys

Your Bittrex API credentials.

-> MarketName

A string literal for the market (e.g.: BTC-LTC).

-> Quantity

The amount to purchase.

-> Rate

The rate at which to place the order.

-> IO (Either ErrorMessage UUID)

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

sellLimit

Arguments

:: APIKeys

Your Bittrex API credentials.

-> MarketName

A string literal for the market (e.g.: BTC-LTC)

-> Quantity

The amount to purchase

-> Rate

The rate at which to place the order

-> IO (Either ErrorMessage UUID)

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 workn

cancel

Arguments

:: APIKeys

Your Bittrex API credentials.

-> UUID

The UUID of the buy or sell order.

-> IO (Either ErrorMessage (Maybe Text))

Used to cancel a buy or sell order.

getOpenOrders

Arguments

:: APIKeys

Your Bittrex API credentials.

-> MarketName

String literal for the market (e.g.: BTC-LTC).

-> IO (Either ErrorMessage [OpenOrder])

Get all orders that you currently have opened. A specific market can be requested using the MarketName parameter.

Account

getBalances

Arguments

:: APIKeys

Your Bittrex API credentials.

-> IO (Either ErrorMessage [Balance])

Used to retrieve all balances from your account

getBalance

Arguments

:: APIKeys

Your Bittrex API credentials.

-> CurrencyName

A string literal for the currency (e.g.: LTC).

-> IO (Either ErrorMessage Balance)

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

getDepositAddress

Arguments

:: APIKeys

Your Bittrex API credentials.

-> CurrencyName

A string literal for the currency (e.g.: BTC).

-> IO (Either ErrorMessage DepositAddress)

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.

withdraw

Arguments

:: APIKeys

Your Bittrex API credentials.

-> CurrencyName

A string literal for the currency (e.g.: BTC).

-> Quantity

The quantity of coins to withdraw

-> Address

The address where to send the funds.

-> Maybe PaymentId

used for the optional field representing the memo / payment ID on CryptoNotes, BitShareX, and Nxt transactions.

-> IO (Either ErrorMessage UUID)

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

getOrder

Arguments

:: APIKeys

Your Bittrex API credentials.

-> UUID

The UUID of the buy or sell order.

-> IO (Either ErrorMessage Order)

Used to retrieve a single order by uuid.

getOrderHistory

Arguments

:: APIKeys

Your Bittrex API credentials.

-> Maybe MarketName

A string literal for the market (e.g.: BTC-LTC). If this is Nothing, all markets will be returned.

-> IO (Either ErrorMessage [OrderHistory])

Used to retrieve your order history.

getWithdrawalHistory

Arguments

:: APIKeys

Your Bittrex API credentials.

-> CurrencyName

A string literal for the currency (e.g.: BTC).

-> IO (Either ErrorMessage [WithdrawalHistory])

Used to retrieve your withdrawal history.

getDepositHistory

Arguments

:: APIKeys

Your Bittrex API credentials.

-> Maybe CurrencyName

A string literal for the currency (e.g.: BTC). If this is Nothing, all currencies will be returned.

-> IO (Either ErrorMessage [DepositHistory])

Used to retrieve your deposit history.