API version 2

Path prefix: /api/v2
Response format: JSON
Public/Private API

API v2 bevat zowel publieke API als privé-API

Public APIPrivate API
No authentication requiredAuthentication required
Unlimited6000 requests/keypair/5minutes, you can contact NLexch if you need more.
Ready to useYou need to generate access/secret key first
Authentication

To use private API, you need to get your access/secret key first which you can generate in your My Profile overview.

All private API requires 3 authentication parameters and zero or more API specific parameters. The 3 authentication parameters are:

access_keyYour access key.
toncetonce is a timestamp in integer, stands for milliseconds elapsed since Unix epoch. Each request must have a tonce greater than previous one.
signatureSignature of the API request, generated by you, use your secret key.

Signature is a hash of the request (in canonical string form):

hash = HMAC-SHA256(payload, secret_key).to_hex

Payload is a combination of HTTP verb, uri, and query string:

# canonical_verb is HTTP verb like GET/POST in upcase.
# canonical_uri is request path like /api/v2/markets.
# canonical_query is the request query sort in alphabetica order, including access_key and tonce, e.g. access_key=xxx&foo=bar&tonce=123456789
# The combined string looks like: GET|/api/v2/markets|access_key=xxx&foo=bar&tonce=123456789
def payload
  "#{canonical_verb}|#{canonical_uri}|#{canonical_query}"
end

Note: query parameters are sorted in payload, so it must be "access_key=xxx&foo=bar" not "foo=bar&&access_key=xxx".

Suppose my secret key is 'yyy', then the result of HMAC-SHA256 of above payload is:

hash = HMAC-SHA256('GET|/api/v2/markets|access_key=xxx&foo=bar&tonce=123456789', 'yyy').to_hex
    = 'e324059be4491ed8e528aa7b8735af1e96547fbec96db962d51feb7bf1b64dee'

Now we hav a signed request which can be used like this:

curl -X GET 'https://www.nlexch.com/api/v2/markets?access_key=xxx&foo=bar&tonce=123456789&signature=e324059be4491ed8e528aa7b8735af1e96547fbec96db962d51feb7bf1b64dee'
Response Format

Corresponding HTTP status code will be used in API response. The API will also return a JSON structure including error details on failed request, for example:

{"error":{"code":1001,"message":"market does not have a valid value"}}

All errors follow the message format above, only differentiates in code and message. Code is a defined error code, indicates the error's category, message is human-readable details.

The API returns HTTP 200 response on successful request, with requested data in JSON format.

Data TypeExampleComments
Market
{"at":1398410899, "ticker":{"buy":"3000.0","sell":"3100.0","low":"3000.0","high":"3000.0","last":"3000.0","vol":"0.11"}}

at: A timestamp in seconds since Epoch

buy/sell: Current buy/sell price

low/high: Lowest/highest price in last 24 hours

last: Last price

vol: Trade volume in last 24 hours

Member
{"sn":"NL5TFFOGQHEXCH","name":"foo","email":"foo@nlexch.com","activated":true,"accounts":[{"currency":"btc","balance":"100243840.0","locked":"0.0"},{"currency":"ltc","balance":"99999708.26","locked":"210.8"}]}

sn: Unique identifier of user

name: User name

email: User email

activated: Whether user is activated

accounts: User's accounts info, see Account

Account
{"currency":"btc","balance":"100243840.0","locked":"0.0"}

currency: Account type, like 'btc' or 'ltc'

balance: Account balance, exclude locked funds

locked: locked funds

Order
{"id":7,"side":"sell","price":"3100.0","avg_price":"3101.2","state":"wait","market":"ltcbtc","created_at":"2016-08-18T02:02:33Z","volume":"100.0","remaining_volume":"89.8","executed_volume":"10.2","trades":[{"id":2,"price":"3100.0","volume":"10.2","market":"ltcbtc","created_at":"2016-08-18T02:04:49Z","side":"sell"}]}

id: Unique order ID

side: Buy/Sell

price: Order price

avg_price: Average execution price

state: wait, done or cancel. 'wait' represents the order is active, it may be a new order or partial complete order; 'done' means the order has been fulfilled completely; 'cancel' means the order has been cancelled.

market: Which market the order belongs to

created_at: Order created time

volume: volume to buy/sell

remaining_volume: remaining_volume is always less or equal than volume

executed_volume: volume = remaining_volume + executed_volume

trades: the order's trade history, see Trade. Note: not all order include trades, only detailed order data returned by certain API will.

Trade
{"id":2,"price":"3100.0","volume":"10.2","market":"ltcbtc","created_at":"2016-08-18T02:04:49Z","side":"sell"}

id: Unique ID

price: trade price

volume: trade volume

market: the market trade belongs to, like 'ltcbtc'

created_at: trade time

OrderBook
{"asks": [...],"bids": [...]}

OrderBook shows orders on market.

Some Examples

Buy 1LTC at price 0.02BTC:

curl -X POST 'https://www.nlexch.com/api/v2/orders' -d 'access_key=your_access_key&tonce=1234567&signature=computed_signature&market=ltcbtc&price=0.02&side=buy&volume=1'

Create multiple orders with a single request:

curl -X POST 'https://www.nlexch.com/api/v2/orders/multi' -d 'access_key=your_access_key&tonce=123456789&signature=computed_signature&market=ltcbtc&orders[][price]=4000&orders[][side]=sell&orders[][volume]=0.5&orders[][price]=3999&orders[][side]=sell&orders[][volume]=0.99'
Tips/Caveats
APIDetail
POST /api/v2/order/deleteCancel order is an asynchronous operation. A success response only means your cancel request has been accepted, it doesn't mean the order has been cancelled. You should always use /api/v2/order or websocket api to get order's latest state.
POST /api/v2/orders/clearCancel all your orders is an asynchronous operation. A success response only means your request has been accepted. The orders in response may or may not have been cancelled yet.
API List

All API are listed below with details. Those require access_key/tonce/signature are private API.