A simple python3 library used to communicate with Bittrex.com's HTTP API.
This library relies on the library Requests. This can be installed by executing:
pip install requests
Or by heading over to the Repository.
Using the library is relatively easy and straightforward.
1. Initiating an api object:
FROM Pytrex import *
apiObject = API()
apiObject.init("Bittrex api key", "Bittrex api secret")
2. Calling different methods of the library:
result = apiObject.getBalances()
3. All functions will return a json object:
print(result)
Will output:
{
"success" : true,
"message" : "",
"result" : [{
"Currency" : "DOGE",
"Balance" : 0.00000000,
"Available" : 0.00000000,
"Pending" : 0.00000000,
"CryptoAddress" : "DLxcEt3AatMyr2NTatzjsfHNoB9NT62HiF",
"Requested" : false,
"Uuid" : null
}, {
"Currency" : "BTC",
"Balance" : 14.21549076,
"Available" : 14.21549076,
"Pending" : 0.00000000,
"CryptoAddress" : "1Mrcdr6715hjda34pdXuLqXcju6qgwHA31",
"Requested" : false,
"Uuid" : null
}
]
}
- getMarkets()
{
"success" : true,
"message" : "",
"result" : [{
"MarketCurrency" : "LTC",
"BaseCurrency" : "BTC",
"MarketCurrencyLong" : "Litecoin",
"BaseCurrencyLong" : "Bitcoin",
"MinTradeSize" : 0.01000000,
"MarketName" : "BTC-LTC",
"IsActive" : true,
"Created" : "2014-02-13T00:00:00"
}, {
"MarketCurrency" : "DOGE",
"BaseCurrency" : "BTC",
"MarketCurrencyLong" : "Dogecoin",
"BaseCurrencyLong" : "Bitcoin",
"MinTradeSize" : 100.00000000,
"MarketName" : "BTC-DOGE",
"IsActive" : true,
"Created" : "2014-02-13T00:00:00"
}
]
}
- getCurrencies()
{
"success" : true,
"message" : "",
"result" : [{
"Currency" : "BTC",
"CurrencyLong" : "Bitcoin",
"MinConfirmation" : 2,
"TxFee" : 0.00020000,
"IsActive" : true,
"CoinType" : "BITCOIN",
"BaseAddress" : null
}, {
"Currency" : "LTC",
"CurrencyLong" : "Litecoin",
"MinConfirmation" : 5,
"TxFee" : 0.00200000,
"IsActive" : true,
"CoinType" : "BITCOIN",
"BaseAddress" : null
}
]
}
- getTicker(market)
Market = a string literal. For example: "BTC-LTC" or "ETH-ZEC"
{
"success" : true,
"message" : "",
"result" : {
"Bid" : 2.05670368,
"Ask" : 3.35579531,
"Last" : 3.35579531
}
}
- getmarketsummaries()
{
"success" : true,
"message" : "",
"result" : [{
"MarketName" : "BTC-888",
"High" : 0.00000919,
"Low" : 0.00000820,
"Volume" : 74339.61396015,
"Last" : 0.00000820,
"BaseVolume" : 0.64966963,
"TimeStamp" : "2014-07-09T07:19:30.15",
"Bid" : 0.00000820,
"Ask" : 0.00000831,
"OpenBuyOrders" : 15,
"OpenSellOrders" : 15,
"PrevDay" : 0.00000821,
"Created" : "2014-03-20T06:00:00",
"DisplayMarketName" : null
}, {
"MarketName" : "BTC-A3C",
"High" : 0.00000072,
"Low" : 0.00000001,
"Volume" : 166340678.42280999,
"Last" : 0.00000005,
"BaseVolume" : 17.59720424,
"TimeStamp" : "2014-07-09T07:21:40.51",
"Bid" : 0.00000004,
"Ask" : 0.00000005,
"OpenBuyOrders" : 18,
"OpenSellOrders" : 18,
"PrevDay" : 0.00000002,
"Created" : "2014-05-30T07:57:49.637",
"DisplayMarketName" : null
}
]
}
- getmarketsummary(market)
Market: string literal. For example: "BTC-LTC" or "ETH-ZEC"
{
"success" : true,
"message" : "",
"result" : [{
"MarketName" : "BTC-LTC",
"High" : 0.01350000,
"Low" : 0.01200000,
"Volume" : 3833.97619253,
"Last" : 0.01349998,
"BaseVolume" : 47.03987026,
"TimeStamp" : "2014-07-09T07:22:16.72",
"Bid" : 0.01271001,
"Ask" : 0.01291100,
"OpenBuyOrders" : 45,
"OpenSellOrders" : 45,
"PrevDay" : 0.01229501,
"Created" : "2014-02-13T00:00:00",
"DisplayMarketName" : null
}
]
}
- getorderbook(currency, type)
Currency = a currency string literal. For example "BTC" or "ETH" Type = a type string literal. The choices are: "sell", "buy" or "both"
{
"success" : true,
"message" : "",
"result" : {
"buy" : [{
"Quantity" : 12.37000000,
"Rate" : 0.02525000
}
],
"sell" : [{
"Quantity" : 32.55412402,
"Rate" : 0.02540000
}, {
"Quantity" : 60.00000000,
"Rate" : 0.02550000
}, {
"Quantity" : 60.00000000,
"Rate" : 0.02575000
}, {
"Quantity" : 84.00000000,
"Rate" : 0.02600000
}
]
}
}
- getmarkethistory(currency)
Market = a string literal. For example: "BTC-LTC" or "ETH-ZEC"
{
"success" : true,
"message" : "",
"result" : [{
"Id" : 319435,
"TimeStamp" : "2014-07-09T03:21:20.08",
"Quantity" : 0.30802438,
"Price" : 0.01263400,
"Total" : 0.00389158,
"FillType" : "FILL",
"OrderType" : "BUY"
}, {
"Id" : 319433,
"TimeStamp" : "2014-07-09T03:21:20.08",
"Quantity" : 0.31820814,
"Price" : 0.01262800,
"Total" : 0.00401833,
"FillType" : "PARTIAL_FILL",
"OrderType" : "BUY"
}, {
"Id" : 319379,
"TimeStamp" : "2014-07-09T02:58:48.127",
"Quantity" : 49.64643541,
"Price" : 0.01263200,
"Total" : 0.62713377,
"FillType" : "FILL",
"OrderType" : "SELL"
}, {
"Id" : 319378,
"TimeStamp" : "2014-07-09T02:58:46.27",
"Quantity" : 0.35356459,
"Price" : 0.01263200,
"Total" : 0.00446622,
"FillType" : "PARTIAL_FILL",
"OrderType" : "BUY"
}
]
}
- getBalances()
{
"success" : true,
"message" : "",
"result" : [{
"Currency" : "DOGE",
"Balance" : 0.00000000,
"Available" : 0.00000000,
"Pending" : 0.00000000,
"CryptoAddress" : "DLxcEt3AatMyr2NTatzjsfHNoB9NT62HiF",
"Requested" : false,
"Uuid" : null
}, {
"Currency" : "BTC",
"Balance" : 14.21549076,
"Available" : 14.21549076,
"Pending" : 0.00000000,
"CryptoAddress" : "1Mrcdr6715hjda34pdXuLqXcju6qgwHA31",
"Requested" : false,
"Uuid" : null
}
]
}
- getBalance(currency)
Currency = a string literal. For example "BTC" or "ETH"
{
"success" : true,
"message" : "",
"result" : {
"Currency" : "BTC",
"Balance" : 4.21549076,
"Available" : 4.21549076,
"Pending" : 0.00000000,
"CryptoAddress" : "1MacMr6715hjds342dXuLqXcju6fgwHA31",
"Requested" : false,
"Uuid" : null
}
}
- getdepositaddress(currency)
Currency = a string literal. For example "BTC" or "ETH"
{
"success" : true,
"message" : "",
"result" : {
"Currency" : "VTC",
"Address" : "Vy5SKeKGXUHKS2WVpJ76HYuKAu3URastUo"
}
}
- getOrder(UUID)
UUID = a string literal. For example "0cb4c4e4-bdc7-4e13-8c13-430e587d2cc1"
{
"success" : true,
"message" : "",
"result" : {
"AccountId" : null,
"OrderUuid" : "0cb4c4e4-bdc7-4e13-8c13-430e587d2cc1",
"Exchange" : "BTC-SHLD",
"Type" : "LIMIT_BUY",
"Quantity" : 1000.00000000,
"QuantityRemaining" : 1000.00000000,
"Limit" : 0.00000001,
"Reserved" : 0.00001000,
"ReserveRemaining" : 0.00001000,
"CommissionReserved" : 0.00000002,
"CommissionReserveRemaining" : 0.00000002,
"CommissionPaid" : 0.00000000,
"Price" : 0.00000000,
"PricePerUnit" : null,
"Opened" : "2014-07-13T07:45:46.27",
"Closed" : null,
"IsOpen" : true,
"Sentinel" : "6c454604-22e2-4fb4-892e-179eede20972",
"CancelInitiated" : false,
"ImmediateOrCancel" : false,
"IsConditional" : false,
"Condition" : "NONE",
"ConditionTarget" : null
}
}
- getOrderHistory(market)
market = string literal. For example "BTC-LTC" or "ETH-ZEC"
{
"success" : true,
"message" : "",
"result" : [{
"OrderUuid" : "fd97d393-e9b9-4dd1-9dbf-f288fc72a185",
"Exchange" : "BTC-LTC",
"TimeStamp" : "2014-07-09T04:01:00.667",
"OrderType" : "LIMIT_BUY",
"Limit" : 0.00000001,
"Quantity" : 100000.00000000,
"QuantityRemaining" : 100000.00000000,
"Commission" : 0.00000000,
"Price" : 0.00000000,
"PricePerUnit" : null,
"IsConditional" : false,
"Condition" : null,
"ConditionTarget" : null,
"ImmediateOrCancel" : false
}, {
"OrderUuid" : "17fd64d1-f4bd-4fb6-adb9-42ec68b8697d",
"Exchange" : "BTC-ZS",
"TimeStamp" : "2014-07-08T20:38:58.317",
"OrderType" : "LIMIT_SELL",
"Limit" : 0.00002950,
"Quantity" : 667.03644955,
"QuantityRemaining" : 0.00000000,
"Commission" : 0.00004921,
"Price" : 0.01968424,
"PricePerUnit" : 0.00002950,
"IsConditional" : false,
"Condition" : null,
"ConditionTarget" : null,
"ImmediateOrCancel" : false
}
]
}
- getwithdrawalhistory(currency)
Currency = a string literal. For example "BTC" or "ETH"
{
"success" : true,
"message" : "",
"result" : [{
"PaymentUuid" : "b52c7a5c-90c6-4c6e-835c-e16df12708b1",
"Currency" : "BTC",
"Amount" : 17.00000000,
"Address" : "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
"Opened" : "2014-07-09T04:24:47.217",
"Authorized" : true,
"PendingPayment" : false,
"TxCost" : 0.00020000,
"TxId" : null,
"Canceled" : true,
"InvalidAddress" : false
}, {
"PaymentUuid" : "f293da98-788c-4188-a8f9-8ec2c33fdfcf",
"Currency" : "XC",
"Amount" : 7513.75121715,
"Address" : "XVnSMgAd7EonF2Dgc4c9K14L12RBaW5S5J",
"Opened" : "2014-07-08T23:13:31.83",
"Authorized" : true,
"PendingPayment" : false,
"TxCost" : 0.00002000,
"TxId" : "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e",
"Canceled" : false,
"InvalidAddress" : false
}
]
}
- getdeposithistory(currency)
Currency = a string literal. For example "BTC" or "ETH"
{
"success" : true,
"message" : "",
"result" : [{
"PaymentUuid" : "554ec664-8842-4fe9-b491-06225becbd59",
"Currency" : "BTC",
"Amount" : 0.00156121,
"Address" : "1K37yQZaGrPKNTZ5KNP792xw8f7XbXxetE",
"Opened" : "2014-07-11T03:41:25.323",
"Authorized" : true,
"PendingPayment" : false,
"TxCost" : 0.00020000,
"TxId" : "70cf6fdccb9bd38e1a930e13e4ae6299d678ed6902da710fa3cc8d164f9be126",
"Canceled" : false,
"InvalidAddress" : false
}, {
"PaymentUuid" : "d3fdf168-3d8e-40b6-8fe4-f46e2a7035ea",
"Currency" : "BTC",
"Amount" : 0.11800000,
"Address" : "1Mrcar6715hjds34pdXuLqXcju6QgwHA31",
"O
pened" : "2014-07-03T20:27:07.163",
"Authorized" : true,
"PendingPayment" : false,
"TxCost" : 0.00020000,
"TxId" : "3efd41b3a051433a888eed3ecc174c1d025a5e2b486eb418eaaec5efddda22de",
"Canceled" : false,
"InvalidAddress" : false
}
]
}
- Gill Lambrigts - creator and maintainer of Pytrex.
- Kenneth Reitz - creator of the wonderful library Requests.