Struct coinnect::poloniex::api::PoloniexApi

pub struct PoloniexApi { /* fields omitted */ }

Methods

impl PoloniexApi

fn new<C: Credentials>(creds: C) -> Result<PoloniexApi>

Create a new PoloniexApi by providing an API key & API secret

fn set_burst(&mut self, burst: bool)

The number of calls in a given period is limited. In order to avoid a ban we limit by default the number of api requests. This function sets or removes the limitation. Burst false implies no block. Burst true implies there is a control over the number of calls allowed to the exchange

fn return_ticker(&mut self) -> Result<Map<String, Value>>

Sample output :

{
"BTC_LTC":{
"last":"0.0251","lowestAsk":"0.02589999","highestBid":"0.0251",
"percentChange":"0.02390438","baseVolume":"6.16485315","quoteVolume":"245.82513926"},
"BTC_NXT":{
"last":"0.00005730","lowestAsk":"0.00005710","highestBid":"0.00004903",
"percentChange":"0.16701570","baseVolume":"0.45347489","quoteVolume":"9094"},
... }

fn return_24_volume(&mut self) -> Result<Map<String, Value>>

Sample output :

{"BTC_LTC":{"BTC":"2.23248854","LTC":"87.10381314"},"BTC_NXT":{"BTC":"0.981616",
"NXT":"14145"},
... "totalBTC":"81.89657704","totalLTC":"78.52083806"}

fn return_order_book(
    &mut self,
    currency_pair: &str,
    depth: &str
) -> Result<Map<String, Value>>

Sample output :

{"asks":[[0.00007600,1164],[0.00007620,1300], ... ], "bids":[[0.00006901,200],
[0.00006900,408], ... ], "isFrozen": 0, "seq": 18849}

fn return_trade_history(
    &mut self,
    currency_pair: &str,
    start: &str,
    end: &str
) -> Result<Map<String, Value>>

Sample output :

[{"date":"2014-02-10 04:23:23","type":"buy","rate":"0.00007600","amount":"140",
"total":"0.01064"},
{"date":"2014-02-10 01:19:37","type":"buy","rate":"0.00007600","amount":"655",
"total":"0.04978"}, ... ]

fn return_chart_data(
    &mut self,
    currency_pair: &str,
    start: &str,
    end: &str,
    period: &str
) -> Result<Map<String, Value>>

Sample output :

[{"date":1405699200,"high":0.0045388,"low":0.00403001,"open":0.00404545,"close":0.00427592,
"volume":44.11655644,"quoteVolume":10259.29079097,"weightedAverage":0.00430015}, ...]

fn return_currencies(&mut self) -> Result<Map<String, Value>>

Sample output :

{"1CR":{"maxDailyWithdrawal":10000,"txFee":0.01,"minConf":3,"disabled":0},
"ABY":{"maxDailyWithdrawal":10000000,"txFee":0.01,"minConf":8,"disabled":0}, ... }

fn return_loan_orders(&mut self, currency: &str) -> Result<Map<String, Value>>

Sample output :

{"offers":[{"rate":"0.00200000","amount":"64.66305732","rangeMin":2,"rangeMax":8}, ... ],
"demands":[{"rate":"0.00170000","amount":"26.54848841","rangeMin":2,"rangeMax":2}, ... ]}

fn return_balances(&mut self) -> Result<Map<String, Value>>

Returns all of your available balances.

Sample output:

{"BTC":"0.59098578","LTC":"3.31117268", ... }

fn return_complete_balances(&mut self) -> Result<Map<String, Value>>

Returns all of your balances, including available balance, balance on orders, and the estimated BTC value of your balance. By default, this call is limited to your exchange account; set the "account" POST parameter to "all" to include your margin and lending accounts.

Sample output:

{"LTC":{"available":"5.015","onOrders":"1.0025","btcValue":"0.078"},"NXT":{...}, ... }

fn return_deposit_addresses(&mut self) -> Result<Map<String, Value>>

Returns all of your deposit addresses.

Sample output:

{"BTC":"19YqztHmspv2egyD6jQM3yn81x5t5krVdJ","LTC":"LPgf9kjv9H1Vuh4XSaKhzBe8JHdou1WgUB",
... "ITC":"Press Generate.." ... }

fn generate_new_address(&mut self, currency: &str) -> Result<Map<String, Value>>

Generates a new deposit address for the currency specified by the "currency" POST parameter.

Sample output:

{"success":1,"response":"CKXbbs8FAVbtEa397gJHSutmrdrBrhUMxe"}

fn return_deposits_withdrawals(
    &mut self,
    start: &str,
    end: &str
) -> Result<Map<String, Value>>

Returns your deposit and withdrawal history within a range, specified by the "start" and "end" POST parameters, both of which should be given as UNIX timestamps.

Sample output:

{"deposits":
[{"currency":"BTC","address":"...","amount":"0.01006132","confirmations":10,
"txid":"17f819a91369a9ff6c4a34216d434597cfc1b4a3d0489b46bd6f924137a47701",
"timestamp":1399305798,"status":"COMPLETE"},
{"currency":"BTC","address":"...","amount":"0.00404104","confirmations":10,
"txid":"7acb90965b252e55a894b535ef0b0b65f45821f2899e4a379d3e43799604695c",
"timestamp":1399245916,"status":"COMPLETE"}],
"withdrawals":[{"withdrawalNumber":134933,"currency":"BTC",
"address":"1N2i5n8DwTGzUq2Vmn9TUL8J1vdr1XBDFg","amount":"5.00010000",
"timestamp":1399267904,
"status":"COMPLETE: 36e483efa6aff9fd53a235177579d98451c4eb237c210e66cd2b9a2d4a988f8e",
"ipAddress":"..."}]}

fn return_open_orders(
    &mut self,
    currency_pair: &str
) -> Result<Map<String, Value>>

Returns your open orders for a given market, specified by the "currencyPair" POST parameter, e.g. "BTC_XCP". Set "currencyPair" to "all" to return open orders for all markets.

Sample output for single market:

[{"orderNumber":"120466","type":"sell","rate":"0.025","amount":"100","total":"2.5"},
{"orderNumber":"120467","type":"sell","rate":"0.04","amount":"100","total":"4"}, ... ]

Or, for all markets:
{"BTC_1CR":[],"BTC_AC":[{"orderNumber":"120466","type":"sell","rate":"0.025",
"amount":"100","total":"2.5"},
{"orderNumber":"120467","type":"sell","rate":"0.04","amount":"100","total":"4"}], ... }

fn return_private_trade_history(
    &mut self,
    currency_pair: &str,
    start: &str,
    end: &str
) -> Result<Map<String, Value>>

Returns your trade history for a given market, specified by the "currencyPair" POST parameter. You may specify "all" as the currencyPair to receive your trade history for all markets. You may optionally specify a range via "start" and/or "end" POST parameters, given in UNIX timestamp format; if you do not specify a range, it will be limited to one day.

Sample output:

[{ "globalTradeID": 25129732, "tradeID": "6325758", "date": "2016-04-05 08:08:40",
"rate": "0.02565498", "amount": "0.10000000", "total": "0.00256549", "fee": "0.00200000",
"orderNumber": "34225313575", "type": "sell", "category": "exchange" },
{ "globalTradeID": 25129628, "tradeID": "6325741", "date": "2016-04-05 08:07:55",
"rate": "0.02565499", "amount": "0.10000000", "total": "0.00256549",
"fee": "0.00200000", "orderNumber": "34225195693", "type": "buy", "category": "exchange" },
... ]

Or, for all markets:

{"BTC_MAID": [ { "globalTradeID": 29251512, "tradeID": "1385888",
"date": "2016-05-03 01:29:55", "rate": "0.00014243", "amount": "353.74692925",
"total": "0.05038417", "fee": "0.00200000", "orderNumber": "12603322113", "type": "buy",
"category": "settlement" },
{ "globalTradeID": 29251511, "tradeID": "1385887", "date": "2016-05-03 01:29:55",
"rate": "0.00014111", "amount": "311.24262497", "total": "0.04391944", "fee": "0.00200000",
"orderNumber": "12603319116", "type": "sell", "category": "marginTrade" }, ... ],
"BTC_LTC":[ ... ] ... }

fn return_order_trades(
    &mut self,
    order_number: &str
) -> Result<Map<String, Value>>

Returns all trades involving a given order, specified by the "orderNumber" POST parameter. If no trades for the order have occurred or you specify an order that does not belong to you, you will receive an error.

Sample output:

[{"globalTradeID": 20825863, "tradeID": 147142, "currencyPair": "BTC_XVC", "type": "buy",
"rate": "0.00018500", "amount": "455.34206390", "total": "0.08423828", "fee": "0.00200000",
"date": "2016-03-14 01:04:36"}, ...]

fn buy(
    &mut self,
    currency_pair: &str,
    rate: &str,
    amount: &str
) -> Result<Map<String, Value>>

Places a limit buy order in a given market. Required POST parameters are "currencyPair", "rate", and "amount". If successful, the method will return the order number.

Sample output:

{"orderNumber":31226040,"resultingTrades":[{"amount":"338.8732",
"date":"2014-10-18 23:03:21", "rate":"0.00000173","total":"0.00058625","tradeID":"16164",
"type":"buy"}]}

fn sell(
    &mut self,
    currency_pair: &str,
    rate: &str,
    amount: &str
) -> Result<Map<String, Value>>

Places a sell order in a given market. Parameters and output are the same as for the buy method.

fn cancel_order(&mut self, order_number: &str) -> Result<Map<String, Value>>

Cancels an order you have placed in a given market. Required POST parameter is "orderNumber". If successful, the method will return: {"success":1}

fn move_order(
    &mut self,
    order_number: &str,
    rate: &str
) -> Result<Map<String, Value>>

Cancels an order and places a new one of the same type in a single atomic transaction, meaning either both operations will succeed or both will fail. Required POST parameters are "orderNumber" and "rate"; you may optionally specify "amount" if you wish to change the amount of the new order. "postOnly" or "immediateOrCancel" may be specified for exchange orders, but will have no effect on margin orders.

Sample output:

{"success":1,"orderNumber":"239574176","resultingTrades":{"BTC_BTS":[]}}

fn withdraw(
    &mut self,
    currency: &str,
    amount: &str,
    address: &str
) -> Result<Map<String, Value>>

Immediately places a withdrawal for a given currency, with no email confirmation. In order to use this method, the withdrawal privilege must be enabled for your API key. Required POST parameters are "currency", "amount", and "address". For XMR withdrawals, you may optionally specify "paymentId".

Sample output:

{"response":"Withdrew 2398 NXT."}

fn return_free_info(&mut self) -> Result<Map<String, Value>>

If you are enrolled in the maker-taker fee schedule, returns your current trading fees and trailing 30-day volume in BTC. This information is updated once every 24 hours.

Sample output:

{"makerFee": "0.00140000", "takerFee": "0.00240000", "thirtyDayVolume": "612.00248891",
"nextTier": "1200.00000000"}

fn return_available_account_balances(
    &mut self,
    account: &str
) -> Result<Map<String, Value>>

Returns your balances sorted by account. You may optionally specify the "account" POST parameter if you wish to fetch only the balances of one account. Please note that balances in your margin account may not be accessible if you have any open margin positions or orders.

Sample output:

{"exchange":{"BTC":"1.19042859","BTM":"386.52379392","CHA":"0.50000000",
"DASH":"120.00000000", "STR":"3205.32958001", "VNL":"9673.22570147"},
"margin":{"BTC":"3.90015637", "DASH":"250.00238240","XMR":"497.12028113"},
"lending":{"DASH":"0.01174765","LTC":"11.99936230"}}

fn return_tradable_balances(&mut self) -> Result<Map<String, Value>>

Returns your current tradable balances for each currency in each market for which margin trading is enabled. Please note that these balances may vary continually with market conditions.

Sample output:

{"BTC_DASH":{"BTC":"8.50274777","DASH":"654.05752077"},"BTC_LTC":{"BTC":"8.50274777",
"LTC":"1214.67825290"},"BTC_XMR":{"BTC":"8.50274777","XMR":"3696.84685650"}}

fn transfer_balance(
    &mut self,
    currency: &str,
    amount: &str,
    from_account: &str,
    to_account: &str
) -> Result<Map<String, Value>>

Transfers funds from one account to another (e.g. from your exchange account to your margin account). Required POST parameters are "currency", "amount", "fromAccount", and "toAccount".

Sample output:

{"success":1,"message":"Transferred 2 BTC from exchange to margin account."}

fn return_margin_account_summary(&mut self) -> Result<Map<String, Value>>

Returns a summary of your entire margin account. This is the same information you will find in the Margin Account section of the Margin Trading page, under the Markets list.

Sample output:

{"totalValue": "0.00346561","pl": "-0.00001220","lendingFees": "0.00000000",
"netValue": "0.00345341","totalBorrowedValue": "0.00123220","currentMargin": "2.80263755"}

fn margin_buy(
    &mut self,
    currency_pair: &str,
    rate: &str,
    amount: &str,
    lending_rate: &str
) -> Result<Map<String, Value>>

Places a margin buy order in a given market. Required POST parameters are "currencyPair", "rate", and "amount". You may optionally specify a maximum lending rate using the "lendingRate" parameter. If successful, the method will return the order number and any trades immediately resulting from your order.

Sample output:

{"success":1,"message":"Margin order placed.","orderNumber":"154407998",
"resultingTrades":{"BTC_DASH":[{"amount":"1.00000000","date":"2015-05-10 22:47:05",
"rate":"0.01383692","total":"0.01383692","tradeID":"1213556","type":"buy"}]}}

fn margin_sell(
    &mut self,
    currency_pair: &str,
    rate: &str,
    amount: &str,
    lending_rate: &str
) -> Result<Map<String, Value>>

Places a margin sell order in a given market. Required POST parameters are "currencyPair", "rate", and "amount". You may optionally specify a maximum lending rate using the "lendingRate" parameter. If successful, the method will return the order number and any trades immediately resulting from your order.

Sample output:

{"success":1,"message":"Margin order placed.","orderNumber":"154407998",
"resultingTrades":{"BTC_DASH":[{"amount":"1.00000000","date":"2015-05-10 22:47:05",
"rate":"0.01383692","total":"0.01383692","tradeID":"1213556","type":"sell"}]}}

fn get_margin_position(
    &mut self,
    currency_pair: &str
) -> Result<Map<String, Value>>

Returns information about your margin position in a given market, specified by the "currencyPair" POST parameter. You may set "currencyPair" to "all" if you wish to fetch all of your margin positions at once. If you have no margin position in the specified market, "type" will be set to "none". "liquidationPrice" is an estimate, and does not necessarily represent the price at which an actual forced liquidation will occur. If you have no liquidation price, the value will be -1.

Sample output:

{"amount":"40.94717831","total":"-0.09671314","basePrice":"0.00236190",
"liquidationPrice":-1,"pl":"-0.00058655", "lendingFees":"-0.00000038","type":"long"}

fn close_margin_position(
    &mut self,
    currency_pair: &str
) -> Result<Map<String, Value>>

Closes your margin position in a given market (specified by the "currencyPair" POST parameter) using a market order. This call will also return success if you do not have an open position in the specified market.

Sample output:

{"success":1,"message":"Successfully closed margin position.",
"resultingTrades":{"BTC_XMR":[{"amount":"7.09215901","date":"2015-05-10 22:38:49",
"rate":"0.00235337","total":"0.01669047","tradeID":"1213346","type":"sell"},
{"amount":"24.00289920","date":"2015-05-10 22:38:49","rate":"0.00235321",
"total":"0.05648386","tradeID":"1213347","type":"sell"}]}}

fn create_loan_offer(
    &mut self,
    currency: &str,
    amount: &str,
    duration: &str,
    auto_renew: &str,
    lending_rate: &str
) -> Result<Map<String, Value>>

Creates a loan offer for a given currency. Required POST parameters are "currency", "amount", "duration", "autoRenew" (0 or 1), and "lendingRate".

Sample output:

{"success":1,"message":"Loan order placed.","orderID":10590}

fn cancel_loan_offer(
    &mut self,
    order_number: &str
) -> Result<Map<String, Value>>

Cancels a loan offer specified by the "orderNumber" POST parameter.

Sample output:

{"success":1,"message":"Loan offer canceled."}

fn return_open_loan_offers(&mut self) -> Result<Map<String, Value>>

Returns your open loan offers for each currency.

Sample output:

{"BTC":[{"id":10595,"rate":"0.00020000","amount":"3.00000000","duration":2,"autoRenew":1,
"date":"2015-05-10 23:33:50"}],"LTC":[{"id":10598,"rate":"0.00002100",
"amount":"10.00000000","duration":2,"autoRenew":1,"date":"2015-05-10 23:34:35"}]}

fn return_active_loans(&mut self) -> Result<Map<String, Value>>

Returns your active loans for each currency.

Sample output:

{"provided":[{"id":75073,"currency":"LTC","rate":"0.00020000","amount":"0.72234880",
"range":2,"autoRenew":0,"date":"2015-05-10 23:45:05","fees":"0.00006000"},
{"id":74961,"currency":"LTC","rate":"0.00002000","amount":"4.43860711","range":2,
"autoRenew":0,"date":"2015-05-10 23:45:05","fees":"0.00006000"}],
"used":[{"id":75238,"currency":"BTC","rate":"0.00020000","amount":"0.04843834","range":2,
"date":"2015-05-10 23:51:12","fees":"-0.00000001"}]}

fn return_lending_history(
    &mut self,
    start: &str,
    end: &str,
    limit: &str
) -> Result<Map<String, Value>>

Returns your lending history within a time range specified by the "start" and "end" POST parameters as UNIX timestamps. "limit" may also be specified to limit the number of rows returned.

Sample output:

[{ "id": 175589553, "currency": "BTC", "rate": "0.00057400", "amount": "0.04374404",
"duration": "0.47610000", "interest": "0.00001196", "fee": "-0.00000179",
"earned": "0.00001017", "open": "2016-09-28 06:47:26", "close": "2016-09-28 18:13:03" }]

fn toggle_auto_renew(
    &mut self,
    order_number: &str
) -> Result<Map<String, Value>>

Toggles the autoRenew setting on an active loan, specified by the "orderNumber" POST parameter. If successful, "message" will indicate the new autoRenew setting.

Sample output:

{"success":1,"message":0}

Trait Implementations

impl Debug for PoloniexApi

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl ExchangeApi for PoloniexApi

fn ticker(&mut self, pair: Pair) -> Result<Ticker>

Return a Ticker for the Pair specified.

fn orderbook(&mut self, pair: Pair) -> Result<Orderbook>

Return an Orderbook for the specified Pair.

fn add_order(
    &mut self,
    order_type: OrderType,
    pair: Pair,
    quantity: Volume,
    price: Option<Price>
) -> Result<OrderInfo>

Place an order directly to the exchange. Quantity is in quote currency. So if you want to buy 1 Bitcoin for X€ (pair BTC_EUR), base currency (right member in the pair) is BTC and quote/counter currency is BTC (left member in the pair). So quantity = 1.

fn balances(&mut self) -> Result<Balances>

Retrieve the current amounts of all the currencies that the account holds The amounts returned are available (not used to open an order)