Orders

This section give's control and information for all the orders performed by any user.
Order can be any Buy/Sell order (Market or Limit) with any currency.
Order must be created with a base amount,base currency,quote amount and quote currency,(and limit amount in case of limit orders).
Admin logged in - can see all the orders created by users.
User logged in - can see it's own orders data,create new orders (in case he has sufficent balance).

get-all-orders-list

Returns a list of all orders (open and closed)

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

get/orders

Response samples

200
401

application/json

{"api_message": "<string>", "api_data": {"orders": [{"username": "<string>", "id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 1, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "null", "trade_status": "null", "trade_payload": "null", "settlement_id": "<string>", "ip": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>" } ], "last_at": "<datetime string>", "total_items": 1 } }

post-new-order

Create new order - must given quote id for market orders

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Request Body schema: application/json
required

raw(json)

quote_id	string
order_type	string MARKET/LIMIT
order_amount	string amount of the currency you want to sell/buy depending on a side
order_price	string required if the order is LIMIT to set the prefer price of the quote_currency in quantity of 1
base_currency	string
quote_currency	string
side	string BUY/SELL
user_id	string

Responses

200
Success

401
Unauthorized

500
Internal Server Error

post/orders

Request samples

Payload

application/json

{"quote_id": "b01vT1VyRC9XVGcrUk9nNnkzVlkybUZ2Ti93ZFdvdVhnUC8rTHd4ZGV1T2gvdDc0Z1J5eFlnPT0", "order_type": "MARKET", "order_amount": "10000", "order_price": "1", "base_currency": "USD", "quote_currency": "TBTC", "side": "BUY", "user_id": "Y0ZuTVFCNnl6S3pISDhMTXVYSHBwZz09" }

Response samples

200
401
500

application/json

{"api_message": "<string>", "api_data": {"id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 1, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "<string>", "trade_status": "<string>", "trade_payload": "<string>", "settlement_id": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>" } }

get-exact-order-info

Return information about given order_id from orders table

SecurityAuthorization

Request

path Parameters

order_id

required

string

order_id path parameter

Example: <order_id>

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

403
Forbidden

get/orders/{order_id}

Response samples

200
401
403

application/json

{"api_message": "<string>", "api_data": {"username": "<string>", "id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 1, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "null", "trade_status": "null", "trade_payload": "null", "settlement_id": "<string>", "ip": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>" } }

update-exact-limit-order

Update specific order with given order_id. The order can be updated only if it a limit order

SecurityAuthorization

Request

path Parameters

order_id

required

string

order_id path parameter

Example: <order_id>

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Request Body schema: application/json
required

raw(json)

order_type	string LIMIT only
order_amount	string
order_price	string
base_currency	string
quote_currency	string
side	string
user_id	string

Responses

200
Success

401
Unauthorized

500
Internal Server Error

put/orders/{order_id}

Request samples

Payload

application/json

{"order_type": "LIMIT", "order_amount": "1", "order_price": "1500", "base_currency": "USD", "quote_currency": "GTETH", "side": "BUY", "user_id": "Y0ZuTVFCNnl6S3pISDhMTXVYSHBwZz09" }

Response samples

200
401
500

application/json

{"api_message": "<string>", "api_data": {"id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 1, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "<string>", "trade_status": "<string>", "trade_payload": "<string>", "settlement_id": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>" } }

delete-exact-limit-order

Cancel a specific order by a given order_id
* Can only cancel pending LIMIT orders *

SecurityAuthorization

Request

path Parameters

order_id

required

string

order_id path parameter

Example: <order_id>

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

204
No Content (Success)

401
Unauthorized

500
Internal Server Error

delete/orders/{order_id}

Response samples

204
401
500

application/json

{ }

get-open-orders-list

Returns a list of open orders

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

get/oders/open

Response samples

200
401

application/json

{"api_message": "<string>", "api_data": {"orders": [{"username": "<string>", "id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 20000, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "null", "trade_status": "null", "trade_payload": "null", "settlement_id": "<string>", "ip": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>", "userstatus": "ACTIVE", "user_created_at": "datetime string", "user_updated_at": "datetime string" } ], "last_at": "<datetime string>", "total_items": 1 } }

get-frozen-orders-list-info

Return frozen orders list information from orders table

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

get/orders/frozen

Response samples

200
401

application/json

{"api_message": "<string>", "api_data": {"orders": [{"username": "<string>", "id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 1, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "null", "trade_status": "null", "trade_payload": "null", "settlement_id": "<string>", "ip": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>" } ], "last_at": "<datetime string>", "total_items": 1 } }

get-lp-balances-info

Returns information about LP's balances and available balances per liquidity provider

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

403
Forbidden

get/orders/balance

Response samples

200
401
403

application/json

{"api_message": "<string>", "api_data": {"balance": {"[liquidity provider name]": {"[currency name]": {"balance": 100, "availableBalance": 40 } } } } }

get-closed-orders-list

Returns list of closed orders

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

get/orders/history

Response samples

200
401

application/json

{"api_message": "<string>", "api_data": {"orders": [{"username": "<string>", "id": "<string>", "user_id": "<string>", "ref_account_id": "<string>", "coid": "<string>", "base_currency": "<string>", "quote_currency": "<string>", "base_amount": 1, "quote_amount": 1, "lp_amount": 1, "limit_amount": 1, "discount_rate": 1, "side": "<string>", "type": "<string>", "time_in_force": "<string>", "liquidity_id": "<string>", "liquidity_rate": 1, "user_rate": 1, "feerule_id": "<string>", "feerule_rate": 1, "feerule_currency": "<string>", "status": "<string>", "payment_id": "<string>", "payment_status": "null", "trade_status": "null", "trade_payload": "null", "settlement_id": "<string>", "ip": "<string>", "created_by_id": "<string>", "created_at": "<datetime string>", "updated_at": "<datetime string>" } ], "last_at": "<datetime string>", "total_items": 1 } }

get-quote/quotes

Returns quote_rate and related data for requested base_currency, quote_currency, side and amount.
The payload has to be valid: every request object has to include base_currency, quote_currency
side and base_amount query params. Every related query param to the request object
has to have the same index. If there is only one request object the indexes are not required.

SecurityAuthorization

Request

query Parameters

base_currency[0] required	string base_currency query param with 0 index Example: base_currency[0]=USD
base_currency[1] required	string base_currency query param with 1 index Example: base_currency[1]=GTETH
quote_currency[0] required	string quote_currency query param with 0 index Example: quote_currency[0]=TBTC
quote_currency[1] required	string quote_currency query param with 1 index Example: quote_currency[1]=USD
side[0] required	string side query param with 0 index Example: side[0]=BUY
side[1] required	string side query param with 1 index Example: side[1]=SELL
base_amount[0] required	string base_amount query param with 0 index Example: base_amount[0]=10000
base_amount[1] required	string base_amount query param with 1 index Example: base_amount[1]=2

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

get/orders/quote

Response samples

200
401

application/json

{"api_message": "<string>", "api_data": {"quotes": [{"base_side": "<string>", "base_currency": "<string>", "base_amount": 100, "quote_currency": "USD", "quote_rate": 20 } ] } }

post-quote-for-new-order

Get a quote (price) for creating a new order.

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Request Body schema: application/json
required

raw(json)

base_currency	string
quote_currency	string
side	string
amount	number

Responses

200
Success

401
Unauthorized

422
Unprocessable Content

500
Internal Server Error

post/orders/quote

Request samples

Payload

application/json

{"base_currency": "TBTC", "quote_currency": "USD", "side": "SELL", "amount": 0.1 }

Response samples

200
401
422
500

application/json

{"api_message": "<string>", "api_data": {"quote": {"quote_id": "<string>", "lp_id": "<string>", "lp_name": "<string>", "quote_rate": 1, "discount_rate": 1, "total_fee": 1, "feerule_id": "<string>", "quote_total_fee": 1, "base_amount": 1, "side": "BUY", "base_currency": "<string>", "user_id": "<string>", "quote_amount": 1, "quote_currency": "<string>", "valid": true } } }

refresh-status-of-all-live-orders

Refresh status of all existing orders that not in final status (PENDING orders)

SecurityAuthorization

Request

header Parameters

Authorization required	string auth header for JWT Example: <JWT token>
username required	string auth header for username Example: <username>

Responses

200
Success

401
Unauthorized

500
Internal Server Error

post/orders/refreshStatus

Response samples

200
401
500

application/json

{"api_message": "<string>", "api_data": [ ] }

Orders

get-all-orders-list

header Parameters

post-new-order

header Parameters

Request Body schema: application/jsonrequired

get-exact-order-info

path Parameters

header Parameters

update-exact-limit-order

path Parameters

header Parameters

Request Body schema: application/jsonrequired

delete-exact-limit-order

path Parameters

header Parameters

get-open-orders-list

header Parameters

get-frozen-orders-list-info

header Parameters

get-lp-balances-info

header Parameters

get-closed-orders-list

header Parameters

get-quote/quotes

query Parameters

header Parameters

post-quote-for-new-order

header Parameters

Request Body schema: application/jsonrequired

refresh-status-of-all-live-orders

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required