to.sparks.mtgox

Interface MtGoxHTTPClient

public interface MtGoxHTTPClient

A java api for the MtGox bitcoin exchange built using Spring and Maven. See https://en.bitcoin.it/wiki/MtGox/API for protocol details.

Author:

SparksG

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MtGoxHTTPClient.OrderType

Method Summary

Methods

Modifier and Type	Method and Description
OrderCancelResult	cancelOrder(MtGoxHTTPClient.OrderType orderType, String orderRef) Cancel an existing order.
OrderCancelResult	cancelOrder(Order order)
AccountInfo	getAccountInfo() Get private information about the currently logged-in account
Currency	getBaseCurrency()
CurrencyInfo	getCurrencyInfo(Currency currency) Get MtGox special information about a currency.
CurrencyInfo	getCurrencyInfo(String currencyCode) Get MtGox special information about a currency.
FullDepth	getFullDepth() Get the market full depth from the MtGox exchange
Lag	getLag() The "lag" value is the age in microseconds of the oldest order pending execution If it's too large it means the engine is busy, and the depth is probably not reliable.
Order[]	getOpenOrders() A private function that requires credentials.
OrderResult	getOrderResult(MtGoxHTTPClient.OrderType orderType, String orderRef) Return the result of an order request
Ticker	getTicker() Request the current ticker from MtGox
String	placeMarketOrder(MtGoxHTTPClient.OrderType orderType, MtGoxBitcoin volume) Place a bitcoin order at market price.
String	placeOrder(MtGoxHTTPClient.OrderType orderType, MtGoxFiatCurrency price, MtGoxBitcoin volume) Place a bitcoin order at a particular price
SendBitcoinsTransaction	sendBitcoins(String destinationAddress, MtGoxBitcoin bitcoins, MtGoxBitcoin fee, boolean isNoInstant, boolean isGreen) Send bitcoins from your MtGox account balance to a bitcoin address.

Method Detail

getBaseCurrency

Currency getBaseCurrency()

Returns:

The java currency used by this api connection.

getFullDepth

FullDepth getFullDepth()
                       throws Exception

Get the market full depth from the MtGox exchange

Returns:

An object containing the full market depth information

Throws:

Exception

getOpenOrders

Order[] getOpenOrders()
                      throws Exception

A private function that requires credentials. Get all open orders.

Returns:

An array of open orders

Throws:

Exception

getOrderResult

OrderResult getOrderResult(MtGoxHTTPClient.OrderType orderType,
                         String orderRef)
                           throws Exception

Return the result of an order request

Parameters:

orderType - Bid or Ask

orderRef - The reference string that was returned when the order was pleaced

Returns:

Throws:

Exception

getTicker

Ticker getTicker()
                 throws Exception

Request the current ticker from MtGox

Returns:

Throws:

Exception

placeMarketOrder

String placeMarketOrder(MtGoxHTTPClient.OrderType orderType,
                      MtGoxBitcoin volume)
                        throws Exception

Place a bitcoin order at market price.

Parameters:

orderType - Bid or Ask

volume - The volume of bitcoins

Returns:

Order reference number

Throws:

Exception

placeOrder

String placeOrder(MtGoxHTTPClient.OrderType orderType,
                MtGoxFiatCurrency price,
                MtGoxBitcoin volume)
                  throws Exception

Place a bitcoin order at a particular price

Parameters:

orderType - Bid or Ask

price - The price in the base currency of this api instance

volume - The volume of bitcoins

Returns:

Order reference number

Throws:

Exception

getAccountInfo

AccountInfo getAccountInfo()
                           throws Exception

Get private information about the currently logged-in account

Returns:

Throws:

Exception

getCurrencyInfo

CurrencyInfo getCurrencyInfo(Currency currency)
                             throws Exception

Get MtGox special information about a currency.

Parameters:

currency - The java currency

Returns:

Throws:

Exception

getCurrencyInfo

CurrencyInfo getCurrencyInfo(String currencyCode)
                             throws Exception

Get MtGox special information about a currency.

Parameters:

currencyCode - The currency code

Returns:

Throws:

Exception

cancelOrder

OrderCancelResult cancelOrder(MtGoxHTTPClient.OrderType orderType,
                            String orderRef)
                              throws Exception

Cancel an existing order. Currently this is only available on the HTTP Version 0 API, so the JSON result should be discarded.

Parameters:

orderType - Bid or Ask

orderRef - The reference returned when the order was placed

Returns:

The JSON response. Avoid using this response because this api call uses the old Version 0 MtGox API.

Throws:

Exception

cancelOrder

OrderCancelResult cancelOrder(Order order)
                              throws Exception

Throws:

Exception

sendBitcoins

SendBitcoinsTransaction sendBitcoins(String destinationAddress,
                                   MtGoxBitcoin bitcoins,
                                   MtGoxBitcoin fee,
                                   boolean isNoInstant,
                                   boolean isGreen)
                                     throws Exception

Send bitcoins from your MtGox account balance to a bitcoin address.

Parameters:

destinationAddress - The destination bitcoin address that should receive the funds

bitcoins - The amount of bitcoins to transfer from your MtGox account

fee - The fee you would like to pay the network

isNoInstant - If true, use the bitcoin blockchain, even if the receiving address is on MtGox

isGreen - If true, use a greenaddress https://en.bitcoin.it/wiki/GreenAddress

Returns:

Throws:

Exception

getLag

Lag getLag()
           throws Exception

The "lag" value is the age in microseconds of the oldest order pending execution If it's too large it means the engine is busy, and the depth is probably not reliable.

Returns:

The order lag in milliseconds

Throws:

Exception