Private Endpoints (User)

note

Every request on this page must include the api-key, api-signature and api-expires headers. Replace $API_KEY, $API_SIGNATURE and $API_EXPIRES with your own values. See Signing Requests.

Get User

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/user"

Response

{
    "id": 1,
    "email": "fight@club.com",
    "full_name": "Tyler Durden",
    "gender": true,
    "nationality": "USA",
    "dob": "2017-07-21T17:32:28.000Z",
    "phone_number": "",
    "address": {
        "city": "Bradford",
        "address": "537 Paper Street",
        "country": "USA",
        "postal_code": "19808"
    },
    "id_data": {
        "type": "passport",
        "number": "999",
        "issued_date": "2017-07-21T17:32:28.000Z",
        "expiration_date": "2017-07-21T17:32:28.000Z"
    },
    "bank_account": [...],
    "crypto_wallet": {},
    "verification_level": 2,
    "email_verified": true,
    "otp_enabled": false,
    "activated": true,
    "username": "narrator",
    "affiliation_code": "STRING",
    "settings": {
        "chat": {
            "set_username": true
        },
        "risk": {
            "popup_warning": true,
            "order_portfolio_percentage": 90
        },
        "audio": {
            "all": true,
            "order_placed": true,
            "public_trade": true,
            "click_amounts": true,
            "order_canceled": true,
            "order_completed": true,
            "quick_trade_success": true,
            "quick_trade_timeout": true,
            "get_quote_quick_trade": true,
            "order_partially_completed": true
        },
        "language": "en",
        "interface": {
            "theme": "dark",
            "order_book_levels": 20
        },
        "notification": {
            "popup_order_completed": false,
            "popup_order_confirmation": false,
            "popup_order_partially_filled": false
        }
    },
    "affiliation_rate": 0,
    "network_id": 90,
    "created_at": "2020-10-06T11:01:46.715Z",
    "updated_at": "2021-02-16T07:48:03.108Z",
    "balance": {
        "usdt_balance": 0,
        "usdt_available": 0,
        "btc_balance": 0,
        "btc_available": 0,
		...,
        "updated_at": "2021-02-16T05:48:28.014Z"
    },
    "wallet": [
        {
            "currency": "btc",
            "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
            "network": "btc",
            "standard": null,
            "is_valid": true,
            "created_at": "2021-04-07T07:23:33.212Z"
        },
        {
            "currency": "usdt",
            "address": "0xb9b424250b1d5025f69d5c099b7a90f0a0a9c275",
            "network": "eth",
            "standard": null,
            "is_valid": true,
            "created_at": "2021-04-22T13:46:54.014Z"
        },
        ...
    ]
}

This endpoint gets user's information, wallet address as well as his balance.

HTTP Request

GET https://<your-api-domain>/v2/user

Get Balance

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/user/balance"

Response

{
	"btc_balance": 0,
	"btc_available": 0,
	"usdt_balance": 0,
	"usdt_available": 0,
	...
	"updated_at": "2018-03-23T04:14:08.705Z"
}

This endpoint gets a user's balance.

HTTP Request

GET https://<your-api-domain>/v2/user/balance

Get Deposits

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/user/deposits"

Response

{
	"count": 1,
	"data": [
		{
            "id": 229,
            "amount": 1,
            "fee": 0,
            "address": "string",
            "transaction_id": "string",
            "status": true,
            "dismissed": false,
            "rejected": false,
            "processing": false,
            "waiting": false,
            "description": "",
            "type": "deposit",
            "currency": "usdt",
            "network": "eth",
            "created_at": "2021-02-16T05:48:28.011Z",
            "updated_at": "2021-02-16T05:48:28.011Z",
            "user_id": 90
        }
	]
}

This endpoint displays user's deposits

HTTP Request

GET https://<your-api-domain>/v2/user/deposits

PARAMETERS

Parameter	Type	Required/Optional	Description
currency	string	Optional	The currency pair symbol
limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
page	number	Optional	Page of data to retrieve
order_by	string	Optional	Field to order data
order	string	Optional	asc or desc
transaction_id	string	Optional	Get deposits with this transaction ID
address	string	Optional	Get deposits made to this address
status	boolean	Optional	Completed status of deposits to get
dismissed	boolean	Optional	Dismissed status of deposits to get
rejected	boolean	Optional	Rejected status of deposits to get
processing	boolean	Optional	Processing status of deposits to get
waiting	boolean	Optional	Waiting status of deposits to get
start_date	date-time	Optional	Starting date of queried data in ISO 8601 format
end_date	date-time	Optional	Ending date of queried data in ISO 8601 format
format	string	Optional	Pass value csv to download csv file

Get Withdrawals

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/user/withdrawals"

Response

{
	"count": 1,
	"data": [
		{
            "id": 224,
            "amount": 1,
            "fee": 0,
            "address": "string",
            "transaction_id": "string",
            "status": true,
            "dismissed": false,
            "rejected": false,
            "processing": false,
            "waiting": false,
            "description": "",
            "type": "withdrawal",
            "currency": "usdt",
            "network": "eth",
            "created_at": "2021-02-15T02:36:47.167Z",
            "updated_at": "2021-02-15T02:36:47.167Z",
            "user_id": 90
        }
	]
}

This endpoint displays user's withdrawals

HTTP Request

GET https://<your-api-domain>/v2/user/withdrawals

PARAMETERS

Parameter	Type	Required/Optional	Description
currency	string	Optional	The currency symbol, e.g. btc
limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
page	number	Optional	Page of data to retrieve
order_by	string	Optional	Field to order data
order	string	Optional	asc or desc
transaction_id	string	Optional	Get withdrawals with this transaction ID
address	string	Optional	Get withdrawals made to this address
status	boolean	Optional	Completed status of withdrawals to get
dismissed	boolean	Optional	Dismissed status of withdrawals to get
rejected	boolean	Optional	Rejected status of withdrawals to get
processing	boolean	Optional	Processing status of withdrawals to get
waiting	boolean	Optional	Waiting status of withdrawals to get
start_date	date-time	Optional	Starting date of queried data in ISO 8601 format
end_date	date-time	Optional	Ending date of queried data i ISO 8601 format
format	string	Optional	Pass value csv to download csv file

Get Withdrawal Fee

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/user/withdrawal/fee?symbol=$symbol"

Response

{
	"fee": 0.001
}

This endpoint gets the withdrawal fee for a certain currency

HTTP Request

GET https://<your-api-domain>/v2/user/withdrawal/fee?currency=${currency}

PARAMETERS

Parameter	Type	Required/Optional	Description
currency	string	Required	The desired currency e.g. btc

Withdrawal

Request

curl -X POST
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  -H "Content-Type: application/json"
  -d '{"currency":$currency,"amount":$amount,"address":$address}'
  "https://<your-api-domain>/v2/user/withdrawal"

Response

{
    "message": "Withdrawal request is in the queue and will be processed.",
    "id": 1000,
    "transaction_id": "d696dd5d-3226-4662-8d86-3da3d8eb68ff",
    "amount": 0.01,
    "currency": "btc",
    "fee": 0.0005,
    "fee_coin": "btc"
}

This endpoint directly creates a withdrawal for the user, only available via HMAC tokens with the withdrawal permission.

HTTP Request

POST https://<your-api-domain>/v2/user/withdrawal

PARAMETERS

Parameter	Type	Required/Optional	Description
currency	string	Required	The desired currency e.g. btc
amount	number	Required	The amount to withdrawal e.g. 5
address	string	Required	The recipient wallet's address
network	string	Optional	Network of currency being withdrawn if there are multiple networks for currency

Get Trades

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/user/trades"

Response

{
	"count": 1,
	"data": [
		{
            "side": "sell",
            "symbol": "btc-usdt",
            "size": 0.1,
            "price": 60500,
            "timestamp": "2021-02-15T07:34:34.203Z",
            "order_id": "string",
            "fee": 12.1,
            "fee_coin": "usdt"
        }
	]
}

This endpoint displays user's trades

HTTP Request

GET https://<your-api-domain>/v2/user/trades

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Optional	The currency pair symbol
limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
page	number	Optional	Page of data to retrieve
order_by	string	Optional	Field to order data
order	string	Optional	asc or desc
start_date	date-time	Optional	Starting date of queried data in ISO 8601 format
end_date	date-time	Optional	Ending date of queried data in ISO 8601 format
format	string	Optional	Pass value csv to download csv file

Get All Orders

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/orders"

Response

{
    "count": 1,
    "data": [
        {
            "id": "string",
            "side": "sell",
            "symbol": "btc-usdt",
            "size": 0.1,
            "filled": 0,
            "stop": null,
            "fee": 0,
            "fee_coin": "usdt",
            "type": "limit",
            "price": 60000,
            "status": "new",
            "created_by": 116,
            "created_at": "2021-02-17T02:32:38.910Z",
            "updated_at": "2021-02-17T02:32:38.910Z",
            "User": {
                "id": 116,
                "email": "fight@club.com",
                "username": "narrator",
                "exchange_id": 176
            }
        }
	]
}

This endpoint gets all active orders placed by the user

HTTP Request

GET https://<your-api-domain>/v2/orders

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Optional	The currency pair symbol
side	string	Optional	Side of orders to query (buy, sell)
open	boolean	Optional	Open status of order
limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
page	number	Optional	Page of data to retrieve
order_by	string	Optional	Field to order data
order	string	Optional	asc or desc
start_date	date-time	Optional	Starting date of queried data in ISO 8601 format
end_date	date-time	Optional	Ending date of queried data in ISO 8601 format

Get Order

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/order?$order_id"

Response

{
	"id": "string",
	"side": "sell",
	"symbol": "btc-usdt",
	"size": 0.1,
	"filled": 0,
	"stop": null,
	"fee": 0,
	"fee_coin": "usdt",
	"type": "limit",
	"price": 60000,
	"status": "new",
	"created_by": 116,
	"created_at": "2021-02-17T02:32:38.910Z",
	"updated_at": "2021-02-17T02:32:38.910Z"
}

This endpoint gets an order by its id.

HTTP Request

GET https://<your-api-domain>/v2/order?order_id=${order_id}

PARAMETERS

Parameter	Type	Required/Optional	Description
order_id	string	Required	Order unique Id

Create Order

Request

curl -X POST
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  -H "Content-Type: application/json"
  -d '{"symbol":$symbol,"side":$side,"size":$size,"type":$type,"price":$price}'
  "https://<your-api-domain>/v2/order"

Response

{
    "fee": 0,
    "meta": {},
    "symbol": "btc-usdt",
    "side": "sell",
    "size": 0.1,
    "type": "limit",
    "price": 60000,
    "fee_structure": {
        "maker": 0.2,
        "taker": 0.2
    },
    "fee_coin": "usdt",
    "id": "string",
    "created_by": 116,
    "filled": 0,
    "status": "new",
    "updated_at": "2021-02-17T03:03:19.231Z",
    "created_at": "2021-02-17T03:03:19.231Z",
    "stop": null
}

This endpoint places an order for the user

HTTP Request

POST https://<your-api-domain>/v2/order

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	The currency pair symbol (btc-usdt)
side	string	Required	buy or sell order
size	number	Required	The amount of the order
type	string	Required	limit or market order type
price	number	Required if limit order	Only should be used when type is limit
stop	number	Optional	Stop price of order
meta	object	Optional	Object with other options
meta.post_only	boolean	Optional	Set to true if order should only be made if market maker
meta.note	string	Optional	Additional note to add to order data

Cancel All Orders

Request

curl -X DELETE
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/order/all?symbol=btc-usdt"

Response

[
    {
        "created_by": 116,
        "side": "sell",
        "type": "limit",
        "size": 0.1,
        "price": 60000,
        "created_at": "2021-02-17T03:04:59.607Z",
        "updated_at": "2021-02-17T03:05:02.945Z",
        "symbol": "btc-usdt",
        "filled": 0,
        "stop": null,
        "status": "canceled",
        "fee": 0,
        "fee_coin": "usdt",
        "meta": {},
        "id": "string",
        "fee_structure": {
            "maker": 0.2,
            "taker": 0.2
        }
    },
    ...
]

This endpoint cancels all orders of the same currency pair symbol, placed by the user.

HTTP Request

DELETE https://<your-api-domain>/v2/order/all

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	The currency pair symbol

Cancel Order

Request

curl -X DELETE
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://<your-api-domain>/v2/order?order_id=$order_id"

Response

{
    "created_by": 116,
    "side": "buy",
    "type": "limit",
    "size": 2,
    "price": 60000,
    "created_at": "2021-02-17T03:07:36.244Z",
    "updated_at": "2021-02-17T03:07:52.683Z",
    "symbol": "btc-usdt",
    "filled": 0,
    "stop": null,
    "status": "canceled",
    "fee": 0,
    "fee_coin": "btc",
    "meta": {},
    "id": "string",
    "fee_structure": {
        "maker": 0.2,
        "taker": 0.2
    }
}

This endpoint cancels an order by getting its id

HTTP Request

DELETE https://<your-api-domain>/v2/order?order_id=${order_id}

PARAMETERS

Parameter	Type	Required/Optional	Description
order_id	string	Required	Specific order unique Id

Convert Quote

Request

curl -X GET "https://<your-api-domain>/v2/quick-trade?&spending_currency=btc&receiving_currency=usdt&spending_amount=0.0001"

Response

{
  "spending_currency": "btc",
  "receiving_currency": "usdt",
  "spending_amount": 0.0001,
  "type": "market",
  "receiving_amount": 3.45,
  "token": "wTqpH3aXjfPTnZbK4P94vUbwg7HGk05i",
  "expiry": "2023-11-09T20:47:21.323Z"
}

Get a quote for a conversion between two assets that can be used in quick trade (convert) page

HTTP Request

GET https://<your-api-domain>/v2/quick-trade

PARAMETERS

Parameter	Type	Required/Optional	Description
spending_currency	string	Required	Currency symbol of the spending currency
receiving_currency	string	Required	Currency symbol of the receiving currency
spending_amount	string	Optional	Spending amount
receiving_amount	string	Optional	Receiving amount

Convert Execute

Request

curl -X POST
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  -H "Content-Type: application/json"
  -d '{"token":$token}'
  "https://<your-api-domain>/v2/order/execute"

Response

{
  "symbol": "btc-usdt",
  "side": "sell",
  "size": 0.0001,
  "type": "market",
  "price": 0,
  "fee_structure": { "maker": 0.2, "taker": 0.2 },
  "fee_coin": "usdt",
  "id": "6a70663f-8948-4d08-b1b7-6c81a7b13c16",
  "created_by": 10792,
  "filled": 0.0001,
  "method": "market",
  "created_at": "2023-11-09T21:09:36.060Z",
  "updated_at": "2023-11-09T21:09:36.060Z",
  "average": 34500,
  "status": "filled"
}

This endpoint executes a quote received from the previous endpoint before the quote is expired.

HTTP Request

POST https://<your-api-domain>/v2/order/execute

PARAMETERS

Parameter	Type	Required/Optional	Description
token	string	Required	token

Get User​

HTTP Request​

Get Balance​

HTTP Request​

Get Deposits​

HTTP Request​

PARAMETERS​

Get Withdrawals​

HTTP Request​

PARAMETERS​

Get Withdrawal Fee​

HTTP Request​

PARAMETERS​

Withdrawal​

HTTP Request​

PARAMETERS​

Get Trades​

HTTP Request​

PARAMETERS​

Get All Orders​

HTTP Request​

PARAMETERS​

Get Order​

HTTP Request​

PARAMETERS​

Create Order​

HTTP Request​

PARAMETERS​

Cancel All Orders​

HTTP Request​

PARAMETERS​

Cancel Order​

HTTP Request​

PARAMETERS​

Convert Quote​

HTTP Request​

PARAMETERS​

Convert Execute​

HTTP Request​

PARAMETERS​

Get User

HTTP Request

Get Balance

HTTP Request

Get Deposits

HTTP Request

PARAMETERS

Get Withdrawals

HTTP Request

PARAMETERS

Get Withdrawal Fee

HTTP Request

PARAMETERS

Withdrawal

HTTP Request

PARAMETERS

Get Trades

HTTP Request

PARAMETERS

Get All Orders

HTTP Request

PARAMETERS

Get Order

HTTP Request

PARAMETERS

Create Order

HTTP Request

PARAMETERS

Cancel All Orders

HTTP Request

PARAMETERS

Cancel Order

HTTP Request

PARAMETERS

Convert Quote

HTTP Request

PARAMETERS

Convert Execute

HTTP Request

PARAMETERS