org.knowm.xchange.btctrade

Interface BTCTrade

@Path(value="/")
 @Produces(value="application/json")
public interface BTCTrade

Method Summary

Modifier and Type	Method and Description
BTCTradePlaceOrderResult	buy(String amount, String price, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Places a buy order.
BTCTradeResult	cancelOrder(String id, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Cancels order.
BTCTradeBalance	getBalance(si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Returns the account balance.
BTCTradeDepth	getDepth() Returns the depth of the market.
BTCTradeOrder	getOrder(String id, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Returns order information.
BTCTradeOrder[]	getOrders(long since, String type, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Return orders.
BTCTradeSecretResponse	getSecret(String passphrase, String key) Returns the secret for signing.
BTCTradeTicker	getTicker() Returns the quotations.
BTCTradeTrade[]	getTrades() Returns 500 recent market transactions, in reverse chronological order.
BTCTradeTrade[]	getTrades(long since) Returns 500 market transactions which trade ID is greater than since, in reverse chronological order.
BTCTradeWallet	getWallet(si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Returns the deposit address.
BTCTradePlaceOrderResult	sell(String amount, String price, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String key, si.mazi.rescu.ParamsDigest signature) Places a sell order.

Method Detail

getTicker

@GET
 @Path(value="ticker")
BTCTradeTicker getTicker()
                                              throws IOException

Returns the quotations.

Returns:

the quotations.

Throws:

IOException

getDepth

@GET
 @Path(value="depth")
BTCTradeDepth getDepth()
                                           throws IOException

Returns the depth of the market.

Returns:

the depth of the market.

Throws:

IOException

getTrades

@GET
 @Path(value="trades")
BTCTradeTrade[] getTrades()
                                               throws IOException

Returns 500 recent market transactions, in reverse chronological order.

Returns:

500 recent market transactions.

Throws:

IOException

getTrades

@GET
 @Path(value="trades")
BTCTradeTrade[] getTrades(@QueryParam(value="since")
                                                      long since)
                                               throws IOException

Returns 500 market transactions which trade ID is greater than since, in reverse chronological order.

Parameters:

since - the trade ID.

Returns:

500 market transactions which trade ID is grater than the given ID.

Throws:

IOException

getSecret

@POST
 @Path(value="getsecret")
BTCTradeSecretResponse getSecret(@FormParam(value="api_passphrase")
                                                                 String passphrase,
                                                                 @FormParam(value="key")
                                                                 String key)
                                                          throws IOException

Returns the secret for signing.

Parameters:

passphrase - the API private key.

key - the API public key.

Returns:

the secret for signing.

Throws:

IOException

getBalance

@POST
 @Path(value="balance")
BTCTradeBalance getBalance(@FormParam(value="nonce")
                                                         si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                         @FormParam(value="key")
                                                         String key,
                                                         @FormParam(value="signature")
                                                         si.mazi.rescu.ParamsDigest signature)
                                                  throws IOException

Returns the account balance.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature

Returns:

the account balance.

Throws:

IOException

getWallet

@POST
 @Path(value="wallet")
BTCTradeWallet getWallet(@FormParam(value="nonce")
                                                      si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                      @FormParam(value="key")
                                                      String key,
                                                      @FormParam(value="signature")
                                                      si.mazi.rescu.ParamsDigest signature)
                                               throws IOException

Returns the deposit address.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature.

Returns:

the deposit address.

Throws:

IOException

getOrders

@POST
 @Path(value="orders")
BTCTradeOrder[] getOrders(@FormParam(value="since")
                                                       long since,
                                                       @FormParam(value="type")
                                                       String type,
                                                       @FormParam(value="nonce")
                                                       si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                       @FormParam(value="key")
                                                       String key,
                                                       @FormParam(value="signature")
                                                       si.mazi.rescu.ParamsDigest signature)
                                                throws IOException

Return orders.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature.

since - unix timestamp(UTC timezone). Default is 0, returns all.

type - the order type: open, all.

Throws:

IOException

getOrder

@POST
 @Path(value="fetch_order")
BTCTradeOrder getOrder(@FormParam(value="id")
                                                         String id,
                                                         @FormParam(value="nonce")
                                                         si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                         @FormParam(value="key")
                                                         String key,
                                                         @FormParam(value="signature")
                                                         si.mazi.rescu.ParamsDigest signature)
                                                  throws IOException

Returns order information.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature.

id - the order ID.

Throws:

IOException

cancelOrder

@POST
 @Path(value="cancel_order")
BTCTradeResult cancelOrder(@FormParam(value="id")
                                                              String id,
                                                              @FormParam(value="nonce")
                                                              si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                              @FormParam(value="key")
                                                              String key,
                                                              @FormParam(value="signature")
                                                              si.mazi.rescu.ParamsDigest signature)
                                                       throws IOException

Cancels order.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature.

id - the order ID.

Throws:

IOException

buy

@POST
 @Path(value="buy")
BTCTradePlaceOrderResult buy(@FormParam(value="amount")
                                                       String amount,
                                                       @FormParam(value="price")
                                                       String price,
                                                       @FormParam(value="nonce")
                                                       si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                       @FormParam(value="key")
                                                       String key,
                                                       @FormParam(value="signature")
                                                       si.mazi.rescu.ParamsDigest signature)
                                                throws IOException

Places a buy order.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature.

amount - the quantity to buy.

price - the price to buy.

Throws:

IOException

sell

@POST
 @Path(value="sell")
BTCTradePlaceOrderResult sell(@FormParam(value="amount")
                                                         String amount,
                                                         @FormParam(value="price")
                                                         String price,
                                                         @FormParam(value="nonce")
                                                         si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                                         @FormParam(value="key")
                                                         String key,
                                                         @FormParam(value="signature")
                                                         si.mazi.rescu.ParamsDigest signature)
                                                  throws IOException

Places a sell order.

Parameters:

nonce - the nonce.

key - the API public key.

signature - the signature.

amount - the quantity to sell.

price - the price to sell.

Throws:

IOException