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, String orderRef) Cancel an existing order.
AccountInfo	getAccountInfo() Get private information about the currently logged-in account
List<Depth>	getAllDepthSince(long timestamp) Get all depth events since a particular time (or whenever this api object was created)
List<Trade>	getAllTradesSince(long timestamp) Get all trade events since a particular time (or whenever this api object was created)
Currency	getBaseCurrency()
CurrencyInfo	getCurrencyInfo(Currency currency) Get MtGox special information about a currency.
CurrencyInfo	getCurrencyInfo(String currencyCode) Get MtGox special information about a currency.
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 provate function that requires credentials.
OrderResult	getOrderResult(MtGoxAPI.OrderType orderType, String orderRef) Return the result of an order request
Ticker	getTicker() Request the current ticker from MtGox
List<Ticker>	getTickerHistory() Get all ticker events since this api object was created
List<Trade>	getTradeHistory() Get all trade events since this api object was created
String	placeMarketOrder(MtGoxAPI.OrderType orderType, MtGoxUnitOfCredit volume) Place a bitcoin order at market price.
String	placeOrder(MtGoxAPI.OrderType orderType, MtGoxUnitOfCredit price, MtGoxUnitOfCredit volume) Place a bitcoin order at a particular price

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 provate function that requires credentials. Get all open orders.

Returns:

An array of open orders

Throws:

Exception

getOrderResult

OrderResult getOrderResult(MtGoxAPI.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

getAllDepthSince

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

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

List<Depth> getDepthHistory()

Get all depth events since this api object was created

getTickerHistory

List<Ticker> getTickerHistory()

Get all ticker events since this api object was created

getTradeHistory

List<Trade> getTradeHistory()

Get all trade events since this api object was created

getTicker

Ticker getTicker()
                 throws Exception

Request the current ticker from MtGox

Returns:

Throws:

Exception

placeMarketOrder

String placeMarketOrder(MtGoxAPI.OrderType orderType,
                      MtGoxUnitOfCredit 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(MtGoxAPI.OrderType orderType,
                MtGoxUnitOfCredit price,
                MtGoxUnitOfCredit 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(MtGoxAPI.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 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:

Exception