to.sparks.mtgox

Interface MtGoxAPI

public interface MtGoxAPI

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	MtGoxAPI.OrderType

Method Summary

Methods

Modifier and Type	Method and Description
OrderCancelResult	cancelOrder(MtGoxAPI.OrderType orderType, java.lang.String orderRef) Cancel an existing order.
OrderCancelResult	cancelOrder(Order order)
AccountInfo	getAccountInfo() Get private information about the currently logged-in account
java.util.List<Depth>	getAllDepthSince(long timestamp) Get all depth events since a particular time (or whenever this api object was created)
java.util.List<Trade>	getAllTradesSince(long timestamp) Get all trade events since a particular time (or whenever this api object was created)
java.util.Currency	getBaseCurrency()
CurrencyInfo	getCurrencyInfo(java.util.Currency currency) Get MtGox special information about a currency.
CurrencyInfo	getCurrencyInfo(java.lang.String currencyCode) Get MtGox special information about a currency.
java.util.List<Depth>	getDepthHistory() Get all depth events since this api object was created
FullDepth	getFullDepth() Get the market full depth from the MtGox exchange
Order[]	getOpenOrders() A private function that requires credentials.
OrderResult	getOrderResult(MtGoxAPI.OrderType orderType, java.lang.String orderRef) Return the result of an order request
Ticker	getTicker() Request the current ticker from MtGox
java.util.List<Ticker>	getTickerHistory() Get all ticker events since this api object was created
java.util.List<Trade>	getTradeHistory() Get all trade events since this api object was created
java.lang.String	placeMarketOrder(MtGoxAPI.OrderType orderType, MtGoxBitcoin volume) Place a bitcoin order at market price.
java.lang.String	placeOrder(MtGoxAPI.OrderType orderType, MtGoxFiatCurrency price, MtGoxBitcoin volume) Place a bitcoin order at a particular price
SendBitcoinsTransaction	sendBitcoins(java.lang.String destinationAddress, MtGoxBitcoin bitcoins, MtGoxBitcoin fee, boolean isNoInstant, boolean isGreen) Send bitcoins from your MtGox account balance to a bitcoin address.
void	shutdown() Shutdown the api threads and close any open websockets.

Method Detail

getBaseCurrency

java.util.Currency getBaseCurrency()

Returns:

The java currency used by this api connection.

getFullDepth

FullDepth getFullDepth()
                       throws java.lang.Exception

Get the market full depth from the MtGox exchange

Returns:

An object containing the full market depth information

Throws:

java.lang.Exception

getOpenOrders

Order[] getOpenOrders()
                      throws java.lang.Exception

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

Returns:

An array of open orders

Throws:

java.lang.Exception

getOrderResult

OrderResult getOrderResult(MtGoxAPI.OrderType orderType,
                         java.lang.String orderRef)
                           throws java.lang.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:

java.lang.Exception

getAllDepthSince

java.util.List<Depth> getAllDepthSince(long timestamp)

Get all depth events since a particular time (or whenever this api object was created)

Parameters:

timestamp - The java timestamp to return events since.

Returns:

getAllTradesSince

java.util.List<Trade> getAllTradesSince(long timestamp)

Get all trade events since a particular time (or whenever this api object was created)

Parameters:

timestamp - The java timestamp to return trades since.

Returns:

getDepthHistory

java.util.List<Depth> getDepthHistory()

Get all depth events since this api object was created

getTickerHistory

java.util.List<Ticker> getTickerHistory()

Get all ticker events since this api object was created

getTradeHistory

java.util.List<Trade> getTradeHistory()

Get all trade events since this api object was created

getTicker

Ticker getTicker()
                 throws java.lang.Exception

Request the current ticker from MtGox

Returns:

Throws:

java.lang.Exception

placeMarketOrder

java.lang.String placeMarketOrder(MtGoxAPI.OrderType orderType,
                                MtGoxBitcoin volume)
                                  throws java.lang.Exception

Place a bitcoin order at market price.

Parameters:

orderType - Bid or Ask

volume - The volume of bitcoins

Returns:

Order reference number

Throws:

java.lang.Exception

placeOrder

java.lang.String placeOrder(MtGoxAPI.OrderType orderType,
                          MtGoxFiatCurrency price,
                          MtGoxBitcoin volume)
                            throws java.lang.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:

java.lang.Exception

getAccountInfo

AccountInfo getAccountInfo()
                           throws java.lang.Exception

Get private information about the currently logged-in account

Returns:

Throws:

java.lang.Exception

getCurrencyInfo

CurrencyInfo getCurrencyInfo(java.util.Currency currency)
                             throws java.lang.Exception

Get MtGox special information about a currency.

Parameters:

currency - The java currency

Returns:

Throws:

java.lang.Exception

getCurrencyInfo

CurrencyInfo getCurrencyInfo(java.lang.String currencyCode)
                             throws java.lang.Exception

Get MtGox special information about a currency.

Parameters:

currencyCode - The currency code

Returns:

Throws:

java.lang.Exception

cancelOrder

OrderCancelResult cancelOrder(MtGoxAPI.OrderType orderType,
                            java.lang.String orderRef)
                              throws java.lang.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 string that was 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:

java.lang.Exception

cancelOrder

OrderCancelResult cancelOrder(Order order)
                              throws java.lang.Exception

Throws:

java.lang.Exception

sendBitcoins

SendBitcoinsTransaction sendBitcoins(java.lang.String destinationAddress,
                                   MtGoxBitcoin bitcoins,
                                   MtGoxBitcoin fee,
                                   boolean isNoInstant,
                                   boolean isGreen)
                                     throws java.lang.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:

java.lang.Exception

shutdown

void shutdown()

Shutdown the api threads and close any open websockets.