Luno API
Build custom applications or integrate payments with our powerful Bitcoin API
The Luno API gives you the ability to:
- Access current and historic Bitcoin and Ethereum market data
- Submit trade orders and view order status
- Buy and sell Bitcoin and Ethereum
- Send and receive Bitcoin and Ethereum
- Generate Bitcoin and Ethereum wallet addresses
The Luno API makes Bitcoin and Ethereum available to anyone. See also: Luno for Business
Security
Make sure to always use HTTPS when calling the API. Non-TLS HTTP requests cause error 403 to be returned. Using non-TLS requests can leak your authentication credentials.
Make sure that your client validates the server's SSL certificate. Many libraries (e.g. urllib2 in Python2) don't validate server certificates by default. Failing to verify the server certificate makes your application vulnerable to man-in-the-middle attack.
Conventions
Timestamps are always represented as an integer number of milliseconds since the UTC Epoch (a Unix timestamp).
Prices and volumes are always represented as a decimal strings e.g. "123.3432". We use strings instead of floats to preserve the precision.
Parameters for POST calls are sent as URL-encoded forms (application/x-www-form-urlencoded).
Rate limiting
Calls to the Market Data APIs are rate limited to 1 call per 10 seconds. All other API calls are rate limited to 1 call per second. API call rate limits allow bursts of up to five consecutive calls. Exceeding the limit causes HTTP error code 429 to be returned.
Libraries
The Go library is the recommended way to access the API: view it on GitHub.
The following libraries were implemented by third parties or are no longer under active development and are listed here for convenience. No support for them is provided by Luno and they may be out of date. A thorough review of the code is recommended before including them in any project.
Market data
Market data API calls can be accessed by anyone without authentication.
Ticker
Returns the latest ticker indicators.
Definition
GET https://api.mybitx.com/api/1/tickerArguments
pair |
string | required | Currency pair e.g. XBTZAR or ETHXBT |
Example request
$ curl https://api.mybitx.com/api/1/ticker?pair=XBTZARExample response
{
"ask": "1050.00",
"timestamp": 1366224386716,
"bid": "924.00",
"rolling_24_hour_volume": "12.52",
"last_trade": "950.00"
}All tickers
Returns the latest ticker indicators from all active Luno exchanges.
Definition
GET https://api.mybitx.com/api/1/tickersExample request
$ curl https://api.mybitx.com/api/1/tickersExample response
{
"tickers": [
{
"timestamp": 1405413955793,
"bid": "6801.00",
"ask": "6900.00",
"last_trade": "6900.00",
"rolling_24_hour_volume": "12.455579",
"pair":"XBTZAR"
},
{
"timestamp": 1405413955337,
"bid": "5000.00",
"ask":"6968.00",
"last_trade": "6830.00",
"rolling_24_hour_volume": "0.00",
"pair":"XBTNAD"
}
]
}Order Book
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.
Definition
GET https://api.mybitx.com/api/1/orderbookArguments
pair |
string | required | Currency pair e.g. XBTZAR or ETHXBT |
Example request
$ curl https://api.mybitx.com/api/1/orderbook?pair=XBTZARExample response
{
"timestamp": 1366305398592,
"bids": [
{
"volume": "0.10",
"price": "1100.00"
},
{
"volume": "0.10",
"price": "1000.00"
},
{
"volume": "0.10",
"price": "900.00"
}
],
"asks": [
{
"volume": "0.10",
"price": "1180.00"
},
{
"volume": "0.10",
"price": "2000.00"
}
]
}Trades
Returns a list of the most recent trades. At most 100 results are returned per call.
Definition
GET https://api.mybitx.com/api/1/tradesArguments
pair |
string | required | Currency pair e.g. XBTZAR or ETHXBT |
since |
integer | optional | Fetch trades executed after this time, specified as a Unix timestamp in milliseconds. |
Example request
$ curl https://api.mybitx.com/api/1/trades?pair=XBTZARExample response
{
"trades": [
{
"volume": "0.10",
"timestamp": 1366052621774,
"price": "1000.00",
"is_buy": true
},
{
"volume": "1.20",
"timestamp": 1366052621770,
"price": "1020.50",
"is_buy": false
}
]
}{msg}}AuthenticationAuthentication
Some API calls require your application to authenticate itself. This is done using an API key associated with your account. You can create an API key by visiting the API Keys section on the settings page.
An API key consists of an id and a secret. For example: cnz2yjswbv3jd (key id) and 0hydMZDb9HRR3Qq-iqALwZtXLkbLR4fWxtDZvkB9h4I (key secret).
API requests are authenticated using HTTP basic authentication with the key id as the username and the key secret as the password. A missing, incorrect or revoked key causes error 401 to be returned.
Permissions
Each API key is granted a set of permissions when it is created. The key can only be used to call the permitted API functions.
Here is a list of the possible permissions:
Perm_R_Balance = 1(View balance)Perm_R_Transactions = 2(View transactions)Perm_W_Send = 4(Send to any address)Perm_R_Addresses = 8(View addresses)Perm_W_Addresses = 16(Create addresses)Perm_R_Orders = 32(View orders)Perm_W_Orders = 64(Create orders)Perm_R_Withdrawals = 128(View withdrawals)Perm_W_Withdrawals = 256(Create withdrawals)Perm_R_Merchant = 512(View merchant invoices)Perm_W_Merchant = 1024(Create merchant invoices)Perm_W_ClientDebit = 8192(Debit accounts)Perm_W_ClientCredit = 16384(Credit accounts)Perm_R_Beneficiaries = 32768(View beneficiaries)Perm_W_Beneficiaries = 65536(Create and delete beneficiaries)
A set of permissions is represented as the bitwise OR of each
permission in the set.
For example the set of permissions required to view balances and
orders is Perm_R_Balance | Perm_R_Orders = 33.
Accounts
All transactions on the Luno platform operate on accounts. Each account is denominated in a single currency and contains an ordered list of entries that track its running balance.
Each account has a separate balance and available balance. The available balance may be lower than the balance if some funds have been reserved (e.g. for a open limit order). Account entries affect the balance and available balance independently.
Account entries are numbered sequentially. It is guaranteed that entries are never reordered or deleted. It is also guaranteed that the core attributes of the entry (the running balances and index) are never modified. Therefore, an account acts as an append-only log of transactions.
Create Account
Create an additional account for the specified currency.
Definition
POST https://api.mybitx.com/api/1/accountsArguments
currency |
string | required | The currency code for the account you want to create e.g. XBT, IDR, MYR, ZAR |
name |
string | required | The label to use for this account e.g. "Trading ACC". |
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.
Example request
$ curl -u keyid:keysecret -X POST -d currency=XBT -d name=Moon https://api.mybitx.com/api/1/accountsExample response
{
"id": "319323232",
"name": "Moon",
"currency": "XBT"
}Permissions required
Perm_W_Addresses
Balances
Return the list of all accounts and their respective balances.
Definition
GET https://api.mybitx.com/api/1/balanceExample request
$ curl -u keyid:keysecret https://api.mybitx.com/api/1/balanceExample response
{
"balance": [
{
"account_id": "1224342323",
"asset": "XBT",
"balance": "1.012423",
"reserved": "0.01",
"unconfirmed": "0.421",
"name": "XBT Account"
},
{
"account_id": "2997473",
"asset": "ZAR",
"balance": "1000.00",
"reserved": "0.00",
"unconfirmed": "0.00",
"name": "ZAR Account"
}
]
}Permissions required
Perm_R_Balance
Transactions
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.
Definition
GET https://api.mybitx.com/api/1/accounts/:id/transactionsArguments
id |
string | required | Account ID |
min_row |
int | required | Minimum of the row range to return (inclusive) |
max_row |
int | required | Maximum of the row range to return (exclusive) |
Example request
$ curl -u keyid:keysecret https://api.mybitx.com/api/1/accounts/319232323/transactions?min_row=1&max_row=100Example response
{
"id": "319232323",
"transactions": [
{
"row_index": 2,
"timestamp": 1429908835000,
"balance": 0.08,
"available": 0.08,
"balance_delta": -0.02,
"available_delta": -0.02,
"currency": "XBT",
"description": "Sold 0.02 BTC"
},
{
"row_index": 1,
"timestamp": 1429908701000,
"balance": 0.1,
"available": 0.1,
"balance_delta": 0.1,
"available_delta": 0.1,
"currency": "XBT",
"description": "Bought 0.1 BTC"
}
]
}Permissions required
Perm_R_Transactions
Pending transactions
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.
Definition
GET https://api.mybitx.com/api/1/accounts/:id/pendingArguments
id |
string | required | Account ID |
Example request
$ curl -u keyid:keysecret https://api.mybitx.com/api/1/accounts/319232323/pendingExample response
{
"id": "319232323",
"pending": [
{
"timestamp": 1429908835000,
"balance": 0.03,
"available": 0.03,
"balance_delta": 0.03,
"available_delta": 0.03,
"currency": "XBT",
"description": "Received Bitcoin - 1 of 3 confirmations"
}
]
}Permissions required
Perm_R_Transactions
Orders
Trading on the market is done by submitting trade orders. After a new order has been created, it is submitted for processing by the order matching engine. The order then either matches against an existing order in the order book and is filled or it rests in the order book until it is stopped.
Click here to read more about how order matching works.
List Orders
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.
Definition
GET https://api.mybitx.com/api/1/listordersArguments
state |
string | optional | Filter to only orders of this state e.g. PENDING |
pair |
string | optional | Filter to only orders of this currency pair e.g. XBTZAR or ETHXBT |
Example request
$ curl -u keyid:keysecret https://api.mybitx.com/api/1/listordersExample response
{
"orders": [
{
"base": "0.027496",
"counter": "81.140696",
"creation_timestamp": 1423990327333,
"expiration_timestamp": 0,
"completed_timestamp": 1423991515534,
"fee_base": "0.00",
"fee_counter": "0.00",
"limit_price": "2951.00",
"limit_volume": "0.027496",
"order_id": "BXF3J88PZAYGXH7",
"pair": "XBTZAR",
"state": "COMPLETE",
"type": "ASK",
}
]
}- BID
- bid (buy) limit order
- ASK
- ask (sell) limit order
- PENDING
- The order has been placed. Some trades may have taken place but the order is not filled yet.
- COMPLETE
- The order is no longer active. It has been settled or has been cancelled.
The base and counter amounts
are the principal amounts that were traded, ignoring fees.
For example, if the order resulted in a single trade of
1 BTC for 1000 ZAR, then base=1 BTC and
counter=1000 ZAR.
The fee_base and fee_counter amounts
are the fees debited after the trade principal amounts.
For example, for a buy order, base - base_fee would
be credited to the BTC account and
counter + counter_fee
would be debited from the ZAR account.
Similarly, for a sell order, counter - counter_fee
would be credited to the ZAR account and
base + base_fee
would be debited from the BTC account.
The pair specifies the market.
Permissions required
Perm_R_Orders
Post Limit Order
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.
It’s never too late to get started.
Buy, store and learn about Bitcoin and Ethereum now.
