com.cml.idex

Class IDexAPI

java.lang.Object

com.cml.idex.IDexAPI

public class IDexAPI
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ETH_ADR

Constructor Summary

Constructors

Constructor and Description
IDexAPI()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Outcome>	cancel(org.web3j.crypto.Credentials credentials, String orderHash) Cancels an order associated with the address.
CompletableFuture<Outcome>	cancel(String orderHash, String address, long nonce, byte v, byte[] r, byte[] s) Cancels an order associated with the address.
CompletableFuture<Order>	order(org.web3j.crypto.Credentials credentials, String tokenBuy, BigInteger amountBuy, String tokenSell, BigInteger amountSell, Long expires) Places a limit order on IDEX.
CompletableFuture<Order>	order(org.web3j.crypto.Credentials credentials, String contractAdress, long nonce, String tokenBuy, BigInteger amountBuy, String tokenSell, BigInteger amountSell, Long expires) Places a limit order on IDEX.
CompletableFuture<Order>	order(String tokenBuy, BigInteger amountBuy, String tokenSell, BigInteger amountSell, String address, long nonce, long expires, byte v, byte[] r, byte[] s) Places a limit order on IDEX.
CompletableFuture<Volume>	return24Volume() Returns the 24-hour volume for all markets, plus totals for primary currencies.
CompletableFuture<Map<String,BigDecimal>>	returnBalances(String address) Returns available balances for an address(total deposited minus amount in open orders) indexed by token symbol.
CompletableFuture<Map<String,BalanceOrder>>	returnCompleteBalances(String address) Returns available balances for an address along with the amount of open orders for each token, indexed by token symbol.
CompletableFuture<String>	returnContractAddress() Returns the lowest nonce that you can use from the given address in one of the contract-backed trade functions.
CompletableFuture<Map<String,Currency>>	returnCurrencies() Returns an object of token data indexed by symbol.
CompletableFuture<CurrencyPairs>	returnCurrenciesWithPairs() Returns all the currency pair availble on the IDEX Market.
CompletableFuture<DepositsWithdrawals>	returnDepositsWithdrawals(String address, LocalDateTime start, LocalDateTime end) Returns your deposit and withdrawal history within a range, specified by the "start" and "end" optional properties.
CompletableFuture<Long>	returnNextNonce(String address) Returns the lowest nonce that you can use from the given address in one of the contract-backed trade functions.
CompletableFuture<List<Order>>	returnOpenOrders(String market, String address, Integer count, String cursor) Returns a paginated list of all open orders for a given market or address.
CompletableFuture<Page<List<Order>>>	returnOpenOrdersPage(String market, String address, Integer count) Returns a paginated list of all open orders for a given market or address.
CompletableFuture<Page<List<Order>>>	returnOpenOrdersPage(String market, String address, Integer count, String cursor) Returns a paginated list of all open orders for a given market or address.
CompletableFuture<OrderBook>	returnOrderBook(String market, Integer count) Returns the best-priced open orders for a given market.
CompletableFuture<Order>	returnOrderStatus(String orderHash) Returns a single order.
CompletableFuture<List<OrderTrade>>	returnOrderTrades(String orderHash) Returns all trades involving a given order hash.
CompletableFuture<Ticker>	returnTicker(String market) Designed to behave similar to the API call of the same name provided by the Poloniex HTTP API, with the addition of highs and lows.
CompletableFuture<List<TradeHistory>>	returnTradeHistory(String market, String address, LocalDateTime start, LocalDateTime end, SortOrder sort, Integer count, String cursor) Returns a paginated list of all trades for a given market or address, sorted by date.
CompletableFuture<List<TradeHistory>>	returnTradeHistory(String market, String address, Long start, Long end, SortOrder sort, Integer count, String cursor) Returns a paginated list of all trades for a given market or address, sorted by date.
CompletableFuture<Page<List<TradeHistory>>>	returnTradeHistoryPage(String market, String address, LocalDateTime start, LocalDateTime end, SortOrder sortOrder, Integer count) Returns Result Producer that paginats throught the results till no more is found! All trades for a given market or address, sorted by date.
CompletableFuture<Page<List<TradeHistory>>>	returnTradeHistoryPage(String market, String address, LocalDateTime start, LocalDateTime end, SortOrder sortOrder, Integer count, String cursor) Returns Result Producer that paginats throught the results till no more is found! All trades for a given market or address, sorted by date.
void	shutdown()
CompletableFuture<Outcome>	withdraw(org.web3j.crypto.Credentials credentials, BigInteger amount, String token) Withdraws funds associated with the address.
CompletableFuture<Outcome>	withdraw(org.web3j.crypto.Credentials credentials, String contractAddress, BigInteger amount, String token, long nonce) Withdraws funds associated with the address.
CompletableFuture<Outcome>	withdraw(String address, BigInteger amount, String token, long nonce, byte v, byte[] r, byte[] s) Withdraws funds associated with the address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ETH_ADR

public static final String DEFAULT_ETH_ADR

See Also:

Constant Field Values

Constructor Detail

IDexAPI

public IDexAPI()

Method Detail

order

public CompletableFuture<Order> order(String tokenBuy,
                                      BigInteger amountBuy,
                                      String tokenSell,
                                      BigInteger amountSell,
                                      String address,
                                      long nonce,
                                      long expires,
                                      byte v,
                                      byte[] r,
                                      byte[] s)

Places a limit order on IDEX.

Parameters:

tokenBuy - The address of the token you will receive as a result of the trade.

amountBuy - The amount of the token you will receive when the order is fully filled.

tokenSell - The address of the token you will lose as a result of the trade

amountSell - The amount of the token you will give up when the order is fully filled

address - The address you are posting the order from

nonce - One time number associated with the limit order

expires - DEPRECATED this property has no effect on your limit order but is still REQUIRED to submit a limit order as it is one of the parameters that is hashed

v - Derived from signing the hash of the message

r - Derived from signing the hash of the message

s - Derived from signing the hash of the message

Returns:

CompletableFuture of order action

order

public CompletableFuture<Order> order(org.web3j.crypto.Credentials credentials,
                                      String contractAdress,
                                      long nonce,
                                      String tokenBuy,
                                      BigInteger amountBuy,
                                      String tokenSell,
                                      BigInteger amountSell,
                                      Long expires)

Places a limit order on IDEX.

Parameters:

credentials - Wallet credentials

contractAdress - The contract address used for depositing, withdrawing, and posting orders. Can get from returnContractAddress

nonce - One time numeric value associated with your address. Can get from returnNextNonce.

tokenBuy - The address of the token you will receive as a result of the trade.

amountBuy - The amount of the token you will receive when the order is fully filled.

tokenSell - The address of the token you will lose as a result of the trade

amountSell - The amount of the token you will give up when the order is fully filled

expires - DEPRECATED this property has no effect on your limit order but is still REQUIRED to submit a limit order as it is one of the parameters that is hashed

Returns:

CompletableFuture of order action

order

public CompletableFuture<Order> order(org.web3j.crypto.Credentials credentials,
                                      String tokenBuy,
                                      BigInteger amountBuy,
                                      String tokenSell,
                                      BigInteger amountSell,
                                      Long expires)

Places a limit order on IDEX.

Parameters:

credentials - Wallet credentials

tokenBuy - The address of the token you will receive as a result of the trade.

amountBuy - The amount of the token you will receive when the order is fully filled.

tokenSell - The address of the token you will lose as a result of the trade

amountSell - The amount of the token you will give up when the order is fully filled

expires - DEPRECATED this property has no effect on your limit order but is still REQUIRED to submit a limit order as it is one of the parameters that is hashed

Returns:

CompletableFuture of order action

cancel

public CompletableFuture<Outcome> cancel(String orderHash,
                                         String address,
                                         long nonce,
                                         byte v,
                                         byte[] r,
                                         byte[] s)

Cancels an order associated with the address.

Parameters:

orderHash - The raw hash of the order you are cancelling.

address - The address you are sending the cancel from must own the order.

nonce - One time number associated with the address.

v - Derived from signing the hash of the message.

r - Derived from signing the hash of the message.

s - Derived from signing the hash of the message.

Returns:

CompletableFuture of cancel action

cancel

public CompletableFuture<Outcome> cancel(org.web3j.crypto.Credentials credentials,
                                         String orderHash)

Cancels an order associated with the address.

Parameters:

credentials - Wallet credentials

orderHash - The raw hash of the order you are cancelling.

Returns:

CompletableFuture of cancel action

withdraw

public CompletableFuture<Outcome> withdraw(String address,
                                           BigInteger amount,
                                           String token,
                                           long nonce,
                                           byte v,
                                           byte[] r,
                                           byte[] s)

Withdraws funds associated with the address. You cannot withdraw funds that are tied up in open orders.

Parameters:

address - The address you are transacting from.

amount - The raw amount you are withdrawing, not adjusted for token precision.

token - The address of the token you are withdrawing from, Constant (IDexAPI.DEFAULT_ETH_ADR) for ETH.

nonce - One time numeric value associated with your address. Can get from returnNextNonce.

v - Value obtained from signing message hash.

r - Value obtained from signing message hash.

s - Value obtained from signing message hash.

Returns:

CompletableFuture of withdraw action

withdraw

public CompletableFuture<Outcome> withdraw(org.web3j.crypto.Credentials credentials,
                                           String contractAddress,
                                           BigInteger amount,
                                           String token,
                                           long nonce)

Withdraws funds associated with the address. You cannot withdraw funds that are tied up in open orders.

Parameters:

credentials - Wallet credentials

contractAddress - The contract address used for depositing, withdrawing, and posting orders. Can get from returnContractAddress

amount - The raw amount you are withdrawing, not adjusted for token precision.

token - The address of the token you are withdrawing from, Constant (IDexAPI.DEFAULT_ETH_ADR) for ETH.

nonce - One time numeric value associated with your address. Can get from returnNextNonce.

Returns:

CompletableFuture of withdraw action

withdraw

public CompletableFuture<Outcome> withdraw(org.web3j.crypto.Credentials credentials,
                                           BigInteger amount,
                                           String token)

Withdraws funds associated with the address. You cannot withdraw funds that are tied up in open orders.

Parameters:

credentials - Wallet credentials

amount - The raw amount you are withdrawing, not adjusted for token precision.

token - The address of the token you are withdrawing from, Constant (IDexAPI.DEFAULT_ETH_ADR) for ETH.

Returns:

Future

returnNextNonce

public CompletableFuture<Long> returnNextNonce(String address)

Returns the lowest nonce that you can use from the given address in one of the contract-backed trade functions.

Parameters:

address - Ethereum Address to get nounce for

Returns:

CompletableFuture

returnContractAddress

public CompletableFuture<String> returnContractAddress()

Returns the lowest nonce that you can use from the given address in one of the contract-backed trade functions.

Returns:

Future

returnOrderBook

public CompletableFuture<OrderBook> returnOrderBook(String market,
                                                    Integer count)

Returns the best-priced open orders for a given market. The response is an object with asks and bids properties, each of which is an array that contains orders sorted by best price (lowest ask first, and highest bid first). By default, the asks and bids lists include 1 order each (ie. the lowest ask and the highest bid). You may request up to 100 orders per segment by including the count parameter. Pagination is not supported. Order objects contain price, amount, total, and orderHash properties, as well as a params property which contains additional data about the order that is useful for verifying the order's authenticity and to fill it. See the trade API call below for details on how to fill orders.

Parameters:

market - Market pair

count - Number of records to be returned per asks/bids segment.

Returns:

Future

returnOpenOrders

public CompletableFuture<List<Order>> returnOpenOrders(String market,
                                                       String address,
                                                       Integer count,
                                                       String cursor)

Returns a paginated list of all open orders for a given market or address. The response is similar to the response of returnOrderBook except that orders are sorted chronologically (oldest first) instead of by price. The data format of an order is the same, and there are some additional data points.

Parameters:

market - Required if address not specified.

address - Required if market not specified. Returns all open orders placed by the given address.

count - Number of records to be returned per request. Default 10

cursor - For pagination. Provide the value returned in the idex-next-cursor HTTP header to request the next slice (or page). This endpoint uses the orderNumber property of a record for the cursor.

Returns:

Future

returnOpenOrdersPage

public CompletableFuture<Page<List<Order>>> returnOpenOrdersPage(String market,
                                                                 String address,
                                                                 Integer count,
                                                                 String cursor)

Returns a paginated list of all open orders for a given market or address. The response is similar to the response of returnOrderBook except that orders are sorted chronologically (oldest first) instead of by price. The data format of an order is the same, and there are some additional data points.

Parameters:

market - Required if address not specified.

address - Required if market not specified. Returns all open orders placed by the given address.

count - Number of records to be returned per request. Default 10

cursor - For pagination. Provide the value returned in the idex-next-cursor HTTP header to request the next slice (or page). This endpoint uses the orderNumber property of a record for the cursor.

Returns:

Future

returnOpenOrdersPage

public CompletableFuture<Page<List<Order>>> returnOpenOrdersPage(String market,
                                                                 String address,
                                                                 Integer count)

Returns a paginated list of all open orders for a given market or address. The response is similar to the response of returnOrderBook except that orders are sorted chronologically (oldest first) instead of by price. The data format of an order is the same, and there are some additional data points.

Parameters:

market - Required if address not specified.

address - Required if market not specified. Returns all open orders placed by the given address.

count - Number of records to be returned per request. Default 10

Returns:

Future

returnOrderStatus

public CompletableFuture<Order> returnOrderStatus(String orderHash)

Returns a single order.

Parameters:

orderHash - OrderHash

Returns:

Future

returnOrderTrades

public CompletableFuture<List<OrderTrade>> returnOrderTrades(String orderHash)

Returns all trades involving a given order hash.

Parameters:

orderHash - The order hash to query for associated trades.

Returns:

Future

returnTradeHistory

public CompletableFuture<List<TradeHistory>> returnTradeHistory(String market,
                                                                String address,
                                                                Long start,
                                                                Long end,
                                                                SortOrder sort,
                                                                Integer count,
                                                                String cursor)

Returns a paginated list of all trades for a given market or address, sorted by date.

Parameters:

market - Required if address not specified. Note market is separated with underscore. E.g ETH_ZCC, WBTC_OMG, TUSD_DAI

address - Required if market not specified. Returns all trades that involve the given address as the maker or taker. Note - When querying by address, the type property of a trade refers to the action taken by the user, and not relative to the market. This behavior is designed to mirror the "My Trades" section of the IDEX website.

start - Unix timestamp (in seconds) marking the time of the oldest trade that will be included.

end - Unix timestamp (in seconds) marking the time of the newest trade that will be included.

sort - Possible values are asc (oldest first) and desc (newest first). Defaults to desc.

count - Number of records to be returned per request. [1..100]

cursor - For pagination. Provide the value returned in the idex-next-cursor HTTP header to request the next slice (or page). This endpoint uses the tid property of a record for the cursor.

Returns:

Future

returnTradeHistoryPage

public CompletableFuture<Page<List<TradeHistory>>> returnTradeHistoryPage(String market,
                                                                          String address,
                                                                          LocalDateTime start,
                                                                          LocalDateTime end,
                                                                          SortOrder sortOrder,
                                                                          Integer count)

Returns Result Producer that paginats throught the results till no more is found! All trades for a given market or address, sorted by date.

Parameters:

market - Required if address not specified. Note market is separated with underscore. E.g ETH_ZCC, WBTC_OMG, TUSD_DAI

address - Required if market not specified. Returns all trades that involve the given address as the maker or taker. Note - When querying by address, the type property of a trade refers to the action taken by the user, and not relative to the market. This behavior is designed to mirror the "My Trades" section of the IDEX website.

start - Unix timestamp (in seconds) marking the time of the oldest trade that will be included.

end - Unix timestamp (in seconds) marking the time of the newest trade that will be included.

sortOrder - Possible values are asc (oldest first) and desc (newest first). Defaults to desc.

count - Number of records to be returned per request. [1..100]

Returns:

Results Producer

returnTradeHistoryPage

public CompletableFuture<Page<List<TradeHistory>>> returnTradeHistoryPage(String market,
                                                                          String address,
                                                                          LocalDateTime start,
                                                                          LocalDateTime end,
                                                                          SortOrder sortOrder,
                                                                          Integer count,
                                                                          String cursor)

Returns Result Producer that paginats throught the results till no more is found! All trades for a given market or address, sorted by date.

Parameters:

market - Required if address not specified. Note market is separated with underscore. E.g ETH_ZCC, WBTC_OMG, TUSD_DAI

address - Required if market not specified. Returns all trades that involve the given address as the maker or taker. Note - When querying by address, the type property of a trade refers to the action taken by the user, and not relative to the market. This behavior is designed to mirror the "My Trades" section of the IDEX website.

start - Unix timestamp (in seconds) marking the time of the oldest trade that will be included.

end - Unix timestamp (in seconds) marking the time of the newest trade that will be included.

sortOrder - Possible values are asc (oldest first) and desc (newest first). Defaults to desc.

count - Number of records to be returned per request. [1..100]

cursor - For pagination. Provide the value returned in the idex-next-cursor HTTP header to request the next slice (or page). This endpoint uses the tid property of a record for the cursor.

Returns:

Results Producer

returnTradeHistory

public CompletableFuture<List<TradeHistory>> returnTradeHistory(String market,
                                                                String address,
                                                                LocalDateTime start,
                                                                LocalDateTime end,
                                                                SortOrder sort,
                                                                Integer count,
                                                                String cursor)

Returns a paginated list of all trades for a given market or address, sorted by date.

Parameters:

market - Required if address not specified. Note market is separated with underscore. E.g ETH_ZCC, WBTC_OMG, TUSD_DAI

address - Required if market not specified. Returns all trades that involve the given address as the maker or taker. Note - When querying by address, the type property of a trade refers to the action taken by the user, and not relative to the market. This behavior is designed to mirror the "My Trades" section of the IDEX website.

start - Unix timestamp (in seconds) marking the time of the oldest trade that will be included.

end - Unix timestamp (in seconds) marking the time of the newest trade that will be included.

sort - Possible values are asc (oldest first) and desc (newest first). Defaults to desc.

count - Number of records to be returned per request. [1..100]

cursor - For pagination. Provide the value returned in the idex-next-cursor HTTP header to request the next slice (or page). This endpoint uses the tid property of a record for the cursor.

Returns:

Future

returnDepositsWithdrawals

public CompletableFuture<DepositsWithdrawals> returnDepositsWithdrawals(String address,
                                                                        LocalDateTime start,
                                                                        LocalDateTime end)

Returns your deposit and withdrawal history within a range, specified by the "start" and "end" optional properties. Withdrawals can be marked as "PENDING" if they are queued for dispatch, "PROCESSING" if the transaction has been dispatched, and "COMPLETE" if the transaction has been mined.

Parameters:

address - Address of the wallet

start - Optional Inclusive starting UNIX timestamp of returned result

end - Optional Inclusive ending UNIX timestamp of returned results. Defaults to current timestamp

Returns:

CompletableFuture

returnCompleteBalances

public CompletableFuture<Map<String,BalanceOrder>> returnCompleteBalances(String address)

Returns available balances for an address along with the amount of open orders for each token, indexed by token symbol.

Parameters:

address - ETH Address

Returns:

Future

returnBalances

public CompletableFuture<Map<String,BigDecimal>> returnBalances(String address)

Returns available balances for an address(total deposited minus amount in open orders) indexed by token symbol.

Parameters:

address - ETH Address

Returns:

Future

return24Volume

public CompletableFuture<Volume> return24Volume()

Returns the 24-hour volume for all markets, plus totals for primary currencies.

Returns:

Future

returnCurrencies

public CompletableFuture<Map<String,Currency>> returnCurrencies()

Returns an object of token data indexed by symbol.

Returns:

Future

returnCurrenciesWithPairs

public CompletableFuture<CurrencyPairs> returnCurrenciesWithPairs()

Returns all the currency pair availble on the IDEX Market.

Returns:

CurrencyPairs

returnTicker

public CompletableFuture<Ticker> returnTicker(String market)

Designed to behave similar to the API call of the same name provided by the Poloniex HTTP API, with the addition of highs and lows. Returns all necessary 24 hr data. Please note: If any field is unavailable due to a lack of trade history or a lack of 24hr data, the field will be set to 'null'. percentChange, baseVolume, and quoteVolume will never be 'null' but may be 0.

Parameters:

market - Market eg. ETH_SAN, ETH_AURA

Returns:

Future

shutdown

public void shutdown()
              throws IOException

Throws:

IOException