search

REST API

RESTful API is the easiest method to perform private queries to ByteX Exchange.

hashtag
Public

hashtag
Health

GET https://api.bytex.ca/v2/health

This endpoint retrieves the exchange's basic information and checks its health.

{
  "name": "www.bytex.ca",
  "version": "2.2.5",
  "host": "https://api.bytex.ca",
  "basePath": "/v2"
}

hashtag
Constants

GET https://api.bytex.ca/v2/constants

This endpoint retrieves system information for coins and pairs.

{
    "coins": {
        "btc": {
            "id": 2,
            "fullname": "Bitcoin",
            "symbol": "btc",
            "active": true,
            "verified": true,
            "allow_deposit": true,
            "allow_withdrawal": true,
            "withdrawal_fee": 0.0003,
            "min": 0.00001,
            "max": 1000,
            "increment_unit": 0.00001,
            "logo": "https://bitholla.s3.ap-northeast-2.amazonaws.com/icon/BTC-hollaex-asset-01.svg",
            "code": "btc",
            "is_public": true,
            "meta": {},
            "estimated_price": 56000,
            "description": null,
            "type": "blockchain",
            "network": null,
            "standard": null,
            "issuer": "HollaEx",
            "withdrawal_fees": null,
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2021-05-06T16:01:07.867Z",
            "created_by": 1
        },
        "usdt": {
            "id": 6,
            "fullname": "USD Tether",
            "symbol": "usdt",
            "active": true,
            "verified": true,
            "allow_deposit": true,
            "allow_withdrawal": true,
            "withdrawal_fee": 20,
            "min": 0.1,
            "max": 10000000,
            "increment_unit": 0.1,
            "logo": "https://bitholla.s3.ap-northeast-2.amazonaws.com/icon/USDT-hollaex-asset-01.svg",
            "code": "usdt",
            "is_public": true,
            "meta": {},
            "estimated_price": 1,
            "description": null,
            "type": "blockchain",
            "network": "eth,trx",
            "standard": "erc-20",
            "issuer": "HollaEx",
            "withdrawal_fees": {
                "eth": {
                    "value": 30,
                    "symbol": "usdt"
                },
                "trx": {
                    "value": 1,
                    "symbol": "usdt"
                }
            },
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2021-10-21T07:16:59.339Z",
            "created_by": 1
        },
        "eth": {
            "id": 3,
            "fullname": "Ethereum",
            "symbol": "eth",
            "active": true,
            "verified": true,
            "allow_deposit": true,
            "allow_withdrawal": true,
            "withdrawal_fee": 0.01,
            "min": 0.0001,
            "max": 10000,
            "increment_unit": 0.0001,
            "logo": "https://bitholla.s3.ap-northeast-2.amazonaws.com/icon/ETH-hollaex-asset-01-01.svg",
            "code": "eth",
            "is_public": true,
            "meta": {},
            "estimated_price": 3500,
            "description": null,
            "type": "blockchain",
            "network": "eth",
            "standard": null,
            "issuer": "HollaEx",
            "withdrawal_fees": null,
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2021-05-06T16:01:47.692Z",
            "created_by": 1
        },
        "xht": {
            "id": 1,
            "fullname": "HollaEx Token",
            "symbol": "xht",
            "active": true,
            "verified": true,
            "allow_deposit": true,
            "allow_withdrawal": true,
            "withdrawal_fee": 20,
            "min": 1,
            "max": 1000000,
            "increment_unit": 1,
            "logo": "https://bitholla.s3.ap-northeast-2.amazonaws.com/icon/XHT-hollaex-asset-01.svg",
            "code": "xht",
            "is_public": true,
            "meta": {},
            "estimated_price": null,
            "description": null,
            "type": "blockchain",
            "network": "eth",
            "standard": "erc-20",
            "issuer": "HollaEx",
            "withdrawal_fees": null,
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2021-04-30T04:09:47.572Z",
            "created_by": 1
        },
        "bch": {
            "id": 4,
            "fullname": "Bitcoin Cash",
            "symbol": "bch",
            "active": true,
            "verified": true,
            "allow_deposit": true,
            "allow_withdrawal": true,
            "withdrawal_fee": 0.0001,
            "min": 0.001,
            "max": 100000,
            "increment_unit": 0.001,
            "logo": "https://bitholla.s3.ap-northeast-2.amazonaws.com/icon/BCH-hollaex-asset-01.svg",
            "code": "bch",
            "is_public": true,
            "meta": {},
            "estimated_price": null,
            "description": null,
            "type": "blockchain",
            "network": null,
            "standard": null,
            "issuer": "HollaEx",
            "withdrawal_fees": null,
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2021-04-30T04:09:47.564Z",
            "created_by": 1
        },
        ...
    }
}

hashtag
Kit

GET https://api.bytex.ca/v2/kit

This endpoint retrieves system kit configurations for the client.

hashtag
Tiers

GET https://api.bytex.ca/v2/tiers

This endpoint retrieves system tier levels for users.

hashtag
Ticker

GET https://api.bytex.ca/v2/ticker?symbol=${symbol}

This endpoint retrieves ticker information for a pair.

Ex: https://api.bytex.ca/v2/ticker?symbol=xrp-usdtarrow-up-right

hashtag
Path Parameters

Name
Type
Description

symbol*

String

The currency pair symbol (xrp-usdt)

hashtag
Tickers

GET https://api.bytex.ca/v2/tickers

This endpoint retrieves ticker information for all pairs.

hashtag
Orderbook

GET https://api.bytex.ca/v2/orderbook?symbol=${symbol}

This endpoint retrieves 10 level bids and 10 level asks of the orderbook for a symbol.

Ex: https://api.bytex.ca/v2/orderbook?symbol=xrp-usdtarrow-up-right

hashtag
Path Parameters

Name
Type
Description

symbol*

String

The currency pair symbol (xrp-usdt, etc.)

hashtag
Orderbooks

GET https://api.bytex.ca/v2/orderbooks

This endpoint retrieves 10 level bids and 10 level asks of the orderbook for all symbols.

hashtag
Trades

GET https://api.bytex.ca/v2/trades

This endpoint retrieves the last 30 trades.

hashtag
Path Parameters

Name
Type
Description

symbol

String

The currency pair symbol (xrp-usdt, etc.)

hashtag
Chart

GET https://api.bytex.ca/v2/chart?symbol=${symbol}&resolution=${resolution}&from=${from}&to=${to}

This endpoint retrieves a trading pair's trade history HOLCV.

Ex: https://api.bytex.ca/v2/chart?symbol=xrp-usdt&resolution=7d&from=1635659942&to=1638255542arrow-up-right

hashtag
Path Parameters

Name
Type
Description

symbol*

String

Symbol to get

resolution*

String

Time interval resolution (15, 60, 240, 1D, 1W)

from*

String

Beginning UNIX timestamp

to*

String

Ending UNIX timestamp

hashtag
Charts

GET https://api.bytex.ca/v2/charts?resolution=${resolution}&from=${from}to=${to}

This endpoint retrieves trade history HOLCV for all pairs.

Ex:

hashtag
Path Parameters

Name
Type
Description

resolution*

String

Time interval resolution (15, 60, 240, 1D, 1W)

from*

String

Beginning UNIX timestamp

to*

String

Ending UNIX timestamp

hashtag
Private

hashtag
Authentication

ByteX Exchange uses HMAC-SHA256 authentication for private user access to the API. HMAC-SHA256 takes a string and secret key (your api-secret) and outputs an encoded signature (your api-signature). The string being encoded should follow the format ${METHOD}${PATH}${api-expires}, where METHOD is the HTTP method of the request, PATH is the path of the request, and api-expires is a unix timestamp indicating when the request expires.

The string being encoded should follow the format ${METHOD}${PATH}${api-expires}, where METHOD is the HTTP method of the request, PATH is the path of the request, and api-expires is a unix timestamp indicating when the request expires. If the request includes a body, the JSON body object should be appended to the string being encoded e.g. ${METHOD}${PATH}${api-expires}${JSON_BODY}.

circle-info

You can use an online HMAC generatorarrow-up-right to generate the signature.

circle-info

You can use UNIX Timestamparrow-up-right converter to get the api-expires

Examples of strings being encoded:

  • GET request to https://api.bytex.ca/v2/user/balance that expires at 1575516146

    • GET/v2/user/balance1575516146

  • POST request to https://api.bytex.ca/v2/order that expires at 1575516146 with body {"symbol":"btc-usdt","side":"buy","size":0.001,"type":"market"}

    • POST/v2/order1583284849{"symbol":"btc-usdt","side":"buy","size":0.001,"type":"market"}

hashtag
Example GET Request

Using the GET User request below, you can encode a string like this:

  1. Visit an online HMAC generatorarrow-up-right to generate your api-signature

  2. Insert the string you want to encode, followed by your api-secret and select SHA256 for algorithm

  3. Click on Compute HMAC, and it will generate a computed HMAC; this will be your api-signature

HMAC246 Setup Guide

Once you've generated your api-signature make the request in your shell, with the following code:

circle-info

When inserting the code in your shell, paste it in one line like this:

curl -X GET -H "api-key: $API_KEY" -H "api-signature: $API_SIGNATURE" -H "api-expires: $API_EXPIRES" "https://api.bytex.ca/v2/user"

circle-info

Make sure to replace $API_KEY, $API_SIGNATURE, and $API_EXPIRES with your own key, signature, and expires values.

hashtag
Get User

GET https://api.bytex.ca/v2/user

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

hashtag
Get Balance

GET https://api.bytex.ca/v2/user/balance

This endpoint gets a user's balance.

hashtag
Get Deposits

GET https://api.bytex.ca/v2/user/deposits

This endpoint displays user's deposits.

hashtag
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

hashtag
Get Withdrawals

GET https://api.bytex.ca/v2/user/withdrawals

This endpoint displays user's withdrawals.

hashtag
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

hashtag
Get Withdrawal Fee

GET https://api.bytex.ca/v2/user/withdrawal/fee?currency=${currency}

This endpoint gets the withdrawal fee for a certain currency.

hashtag
Path Parameters

Name
Type
Description

currency*

String

The desired currency e.g. xrp

hashtag
Create Withdrawal Request

POST https://api.bytex.ca/v2/user/request-withdrawal

This endpoint creates a withdrawal request for the user.

hashtag
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

hashtag
Get Trades

GET https://api.bytex.ca/v2/user/trades

This endpoint displays user's trades.

hashtag
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

hashtag
Get All Orders

GET https://api.bytex.ca/v2/orders

This endpoint gets all active orders placed by the user.

hashtag
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

hashtag
Get Order

GET https://api.bytex.ca/v2/order?order_id=${order_id}

This endpoint gets an order by its id.

hashtag
Path Parameters

Name
Type
Description

order_id*

String

Order unique Id

hashtag
Create Order

POST https://api.bytex.ca/v2/order

This endpoint places an order for the user.

hashtag
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

hashtag
Cancel All Orders

DELETE https://api.bytex.ca/v2/order/all

This endpoint cancels all orders placed by the user.

hashtag
Path Parameters

Name
Type
Description

symbol

String

The currency pair symbol

hashtag
Cancel Order

DELETE https://api.bytex.ca/v2/order?order_id=${order_id}

This endpoint cancels an order by getting its id.

hashtag
Path Parameters

Name
Type
Description

order_id*

String

Specific order unique Id

PreviousAPI DocumentationNextNodejs Library

Last updated