Introduction

All shell commands are CURL. You can read more about CURL here.

Exir provides a complete RESTful API for developers which allows full access to all the functionalities on the exchange. Exir also support websocket for real-time updates.

These endpoints are categorized into public and private. Public endpoints allow you to access public information such as price ticker, orderbook etc while private endpoints require authentication and allow you to get your balance, active orders as well as placing orders.

We have language bindings in Shell with CURL and you can view code examples in the dark area on the right.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl -X POST
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "api_endpoint_here"

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

Exir 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. 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}. You can use an online HMAC generator to generate the signature.

Examples of strings being encoded:

GET request to https://api.exir.io/v2/user/balance that expires at 1575516146
- GET/v2/user/balance1575516146
POST request to https://api.exir.io/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"}
DELETE request to https://api.exir.io/v2/order?order_id=23a75975-3ad9-448c-8f3e-836c1f61f248 that expires at 1697543568
- DELETE/v2/order?order_id=23a75975-3ad9-448c-8f3e-836c1f61f248

You can register for a new Exir api-key and api-secret in the security section of exir.io.

Exir expects api-key, api-signature, and api-expires to be included in all Private API requests to the server in the request header with the following format:

Feel free to check out the sample codes written in node, php, and python here.

api-key: <API_KEY>
api-signature: <API_SIGNATURE>
api-expires: <API_EXPIRES>

You must replace API_KEY, API_SIGNATURE, and API_EXPIRES with your own values.

Public

Health

Request

curl -X GET "https://api.exir.io/v2/health"

Response

{
    "name": "Exir",
    "version": "2.1.0",
    "host": "https://api.exir.io",
    "basePath": "/v2"
}

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

HTTP Request

GET https://api.exir.io/v2/health

Constants

Request

curl -X GET "https://api.exir.io/v2/constants"

Response

{
    "coins": {
        "btc": {
            "id": 1,
            "fullname": "bitcoin",
            "symbol": "btc",
            "active": true,
            "verified": true,
            "allow_deposit": true,
            "allow_withdrawal": true,
            "withdrawal_fee": 20,
            "min": 1,
            "max": 1000000,
            "increment_unit": 1,
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2019-10-31T05:08:18.907Z",
            "logo": "https://hollaex-resources.s3.ap-southeast-1.amazonaws.com/icons/btc.svg",
            "code": "btc",
            "is_public": true,
            "meta": {},
            "estimated_price": null,
            "description": null,
            "type": "blockchain",
            "network": "eth",
            "standard": "erc-20",
            "issuer": "HollaEx",
            "withdrawal_fees": {
                "eth": 20,
                "trx": 1
            },
            "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,
            "created_at": "2019-08-09T10:45:43.367Z",
            "updated_at": "2021-04-20T03:02:48.635Z",
            "logo": "https://bitholla.s3.ap-northeast-2.amazonaws.com/exchange/icons/usdt.",
            "code": "usdt",
            "is_public": true,
            "meta": {},
            "estimated_price": 1,
            "description": null,
            "type": "blockchain",
            "network": "eth,trx",
            "standard": "erc-20",
            "issuer": "HollaEx",
            "withdrawal_fees": null,
            "created_by": 1
        },
        ...
    },
    "pairs": {
        "btc-usdt": {
            "id": 1,
            "name": "btc-usdt",
            "pair_base": "btc",
            "pair_2": "usdt",
            "min_size": 0.1,
            "max_size": 10000000,
            "min_price": 0.01,
            "max_price": 10000,
            "increment_size": 0.1,
            "increment_price": 0.0001,
            "active": true,
            "verified": true,
            "code": "btc-usdt",
            "is_public": true,
            "estimated_price": 0.1,
            "created_at": "2019-08-09T10:45:43.353Z",
            "updated_at": "2019-08-09T10:45:43.353Z",
            "created_by": 1
        },
        ...
    }
}

This endpoint retrieves system information for coins and pairs.

HTTP Request

GET https://api.exir.io/v2/constants

Kit

Request

curl -X GET "https://api.exir.io/v2/kit"

Response

{
    "meta": {...},
    "color": {...},
    "icons": {...},
    "links": {...},
    "title": "Exir",
    "captcha": {
        "site_key": ""
    },
    "strings": {...},
    "api_name": "Exir",
    "defaults": {
        "theme": "dark",
        "language": "en"
    },
    "features": {...},
    "interface": {
        "type": "full"
    },
    "user_meta": {...},
    "logo_image": "https://bitholla-hollacloud-sandbox.s3.eu-west-1.amazonaws.com/exchange/exir/EXCHANGE_LOGO__dark___1658464961500.png",
    "injected_html": {...},
    "injected_values": [...],
    "native_currency": "irt",
    "setup_completed": true,
    "valid_languages": "en,fa,ko,ar,pt,ja,ru",
    "new_user_is_activated": true,
    "email_verification_required": true,
    "info": {
        "name": "Exir",
        "active": true,
        "url": "https://api.exir.com",
        "is_trial": false,
        "created_at": "2020-10-05T06:46:27.272Z",
        "expiry": "2021-02-04T06:46:27.000Z",
        "collateral_level": "member",
        "type": "Cloud",
        "plan": "crypto",
        "period": "year",
        "status": true,
        "initialized": true
    }
}

This endpoint retrieves system kit configurations for the client.

HTTP Request

GET https://api.exir.io/v2/kit

Tiers

Request

curl -X GET "https://api.exir.io/v2/tiers"

Response

{
    "1": {
        "id": 1,
        "name": "Base Trader",
        "icon": "",
        "description": "basic tier",
        "deposit_limit": 0,
        "withdrawal_limit": 0,
        "fees": {
            "maker": {
                "btc-usdt": 0.2,
                "xmr-usdt": 0.2,
                "eth-usdt": 0.2,
                "btc-usdt": 0.2,
                "eth-btc": 0.2
            },
            "taker": {
                "btc-usdt": 0.2,
                "xmr-usdt": 0.2,
                "eth-usdt": 0.2,
                "btc-usdt": 0.2,
                "eth-btc": 0.2
            }
        },
        "note": "",
        "created_at": "2020-10-28T02:00:57.128Z",
        "updated_at": "2021-01-13T15:42:30.615Z"
    },
    "2": {
        "id": 2,
        "name": "VIP Trader",
        "icon": "",
        "description": "vip tier",
        "deposit_limit": 0,
        "withdrawal_limit": 0,
        "fees": {
            "maker": {
                "btc-usdt": 0,
                "xmr-usdt": 0,
                "eth-usdt": 0,
                "btc-usdt": 0,
                "eth-btc": 0
            },
            "taker": {
                "btc-usdt": 0,
                "xmr-usdt": 0,
                "eth-usdt": 0,
                "btc-usdt": 0,
                "eth-btc": 0
            }
        },
        "note": "",
        "created_at": "2020-10-28T02:01:12.299Z",
        "updated_at": "2021-01-07T08:21:15.300Z"
    },
    ...
}

This endpoint retrieves system tier levels for users.

HTTP Request

GET https://api.exir.io/v2/tiers

Ticker

Request

curl -X GET "https://api.exir.io/v2/ticker?symbol=btc-usdt"

Response

{
    "open": 0.54,
    "close": 0.54,
    "high": 0.54,
    "low": 0.54,
    "last": 0.54,
    "volume": 18653.3,
    "timestamp": "2021-04-28T03:05:24.996Z"
}

This endpoint retrieves ticker information for a pair.

HTTP Request

GET https://api.exir.io/v2/ticker?symbol=${symbol}

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	The currency pair symbol (btc-usdt)

Tickers

Request

curl -X GET "https://api.exir.io/v2/tickers"

Response

{
    "btc-usdt": {
        "time": "2021-04-27T03:05:41.012Z",
        "open": 0.54,
        "close": 0.54,
        "high": 0.54,
        "low": 0.54,
        "last": 0.54,
        "volume": 18653.3,
        "symbol": "btc-usdt"
    },
    ...
}

This endpoint retrieves ticker information for all pairs.

HTTP Request

GET https://api.exir.io/v2/tickers

Orderbook

Request

curl -X GET "https://api.exir.io/v2/orderbook?symbol=btc-usdt"

Response

{
    "btc-usdt": {
        "bids": [
            [0.212,8],
            [0.21,5],
            [0.208,15],
            [0.206,583],
            [0.205,1000],
            [0.204,1000],
            [0.203,1000],
            [0.202,1000],
            [0.201,1000],
            [0.2,1000]
        ],
        "asks": [
            [0.23,45],
            [0.24,824],
            [0.248,10]
        ],
        "timestamp": "2018-03-02T21:36:29.395Z"
    }
}

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

HTTP Request

GET https://api.exir.io/v2/orderbook?symbol=${symbol}

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	The currency pair symbol (btc-usdt, etc.)

Orderbooks

Request

curl -X GET "https://api.exir.io/v2/orderbooks"

Response

{
    "btc-usdt": {
        "bids": [...],
        "asks": [...],
        "timestamp": "2018-03-02T21:36:29.395Z"
    },
    "btc-usdt": {
        "bids": [...],
        "asks": [...],
        "timestamp": "2018-03-02T21:36:29.395Z"
    },
    ...
}

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

HTTP Request

GET https://api.exir.io/v2/orderbooks

Trades

Request

curl -X GET "https://api.exir.io/v2/trades?symbol=btc-usdt"

Response

{
    "btc-usdt": [
        {
            "size": 10,
            "price": 0.2,
            "side": "buy",
            "timestamp": "2018-03-23T04:00:20.744Z"
        },
        {
            "size": 5,
            "price": 0.21,
            "side": "buy",
            "timestamp": "2018-03-23T03:32:38.927Z"
        },
        {
            "size": 5,
            "price": 0.23,
            "side": "sell",
            "timestamp": "2018-03-23T03:13:42.361Z"
        }
    ],
    ...
}

This endpoint retrieves the last 30 trades.

HTTP Request

GET https://api.exir.io/v2/trades

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Optional	The currency pair symbol (btc-usdt, etc.)

Chart

Request

curl -X GET "https://api.exir.io/v2/chart?symbol=btc-usdt&resolution=1D&from=1616987453&to=1619579513"

Response

[
    {
        "time": "2021-04-14T00:00:00.000Z",
        "close": 0.25,
        "high": 0.21,
        "low": 0.25,
        "open": 0.21,
        "symbol": "btc-usdt",
        "volume": 204.2
    },
    {
        "time": "2021-04-19T00:00:00.000Z",
        "close": 0.25,
        "high": 0.25,
        "low": 0.25,
        "open": 0.25,
        "symbol": "btc-usdt",
        "volume": 437.8
    },
    ...
]

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

HTTP Request

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

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	Symbol to get
resolution	string	Required	Time interval resolution (15, 60, 240, 1D, 1W)
from	string	Required	Beginning UNIX timestamp
to	string	Required	Ending UNIX timestamp

Charts

Request

curl -X GET "https://api.exir.io/v2/charts?resolution=1D&from=1551663947&to=1582768007"

Response

{
    "btc-usdt": [
        {
            "time": "2020-01-01T00:00:00.000Z",
            "close": 0.2,
            "high": 0.23,
            "low": 0.2,
            "open": 0.23,
            "symbol": "btc-usdt",
            "volume": 13538
        },
        {
            "time": "2020-01-02T00:00:00.000Z",
            "close": 0.2,
            "high": 0.2,
            "low": 0.2,
            "open": 0.2,
            "symbol": "btc-usdt",
            "volume": 54
        },
        {
            "time": "2020-01-03T00:00:00.000Z",
            "close": 0.2,
            "high": 0.201,
            "low": 0.2,
            "open": 0.2,
            "symbol": "btc-usdt",
            "volume": 25982
        },
        ...
    ],
    "btc-usdt": [...],
    ...
}

This endpoint retrieves trade history HOLCV for all pairs.

HTTP Request

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

PARAMETERS

Parameter	Type	Required/Optional	Description
resolution	string	Required	Time interval resolution (15, 60, 240, 1D, 1W)
from	string	Required	Beginning UNIX timestamp
to	string	Required	Ending UNIX timestamp

MiniCharts

Request

curl -X GET "https://api.exir.io/v2/minicharts?assets=btc,btc&quote=btc"

Response

{
    "btc": [
        {
            "time": "2023-09-12T11:59:00.548Z",
            "price": "25000.00",
            "symbol": "btc",
            "quote": "usdt"
        },
      ...
    ],
    "btc": [
        {
            "time": "2023-09-12T11:59:00.548Z",
            "price": "0.18",
            "symbol": "btc",
            "quote": "usdt"
        },
       ...
    ]
}

Get trade history HOLCV for all pairs

HTTP Request

GET https://api.exir.io/v2/minicharts

PARAMETERS

Parameter	Type	Required/Optional	Description
assets	array	Required	The list of assets to get the mini charts for
from	string	Optional	Beginning UNIX timestamp
to	string	Optional	Ending UNIX timestamp
quote	string	Optional	Quote asset to receive prices based on

Private

You must replace API_KEY, API_SIGNATURE, and API_EXPIRES with your own values in the header of all private http requests. Refer to the authentication section above to learn more.

Get User

Request

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

Response

{
    "id": 1,
    "email": "[email protected]",
    "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": "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"
        },
        ...
    ]
}

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

HTTP Request

GET https://api.exir.io/v2/user

Get Balance

Request

curl -X GET
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  "https://api.exir.io/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://api.exir.io/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://api.exir.io/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://api.exir.io/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. Maximun: 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://api.exir.io/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://api.exir.io/v2/user/withdrawals

PARAMETERS

Parameter	Type	Required/Optional	Description
currency	string	Optional	The currency pair symbol (btc-usdt)
limit	number	Optional	Number of elements to return. Default: 50. Maximun: 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://api.exir.io/v2/user/withdrawal/fee?symbol=$symbol"

Response

{
    "fee": 0.001
}

This endpoint gets the withdrawal fee for a certain currency

HTTP Request

GET https://api.exir.io/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://api.exir.io/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": 1,
    "currency": "btc",
    "fee": 20,
    "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://api.exir.io/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://api.exir.io/v2/user/trades"

Response

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

This endpoint displays user's trades

HTTP Request

GET https://api.exir.io/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. Maximun: 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://api.exir.io/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": 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": "[email protected]",
                "username": "narrator",
                "exchange_id": 176
            }
        }
    ]
}

This endpoint gets all active orders placed by the user

HTTP Request

GET https://api.exir.io/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. Maximun: 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://api.exir.io/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": 1.09,
    "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://api.exir.io/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://api.exir.io/v2/order"

Response

{
    "fee": 0,
    "meta": {},
    "symbol": "btc-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
}

This endpoint places an order for the user

HTTP Request

POST https://api.exir.io/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://api.exir.io/v2/order/all?symbol=btc-usdt"

Response

[
    {
        "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": "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://api.exir.io/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://api.exir.io/v2/order?order_id=$order_id"

Response

{
    "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": "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://api.exir.io/v2/order?order_id=${order_id}

PARAMETERS

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

TradingView

Exir fully supports the TradingView UDF API.

Config

Request

curl -X GET "https://api.exir.io/v2/udf/config"

Response

{
    "supported_resolutions": [
        "60",
        "1D"
    ],
    "supports_group_request": false,
    "supports_marks": false,
    "supports_search": true,
    "supports_timescale_marks": false
}

This endpoint retrieves the TradingView UDF config.

HTTP Request

GET https://api.exir.io/v2/udf/config

History

Request

curl -X GET "https://api.exir.io/v2/udf/history?symbol=btc-usdt&resolution=1D&from=1551663947&to=1582768007"

Response

{
    "c": [...],
    "h": [...],
    "l": [...],
    "o": [...],
    "v": [...],
    "s": "ok"
}

This endpoint retrieves the TradigView UDF history HOLCV.

HTTP Request

GET https://api.exir.io/v2/udf/history?symbol=${symbol}&resolution=${resolution}&from=${from}&to=${to}

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	The currency pair symbol (btc-usdt, etc.)
resolution	string	Required	Time interval resolution (1D, 60, etc.)
from	string	Required	Beginning UNIX timestamp
to	string	Required	Ending UNIX timestamp

Symbols

Request

curl -X GET "https://api.exir.io/v2/udf/symbols?symbol=btc-usdt"

Response

{
    "name": "bitHolla",
    "ticker": "btc-usdt",
    "exchange": "Exir",
    "has_intraday": true,
    "has_daily": true,
    "has_weekly_and_monthly": true,
    "session": "24x7",
    "regular_session": "24x7",
    "pricescale": 1,
    "volume_precision": 2,
    "has_empty_bars": true
}

This endpoint retrieves system a TradingView UDF symbol.

HTTP Request

GET https://api.exir.io/v2/udf/symbols?symbol=${symbol}

PARAMETERS

Parameter	Type	Required/Optional	Description
symbol	string	Required	The currency pair symbol (btc-usdt, etc.)

Websocket

Connection to public and private channels are available through the path https://api.exir.io/stream. Exir Exchanges can be connected to using any websocket libraries. For this documentation, we will use the library ws.

Connecting

Connection


    const WebSocket = require('ws');

    // Public
    const client = new WebSocket('wss://api.exir.io/stream');

    // Private HMAC
    const client = new WebSocket(`wss://api.exir.io/stream?api-key=${API-KEY}&api-signature=${API-SIGNATURE}&api-expires=${API-EXPIRES}`);

    client.on('open', () => {
        // Ping message to keep connection alive
        setInterval(() => {
            client.send(
                JSON.stringify({
                    op: 'ping'
                })
            )
        })
    }, 30000);

Connection for public events does not require authentication while private events do. Users can use Bearer or HMAC authentication. For HMAC, the method is CONNECT and the path is /stream. Refer to the Authentication section for more information on HMAC-SHA256.

Websocket connections will disconnect if a message is not sent within one minute. To keep a connection alive, you can sent a ping message every ~30 seconds.

PATH

wss://api.exir.io/stream

PARAMETERS

Parameter	Type	Required/Optional	Description
api-key (HMAC)	string	Optional	Your exchange api-key
api-signature (HMAC)	string	Optional	An api-signature created using HMAC SHA256
api-expires (HMAC)	string	Optional	Expiry time of request

Sending/Receiving Messages

Connection


    client.send(
        JSON.stringify({
            op: OPERATION,
            args: [EVENTS]
        })
    );

    client.on('message', (data) => {
        data = JSON.parse(data);
        console.log(data);
    })

Operations

Operation	Description
subscribe	Subscribe to events.
unsubscribe	Unsubscribe to events.
ping	Ping-pong message for keeping connections alive.

Events

Events	Description
orderbook	Public event for orderbook updates.
trade	Public event for trade updates.
order	Private event for user order updates.
usertrade	Private event for user trades.
wallet	Private even for wallet balance updates.
deposit	Private event for user deposits.
withdrawal	Private event for user withdrawals.
admin	Private event for exchange admin only.

Public Events

Connection


    client.on('open', () => {

        // Subscribe
        client.send(
            JSON.stringify({
                op: 'subscribe',
                args: ['orderbook', 'trades']
            })
        );

        // On message
        client.on('message', (data) => {
            console.log(JSON.parse(data));
        });

        // Unsubscribe
        client.send(
            JSON.stringify({
                op: 'unsubscribe',
                args: ['orderbook', 'trade']
            })
        );
    })

EVENTS

The public events you can subscribe to are:

Event	Description
orderbook	Notification with orderbook symbol and data update. To subscribe to a specific pair, you can pass the pair after a colon. Ex: `orderbook:btc-usdt`.
trade	Notification with trade data. To subscribe to a specific pair, you can pass the pair after a colon. Ex: `trade:btc-usdt`.

Public Updates

orderbook


{
    "topic": "orderbook",
    "action": "partial",
    "symbol": "btc-usdt",
    "data": {
        "bids": [
            [0.1, 0.1],
            ...
        ],
        "asks": [
            [1, 1],
            ...
        ],
        "timestamp": "2020-12-15T06:45:27.766Z"
    },
    "time": 1608015328
}

trades


{
    "topic": "trade",
    "action": "partial",
    "symbol": "btc-usdt",
    "data": [
        {
            "size": 0.012,
            "price": 300,
            "side": "buy",
            "timestamp": "2020-12-15T07:25:28.887Z"
        },
        ...
    ],
    "time": 1608015328
}

Private Events

Connection


    client.on('open', () => {

        // Subscribe
        client.send(
            JSON.stringify({
                op: 'subscribe',
                args: ['order', 'wallet']
            })
        );

        // On message
        client.on('message', (data) => {
            console.log(JSON.parse(data));
        });

        // Unsubscribe
        client.send(
            JSON.stringify({
                op: 'unsubscribe',
                args: ['order', 'wallet']
            })
        );
    })

EVENTS

The private events you can subscribe to are:

Event	Description
order	Notifications for newly created orders and order updates.
wallet	Notifications for balance updates.

Private Updates

order


{
    "topic": "order",
    "action": "partial",
    "user_id": 1,
    "data": [
        {
            "id": "7d3d9545-b7e6-4e7f-84a0-a39efa4cb173",
            "side": "buy",
            "symbol": "btc-usdt",
            "type": "limit",
            "size": 0.1,
            "filled": 0,
            "price": 1,
            "stop": null,
            "status": "new",
            "fee": 0,
            "fee_coin": "btc",
            "meta": {},
            "fee_structure": {
                "maker": 0.1,
                "taker": 0.1
            },
            "created_at": "2020-11-30T07:45:43.819Z",
            "created_by": 1
        },
        ...
    ],
    "time": 1608022610
}

{
    "topic": "order",
    "action": "insert",
    "user_id": 1,
    "symbol": "btc-usdt",
    "data": [
        {
            "id": "7d3d9545-b7e6-4e7f-84a0-a39efa4cb173",
            "side": "buy",
            "symbol": "btc-usdt",
            "type": "limit",
            "size": 0.1,
            "filled": 0,
            "price": 1,
            "stop": null,
            "status": "new",
            "fee": 0,
            "fee_coin": "btc",
            "meta": {},
            "fee_structure": {
                "maker": 0.1,
                "taker": 0.1
            },
            "created_at": "2020-11-30T07:45:43.819Z",
            "updated_at": "2020-12-15T08:56:45.066Z",
            "created_by": 1
        },
        ...
    ],
    "time": 1608022610
}

{
    "topic": "order",
    "action": "insert",
    "user_id": 1,
    "symbol": "btc-usdt",
    "data": [
        {
            "id": "7d3d9545-b7e6-4e7f-84a0-a39efa4cb173",
            "side": "buy",
            "symbol": "btc-usdt",
            "type": "limit",
            "size": 0.1,
            "filled": 0,
            "price": 1,
            "stop": null,
            "status": "new",
            "fee": 0,
            "fee_coin": "btc",
            "meta": {},
            "fee_structure": {
                "maker": 0.1,
                "taker": 0.1
            },
            "created_at": "2020-11-30T07:45:43.819Z",
            "updated_at": "2020-12-15T08:56:45.066Z",
            "created_by": 1
        },
        ...
    ],
    "time": 1608022610
}

Order status and action

The status of the order can be new, pfilled, filled, and canceled.

The action of the data determines what caused it to happen. All three are explained below:

Action	Description
partial	All previous and current orders. Is the first order data received when connecting. Max: 50. Descending order.
insert	When user's order is added. The status of the order can be either new, pfilled, or filled.
update	When user's order status is updated. Status can be pfilled, filled, and canceled.

wallet


{
    "topic": "wallet",
    "action": "partial",
    "user_id": 1,
    "data": {
        "usdt_balance": 1,
        "usdt_available": 1,
        "btc_balance": 1,
        "btc_available": 1,
        "xmr_balance": 1,
        "xmr_available": 1,
        "btc_balance": 1,
        "btc_available": 1,
        "eth_balance": 1,
        "eth_available": 1,
        ...,
        "updated_at": "2020-12-15T08:41:24.048Z"
    },
    "time": 1608021684
}

Errors

The EXIR API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The kitten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.