"
{% endhint %}
{% hint style="info" %}
Make sure to replace `$API_KEY`, `$API_SIGNATURE`, and `$API_EXPIRES` with your own key, signature, and expires values.
{% endhint %}
## Get User
`GET` `https://api.bytex.ca/v2/user`
This endpoint gets user's information, wallet address as well as his balance.
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"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,
"xht_balance": 0,
"xht_available": 0,
...,
"updated_at": "2021-02-16T05:48:28.014Z"
},
"wallet": [
{
"currency": "xht",
"address": "0xb9b424250b1d5025f69d5c099b7a90f0a0a9c275",
"network": "eth",
"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"
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Get Balance
`GET` `https://api.bytex.ca/v2/user/balance`
This endpoint gets a user's balance.
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"xht_balance": 0,
"xht_available": 0,
"usdt_balance": 0,
"usdt_available": 0,
...
"updated_at": "2021-11-23T04:14:08.705Z"
```
{% endtab %}
{% endtabs %}
## Get Deposits
`GET` `https://api.bytex.ca/v2/user/deposits`
This endpoint displays user's deposits.
#### Path Parameters
| Name | Type | Description |
| --------------- | --------- | ------------------------------------------------------- |
| order | String | asc or desc |
| order\_by | String | Field to order data |
| address | String | Get deposits made to this address |
| limit | number | Number of elements to return. Default: 50. Maximum: 100 |
| dismissed | boolean | Dismissed status of deposits to get |
| transaction\_id | String | Get deposits with this transaction ID |
| page | number | Page of data to retrieve |
| status | boolean | Completed status of deposits to get |
| currency | String | The currency pair symbol |
| rejected | boolean | Rejected status of deposits to get |
| processing | boolean | Processing status of deposits to get |
| waiting | boolean | Waiting status of deposits to get |
| start\_date | date-time | Starting date of queried data in ISO 8601 format |
| end\_date | date-time | Ending date of queried data in ISO 8601 format |
| format | String | Pass value csv to download csv file |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"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
}
]
}
```
{% endtab %}
{% endtabs %}
## Get Withdrawals
`GET` `https://api.bytex.ca/v2/user/withdrawals`
This endpoint displays user's withdrawals.
#### Path Parameters
| Name | Type | Description |
| --------------- | --------- | ------------------------------------------------------- |
| currency | String | The currency pair symbol |
| limit | number | Number of elements to return. Default: 50. Maximum: 100 |
| page | number | Page of data to retrieve |
| order\_by | String | Field to order data |
| order | String | asc or desc |
| transaction\_id | String | Get withdrawals with this transaction ID |
| address | String | Get withdrawals made to this address |
| status | boolean | Completed status of withdrawals to get |
| dismissed | boolean | Dismissed status of withdrawals to get |
| rejected | boolean | Rejected status of withdrawals to get |
| processing | boolean | Processing status of withdrawals to get |
| waiting | boolean | Waiting status of withdrawals to get |
| start\_date | date-time | Starting date of queried data in ISO 8601 format |
| end\_date | date-time | Ending date of queried data in ISO 8601 format |
| format | String | Pass value csv to download csv file |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"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
}
]
}
```
{% endtab %}
{% endtabs %}
## Get Withdrawal Fee
`GET` `https://api.bytex.ca/v2/user/withdrawal/fee?currency=${currency}`
This endpoint gets the withdrawal fee for a certain currency.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------ | ------ | ----------------------------- |
| currency\* | String | The desired currency e.g. xrp |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"fee": 0.001
}
```
{% endtab %}
{% endtabs %}
## Create Withdrawal Request
`POST` `https://api.bytex.ca/v2/user/request-withdrawal`
This endpoint creates a withdrawal request for the user.
#### Path Parameters
| Name | Type | Description |
| --------- | ------ | ------------------------------------------------------------------------------- |
| currency | String | The desired currency e.g. xrp |
| amount | number | The amount to withdrawal e.g. 5 |
| address | String | The recipient wallet's address |
| network | String | Network of currency being withdrawn if there are multiple networks for currency |
| otp\_code | String | OTP for user if user has OTP enabled |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"message": "Success"
}
```
{% endtab %}
{% endtabs %}
## Get Trades
`GET` `https://api.bytex.ca/v2/user/trades`
This endpoint displays user's trades.
#### Path Parameters
| Name | Type | Description |
| ----------- | --------- | ------------------------------------------------------- |
| symbol | String | The currency pair symbol |
| limit | number | Number of elements to return. Default: 50. Maximum: 100 |
| page | numer | Page of data to retrieve |
| order | String | asc or desc |
| start\_date | date-time | Starting date of queried data in ISO 8601 format |
| end\_date | date-time | Ending date of queried data in ISO 8601 format |
| format | String | Pass value csv to download csv file |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 1,
"data": [
{
"side": "sell",
"symbol": "xrp-usdt",
"size": 0.1,
"price": 0.35,
"timestamp": "2021-02-15T07:34:34.203Z",
"order_id": "string",
"fee": 0.2,
"fee_coin": "usdt"
}
]
}
```
{% endtab %}
{% endtabs %}
## Get All Orders
`GET` `https://api.bytex.ca/v2/orders`
This endpoint gets all active orders placed by the user.
#### Path Parameters
| Name | Type | Description |
| ----------- | --------- | ------------------------------------------------------- |
| end\_date | date-time | Ending date of queried data in ISO 8601 format |
| page | number | Page of data to retrieve |
| side | String | Side of orders to query (buy, sell) |
| order | String | asc or desc |
| open | boolean | Open status of order |
| limit | number | Number of elements to return. Default: 50. Maximum: 100 |
| order\_by | String | Field to order data |
| status | String | Status of order (filled, pfilled, canceled, new) |
| start\_date | date-time | Starting date of queried data in ISO 8601 format |
| symbol | String | The currency pair symbol |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 1,
"data": [
{
"id": "string",
"side": "sell",
"symbol": "xrp-usdt",
"size": 0.1,
"filled": 0,
"stop": null,
"fee": 0,
"fee_coin": "usdt",
"type": "limit",
"price": 1.09,
"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
}
}
]
}
```
{% endtab %}
{% endtabs %}
## Get Order
`GET` `https://api.bytex.ca/v2/order?order_id=${order_id}`
This endpoint gets an order by its id.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------- | ------ | --------------- |
| order\_id\* | String | Order unique Id |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"id": "string",
"side": "sell",
"symbol": "xrp-usdt",
"size": 0.1,
"filled": 0,
"stop": null,
"fee": 0,
"fee_coin": "usdt",
"type": "limit",
"price": 1.09,
"status": "new",
"created_by": 116,
"created_at": "2021-02-17T02:32:38.910Z",
"updated_at": "2021-02-17T02:32:38.910Z"
}
```
{% endtab %}
{% endtabs %}
## Create Order
`POST` `https://api.bytex.ca/v2/order`
This endpoint places an order for the user.
#### Path Parameters
| Name | Type | Description |
| ---------------------------------------- | ------ | ------------------------------------------------------------------------------------ |
| symbol\* | String | The currency pair symbol (xrp-usdt) |
| side\* | String | buy or sell order |
| type | String | limit or market order type |
| size\* | number | The amount of the order |
| price\* | number | *Only required if limit order*
Only should be used when type is limit.
|
| stop | number | Stop price of order |
| meta | object | Object with other options such as post\_only |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"fee": 0,
"meta": {},
"symbol": "xrp-usdt",
"side": "sell",
"size": 0.1,
"type": "limit",
"price": 1,
"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
}
```
{% endtab %}
{% endtabs %}
## Cancel All Orders
`DELETE` `https://api.bytex.ca/v2/order/all`
This endpoint cancels all orders placed by the user.
#### Path Parameters
| Name | Type | Description |
| ------ | ------ | ------------------------ |
| symbol | String | The currency pair symbol |
{% tabs %}
{% tab title="200: OK " %}
```javascript
[
{
"created_by": 116,
"side": "sell",
"type": "limit",
"size": 0.1,
"price": 1,
"created_at": "2021-02-17T03:04:59.607Z",
"updated_at": "2021-02-17T03:05:02.945Z",
"symbol": "xrp-usdt",
"filled": 0,
"stop": null,
"status": "canceled",
"fee": 0,
"fee_coin": "usdt",
"meta": {},
"id": "string",
"fee_structure": {
"maker": 0.2,
"taker": 0.2
}
},
...
]
```
{% endtab %}
{% endtabs %}
## Cancel Order
`DELETE` `https://api.bytex.ca/v2/order?order_id=${order_id}`
This endpoint cancels an order by getting its id.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------- | ------ | ------------------------ |
| order\_id\* | String | Specific order unique Id |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"created_by": 116,
"side": "buy",
"type": "limit",
"size": 2,
"price": 1,
"created_at": "2021-02-17T03:07:36.244Z",
"updated_at": "2021-02-17T03:07:52.683Z",
"symbol": "xrp-usdt",
"filled": 0,
"stop": null,
"status": "canceled",
"fee": 0,
"fee_coin": "xrp",
"meta": {},
"id": "string",
"fee_structure": {
"maker": 0.2,
"taker": 0.2
}
}
```
{% endtab %}
{% endtabs %}