Package org.knowm.xchange.luno
Class LunoAPIImpl
java.lang.Object
org.knowm.xchange.luno.LunoAPIImpl
- All Implemented Interfaces:
LunoAPI
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbalance()
Return the list of all accounts and their respective balances.cancelWithdrawal
(String withdrawalId) Cancel a withdrawal request.createAccount
(String currency, String name) Create an additional account for the specified currency.createFundingAddress
(String asset) Allocates a new receive address to your account.createQuote
(OrderType type, BigDecimal baseAmount, String pair) Creates a new quote to buy or sell a particular amount.
You can specify either the exact amount that you want to pay or the exact amount that you want too receive.
For example, to buy exactly 0.1 Bitcoin using ZAR, you would create a quote to BUY 0.1 XBTZAR.discardQuote
(String quoteId) Discard a quote.exerciseQuote
(String quoteId) Exercise a quote to perform the trade.Returns your fees and 30 day trading volume (as of midnight) for a given pair.getFundingAddress
(String asset, String address) Returns the default receive address associated with your account and the amount received via the address.Get an order by its id.Get the latest status of a quote.getWithdrawal
(String withdrawalId) Returns the status of a particular withdrawal request.listOrders
(State state, String pair) Returns a list of the most recently placed orders.listTrades
(String pair, Long since, Integer limit) Returns a list of your recent trades for a given pair, sorted by oldest first.
type in the response indicates the type of order that you placed in order to participate in the trade.
If is_buy in the response is true, then the order which completed the trade (market taker) was a bid order.Returns a list of bids and asks in the order book.Return a list of all pending transactions related to the account.
Unlike account entries, pending transactions are not numbered, and may be reordered, deleted or updated at any time.postLimitOrder
(String pair, OrderType type, BigDecimal volume, BigDecimal price, String baseAccountId, String counterAccountId) Create a new trade order.
Warning! Orders cannot be reversed once they have executed.postMarketOrder
(String pair, OrderType type, BigDecimal counterVolume, BigDecimal baseVolume, String baseAccountId, String counterAccountId) Create a new market order.
Warning! Orders cannot be reversed once they have executed.requestWithdrawal
(String type, BigDecimal amount, String beneficiaryId) Creates a new withdrawal request.Send Bitcoin from your account to a Bitcoin address or email address.
If the email address is not associated with an existing Luno account, an invitation to create an account and claim the funds will be sent.
Warning! Bitcoin transactions are irreversible.Request to stop an order.Market data API calls can be accessed by anyone without authentication.tickers()
Returns the latest ticker indicators from all active Luno exchanges.Returns a list of the most recent trades.transactions
(String id, int minRow, int maxRow) Return a list of transaction entries from an account.
Transaction entry rows are numbered sequentially starting from 1, where 1 is the oldest entry.Returns a list of withdrawal requests.
-
Constructor Details
-
LunoAPIImpl
-
-
Method Details
-
ticker
Description copied from interface:LunoAPI
Market data API calls can be accessed by anyone without authentication.- Specified by:
ticker
in interfaceLunoAPI
- Parameters:
pair
- required - Currency pair e.g. XBTZAR- Returns:
- Throws:
IOException
LunoException
-
tickers
Description copied from interface:LunoAPI
Returns the latest ticker indicators from all active Luno exchanges.- Specified by:
tickers
in interfaceLunoAPI
- Returns:
- Throws:
IOException
LunoException
-
orderbook
Description copied from interface:LunoAPI
Returns a list of bids and asks in the order book. Ask orders are sorted by price ascending. Bid orders are sorted by price descending. Note that multiple orders at the same price are not necessarily conflated.- Specified by:
orderbook
in interfaceLunoAPI
- Parameters:
pair
- required - Currency pair e.g. XBTZAR- Returns:
- Throws:
IOException
LunoException
-
trades
Description copied from interface:LunoAPI
Returns a list of the most recent trades. At most 100 results are returned per call.- Specified by:
trades
in interfaceLunoAPI
- Parameters:
pair
- required - Currency pair e.g. XBTZARsince
- optional - Fetch trades executed after this time, specified as a Unix timestamp in milliseconds.- Returns:
- Throws:
IOException
LunoException
-
createAccount
Description copied from interface:LunoAPI
Create an additional account for the specified currency. You must be verified to trade currency in order to be able to create an account. A user has a limit of 4 accounts per currency.- Specified by:
createAccount
in interfaceLunoAPI
- Parameters:
currency
- required - The currency code for the account you want to create e.g. XBT, IDR, MYR, ZARname
- required - The label to use for this account e.g. "Trading ACC".- Returns:
- Throws:
IOException
LunoException
-
balance
Description copied from interface:LunoAPI
Return the list of all accounts and their respective balances.- Specified by:
balance
in interfaceLunoAPI
- Returns:
- Throws:
IOException
LunoException
-
transactions
public LunoAccountTransactions transactions(String id, int minRow, int maxRow) throws IOException, LunoException Description copied from interface:LunoAPI
Return a list of transaction entries from an account.
Transaction entry rows are numbered sequentially starting from 1, where 1 is the oldest entry. The range of rows to return are specified with the min_row (inclusive) and max_row (exclusive) parameters. At most 1000 rows can be requested per call.
If min_row or max_row is non-positive, the range wraps around the most recent row. For example, to fetch the 100 most recent rows, use min_row=-100 and max_row=0.- Specified by:
transactions
in interfaceLunoAPI
- Parameters:
id
- required - Account IDminRow
- required - Minimum of the row range to return (inclusive)maxRow
- required - Maximum of the row range to return (exclusive)- Returns:
- Throws:
IOException
LunoException
-
pendingTransactions
Description copied from interface:LunoAPI
Return a list of all pending transactions related to the account.
Unlike account entries, pending transactions are not numbered, and may be reordered, deleted or updated at any time.- Specified by:
pendingTransactions
in interfaceLunoAPI
- Returns:
- Throws:
IOException
LunoException
-
listOrders
Description copied from interface:LunoAPI
Returns a list of the most recently placed orders. You can specify an optional state=PENDING parameter to restrict the results to only open orders. You can also specify the market by using the optional pair parameter. The list is truncated after 100 items.- Specified by:
listOrders
in interfaceLunoAPI
- Parameters:
state
- optional - Filter to only orders of this state e.g. PENDINGpair
- optional - Filter to only orders of this currency pair e.g. XBTZAR- Returns:
- Throws:
IOException
LunoException
-
postLimitOrder
public LunoPostOrder postLimitOrder(String pair, OrderType type, BigDecimal volume, BigDecimal price, String baseAccountId, String counterAccountId) throws IOException, LunoException Description copied from interface:LunoAPI
Create a new trade order.
Warning! Orders cannot be reversed once they have executed. Please ensure your program has been thoroughly tested before submitting orders.
If no base_account_id or counter_account_id are specified, your default base currency or counter currency account will be used. You can find your account IDs by calling the Balances API https://www.luno.com/en/api#accounts-balances.- Specified by:
postLimitOrder
in interfaceLunoAPI
- Parameters:
pair
- required - The currency pair to trade e.g. XBTZARtype
- required - "BID" for a bid (buy) limit order or "ASK" for an ask (sell) limit order.volume
- required - Amount of Bitcoin to buy or sell as a decimal string in units of BTC e.g. "1.423".price
- required - Limit price as a decimal string in units of ZAR/BTC e.g. "1200".baseAccountId
- optional - The base currency account to use in the trade.counterAccountId
- optional - The counter currency account to use in the trade.- Returns:
- Throws:
IOException
LunoException
-
postMarketOrder
public LunoPostOrder postMarketOrder(String pair, OrderType type, BigDecimal counterVolume, BigDecimal baseVolume, String baseAccountId, String counterAccountId) throws IOException, LunoException Description copied from interface:LunoAPI
Create a new market order.
Warning! Orders cannot be reversed once they have executed. Please ensure your program has been thoroughly tested before submitting orders.
If no base_account_id or counter_account_id are specified, your default base currency or counter currency account will be used. You can find your account IDs by calling the Balances API https://www.luno.com/en/api#accounts-balances.
A market order executes immediately, and either buys as much bitcoin that can be bought for a set amount of fiat currency, or sells a set amount of bitcoin for as much fiat as possible.- Specified by:
postMarketOrder
in interfaceLunoAPI
- Parameters:
pair
- required - The currency pair to trade e.g. XBTZARtype
- required - "BUY" to buy bitcoin, or "SELL" to sell bitcoin.counterVolume
- required, if type is "BUY" - For a "BUY" order: amount of local currency (e.g. ZAR, MYR) to spend as a decimal string in units of the local currency e.g. "100.50".baseVolume
- required, if type is "SELL" - For a "SELL" order: amount of Bitcoin to sell as a decimal string in units of BTC e.g. "1.423".baseAccountId
- optional - The base currency account to use in the trade.counterAccountId
- optional - The counter currency account to use in the trade.- Returns:
- Throws:
IOException
LunoException
-
stopOrder
Description copied from interface:LunoAPI
Request to stop an order.- Specified by:
stopOrder
in interfaceLunoAPI
- Parameters:
orderId
- required - The order reference as a string e.g. BXMC2CJ7HNB88U4- Returns:
- Throws:
IOException
LunoException
-
getOrder
Description copied from interface:LunoAPI
Get an order by its id.- Specified by:
getOrder
in interfaceLunoAPI
- Parameters:
orderId
- required - The order ID- Returns:
- Throws:
IOException
LunoException
-
listTrades
public LunoUserTrades listTrades(String pair, Long since, Integer limit) throws IOException, LunoException Description copied from interface:LunoAPI
Returns a list of your recent trades for a given pair, sorted by oldest first.
type in the response indicates the type of order that you placed in order to participate in the trade.
If is_buy in the response is true, then the order which completed the trade (market taker) was a bid order.- Specified by:
listTrades
in interfaceLunoAPI
- Parameters:
pair
- required - Filter to trades of this currency pair e.g. XBTZARsince
- optional - Filter to trades on or after this timestamp, e.g. 1470810728478limit
- optional - Limit to this number of trades (min 1, max 100, default 100)- Returns:
- Throws:
IOException
LunoException
-
feeInfo
Description copied from interface:LunoAPI
Returns your fees and 30 day trading volume (as of midnight) for a given pair.- Specified by:
feeInfo
in interfaceLunoAPI
- Parameters:
pair
- required - Filter to trades of this currency pair e.g. XBTZAR- Returns:
- Throws:
IOException
LunoException
-
getFundingAddress
public LunoFundingAddress getFundingAddress(String asset, String address) throws IOException, LunoException Description copied from interface:LunoAPI
Returns the default receive address associated with your account and the amount received via the address. You can specify an optional address parameter to return information for a non-default receive address. In the response, total_received is the total confirmed Bitcoin amount received excluding unconfirmed transactions. total_unconfirmed is the total sum of unconfirmed receive transactions.- Specified by:
getFundingAddress
in interfaceLunoAPI
- Parameters:
asset
- required - Currency code of the asset e.g. XBTaddress
- optional - Specific Bitcoin address to retrieve. If not provided, the default address will be used.- Returns:
- Throws:
IOException
LunoException
-
createFundingAddress
Description copied from interface:LunoAPI
Allocates a new receive address to your account. There is a rate limit of 1 address per hour, but bursts of up to 10 addresses are allowed.- Specified by:
createFundingAddress
in interfaceLunoAPI
- Returns:
- Throws:
IOException
LunoException
-
withdrawals
Description copied from interface:LunoAPI
Returns a list of withdrawal requests.- Specified by:
withdrawals
in interfaceLunoAPI
- Returns:
- Throws:
IOException
LunoException
-
requestWithdrawal
public LunoWithdrawals.Withdrawal requestWithdrawal(String type, BigDecimal amount, String beneficiaryId) throws IOException, LunoException Description copied from interface:LunoAPI
Creates a new withdrawal request.- Specified by:
requestWithdrawal
in interfaceLunoAPI
- Parameters:
type
- required - Withdrawal types e.g. ZAR_EFT, NAD_EFT, KES_MPESA, MYR_IBG, IDR_LLGamount
- required - Amount to withdraw. The currency depends on the type.beneficiaryId
- optional - The beneficiary ID of the bank account the withdrawal will be paid out to. This parameter is required if you have multiple bank accounts. Your bank account beneficiary ID can be found by clicking on the beneficiary name on the Beneficiaries page [https://www.luno.com/wallet/beneficiaries].- Returns:
- Throws:
IOException
LunoException
-
getWithdrawal
public LunoWithdrawals.Withdrawal getWithdrawal(String withdrawalId) throws IOException, LunoException Description copied from interface:LunoAPI
Returns the status of a particular withdrawal request.- Specified by:
getWithdrawal
in interfaceLunoAPI
- Parameters:
withdrawalId
- required - Withdrawal ID to retrieve.- Returns:
- Throws:
IOException
LunoException
-
cancelWithdrawal
public LunoWithdrawals.Withdrawal cancelWithdrawal(String withdrawalId) throws IOException, LunoException Description copied from interface:LunoAPI
Cancel a withdrawal request. This can only be done if the request is still in state PENDING.- Specified by:
cancelWithdrawal
in interfaceLunoAPI
- Parameters:
withdrawalId
- required - ID of the withdrawal to cancel.- Returns:
- Throws:
IOException
LunoException
-
send
public LunoBoolean send(BigDecimal amount, String currency, String address, String description, String message) throws IOException, LunoException Description copied from interface:LunoAPI
Send Bitcoin from your account to a Bitcoin address or email address.
If the email address is not associated with an existing Luno account, an invitation to create an account and claim the funds will be sent.
Warning! Bitcoin transactions are irreversible. Please ensure your program has been thoroughly tested before using this call.- Specified by:
send
in interfaceLunoAPI
- Parameters:
amount
- required - Amount to send as a decimal string.currency
- required - Currency to send e.g. XBTaddress
- required - Destination Bitcoin address or email address to send to.description
- optional - Description for the transaction to record on the account statement.message
- optional - Message to send to the recipient. This is only relevant when sending to an email address.- Returns:
- Throws:
IOException
LunoException
-
createQuote
public LunoQuote createQuote(OrderType type, BigDecimal baseAmount, String pair) throws IOException, LunoException Description copied from interface:LunoAPI
Creates a new quote to buy or sell a particular amount.
You can specify either the exact amount that you want to pay or the exact amount that you want too receive.
For example, to buy exactly 0.1 Bitcoin using ZAR, you would create a quote to BUY 0.1 XBTZAR. The returned quote includes the appropriate ZAR amount. To buy Bitcoin using exactly ZAR 100, you would create a quote to SELL 100 ZARXBT. The returned quote specifies the Bitcoin as the counter amount that will be returned.
An error is returned if your account is not verified for the currency pair, or if your account would have insufficient balance to ever exercise the quote.- Specified by:
createQuote
in interfaceLunoAPI
- Parameters:
type
- required - Possible types: BUY, SELLbaseAmount
- required - Amount to buy or sell in the pair base currency.pair
- required - Currency pair to trade e.g. XBTZAR, XBTMYR. The pair can also be flipped if you want to buy or sell the counter currency (e.g. ZARXBT).- Returns:
- Throws:
IOException
LunoException
-
getQuote
Description copied from interface:LunoAPI
Get the latest status of a quote.- Specified by:
getQuote
in interfaceLunoAPI
- Parameters:
quoteId
- required - ID of the quote to retrieve.- Returns:
- Throws:
IOException
LunoException
-
exerciseQuote
Description copied from interface:LunoAPI
Exercise a quote to perform the trade. If there is sufficient balance available in your account, it will be debited and the counter amount credited.
An error is returned if the quote has expired or if you have insufficient available balance.- Specified by:
exerciseQuote
in interfaceLunoAPI
- Parameters:
quoteId
- required - ID of the quote to exercise.- Returns:
- Throws:
IOException
LunoException
-
discardQuote
Description copied from interface:LunoAPI
Discard a quote. Once a quote has been discarded, it cannot be exercised even if it has not expired yet.- Specified by:
discardQuote
in interfaceLunoAPI
- Parameters:
quoteId
- required - ID of the quote to discard.- Returns:
- Throws:
IOException
LunoException
-