API Documentation

Read first

POST requests require a JSON payload, GET requests use URL encoded parameters. All requests return JSON data. Errors are reported in a 'message' field.

Authentication

All private API calls require providing an account_id with your request.

Demo

Create Account

Request: GET /api/v1/demo/account/create/

Response:

{
    "account_id": "3ad99c176956667e2c3252f82e8c290c32d82c3c8c13f7f43ba45c6549362ad8"
}
    

Delete Account

Request: GET /api/v1/demo/account/delete/

Parameter	Type	Required
account_id	string	Yes

Response:

{
    "result": "success"
}
    

Query Account

Request: GET /api/v1/demo/account/query/

Response:

{
    "accounts": [{
        "account_id": "362cd92f7cc7b5895c3319a528a5831c1c0960efec8fefaf79760e5d38eb3da4",
        "time": "2021-01-09 12:49:01"
    }, {
        "account_id": "3ad99c176956667e2c3252f82e8c290c32d82c3c8c13f7f43ba45c6549362ad8",
        "time": "2021-01-09 12:30:52"
    }, {
        "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
        "time": "2021-01-09 12:20:53"
    }]
}
    

Deposit

Request: GET /api/v1/demo/account/deposit/

Parameter	Type	Required
account_id	string	Yes
currency_code	string	Yes
amount	float	Yes

Response:

{
    "result": "success"
}
    

Withdraw

Request: GET /api/v1/demo/account/withdraw/

Parameter	Type	Required
account_id	string	Yes
currency_code	string	Yes
amount	float	Yes

Response:

{
    "result": "success"
}
    

Public

Currencies

Request: GET /api/v1/currencies/

Parameter	Type	Required
currency_code	string	No

Response:

{
    "currencies": [{
        "code": "BTC",
        "precision": 8
    }, {
        "code": "ETH",
        "precision": 8
    }, {
        "code": "EUR",
        "precision": 2
    }]
}
    

Instruments

Request: GET /api/v1/instruments/

Parameter	Type	Required
instrument_code	string	No

Response:

{
    "instruments": [{
        "instrument_code": "BTC_EUR",
        "base": "BTC",
        "quote": "EUR",
        "amount_precision": 2,
        "market_precision": 8,
        "min_size": 10
    }, {
        "instrument_code": "ETH_EUR",
        "base": "ETH",
        "quote": "EUR",
        "amount_precision": 2,
        "market_precision": 8,
        "min_size": 10
    }]
}
    

Market Ticker

Request: GET /api/v1/marketticker/

Parameter	Type	Required
instrument_code	string	No

Response:

{
    "instruments": [{
        "instrument_code": "ETH_EUR",
        "best_ask": 1000,
        "best_bid": 900,
        "last_price": 900,
        "time": "2021-01-09T11:27:00"
    }]
}
    

Order Book

Request: GET /api/v1/orderbook/

Parameter	Type	Required
instrument_code	string	Yes

Response:

{
    "instrument_code": "ETH_EUR",
    "time": "2021-01-09T11:29:40",
    "asks": [{
        "amount": 5,
        "filled_amount": 0.2,
        "price": 900
    }],
    "bids": [{
        "amount": 2,
        "filled_amount": 0.1,
        "price": 997
    }, {
        "amount": 0.5,
        "filled_amount": 0,
        "price": 999
    }]
}
    

Ping

Request: GET /api/v1/ping

Response:

{
    "result": "pong"
}
    

Time

Request: GET /api/v1/time

Response:

{
    "iso": "2021-01-09T11:31:32",
    "epoch": 1610188292
}
    

Private

Balances

Request: GET /api/v1/account/balances/

Parameter	Type	Required
account_id	string	Yes
currency_code	string	No

Response:

{
    "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
    "balances": [{
        "currency_code": "EUR",
        "available": 0,
        "locked": 0,
        "time": "2021-01-08 12:32:56"
    }]
}
    

Cancel Order

Request: GET /api/v1/account/orders/cancel/

Parameter	Type	Required
account_id	string	Yes
order_id	string	Yes

Response:

{
    "result": "success"
}
    

Create Order

Request: POST /api/v1/account/orders/create/

Parameter	Type	Required
account_id	string	Yes
amount	float	Yes
instrument_code	string	Yes
side	string	Yes
type	string	Yes
price	float	No

Response:

{
    "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
    "amount": "0.1",
    "filled_amount": "0.1",
    "instrument_code": "ETH_EUR",
    "price": "997",
    "order_id": "2021-01-09T01:29:00-1995522294",
    "side": "BUY",
    "status": "FILLED",
    "time": "2021-01-09T01:29:00",
    "type": "MARKET"
}
    

Query Order

Request: GET /api/v1/account/orders/query/

Parameter	Type	Required
account_id	string	Yes
order_id	string	No

Response:

{
    "order": {
        "order_id": "2021-01-09T01:16:46-1889284441",
        "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
        "last_updated": "",
        "price": 900,
        "amount": 5,
        "filled_amount": 0.2,
        "instrument_code": "ETH_EUR",
        "side": "BUY",
        "status": "CANCELLED",
        "time": "2021-01-09 01:16:46",
        "type": "LIMIT",
        "trades": [{
            "trade_id": "2021-01-09T01:17:43-978418446",
            "order_id": "2021-01-09T01:16:46-1889284441",
            "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
            "instrument_code": "ETH_EUR",
            "side": "BUY",
            "amount": 0.1,
            "price": 900,
            "time": "2021-01-09 01:17:43"
        }, {
            "trade_id": "2021-01-09T01:28:26-2118600236",
            "order_id": "2021-01-09T01:16:46-1889284441",
            "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
            "instrument_code": "ETH_EUR",
            "side": "BUY",
            "amount": 0.1,
            "price": 900,
            "time": "2021-01-09 01:28:26"
        }]
    }
}
    

Query Trade

Request: GET /api/v1/account/trades/query/

Parameter	Type	Required
account_id	string	Yes
trade_id	string	No

Response:

{
    "trade_id": "2021-01-09T01:29:00-142763372",
    "order_id": "2021-01-09T01:29:00-1995522294",
    "account_id": "6b86b273ff34fce19d6b804eff5a3f57",
    "instrument_code": "ETH_EUR",
    "side": "BUY",
    "amount": 0.1,
    "price": 997,
    "time": "2021-01-09 01:29:00"
}