Exolix Logo Exolix [email protected]
Follow us
  1. Home
  2. API

Instant exchange API v1 [Deprecated]

Please always use our Current API version: https://exolix.com/developers
Exolix API provides an opportunity to get an access to the services of Exolix platform.
You can request more features by contacting our developers team [email protected].
Basic info

All request should use the domain:

API URL: https://exolix.com/api

All request to be executed using HTTPS and following parameters should be used in headers:

Request parameters:

Headers
Accept application/json
Content-Type application/json
Authorization process

For some requests, you need an authorization key. Of course, there are requests for which authorization is not mandatory, but it is needed to access some functions (assigning transactions to the user’s personal account).

These parameters should be used in headers to set up API authorization:

Request parameters:

Headers
Authorization {API Key}

*You must replace {API Key} with your personal API key.

You can get {API Key} after register or sending a request to Exolix support team - [email protected]

Common

List of available currencies

GET: https://exolix.com/api/currency

This API endpoint returns the list of available currencies. Some currencies get enabled or disabled from time to time, so make sure to refresh the list occasionally.

Successful response fields:

Name Type Description
code string Currency code
name string Currency name
status int Currency status

Example response:

[
    {
        "code": "BTC",
        "name": "Bitcoin",
        "status": 1
    },
    {
        "code": "ETH",
        "name": "Ethereum",
        "status": 1
    }
]


Rate for a specific currency

POST: https://exolix.com/api/rate

This API endpoint returns amount that user will get, current rate, minimal payment amount required to make an exchange.

Body fields:

Property Type Required or optional Description
coin_from string required Currency to exchange from
coin_to string required Currency to exchange for
deposit_amount numeric required Amount of currency you are going to send
rate_type string optional The type of the coin rate:
  • float - Floating
  • fixed - Fixed Default

Successful response fields:

Name Type Description
destination_amount float Amount that user will get
rate float Exchange rate
min_amount float Minimal payment amount

Example request:

{
    "coin_from": "BTC",
    "coin_to": "ETH",
    "deposit_amount": "0.1"
}

Example response:

{
    "destination_amount": "1.59099062",
    "rate": "15.90990620",
    "min_amount": "0.003"
}

Exchange

Get exchange transaction info

GET: https://exolix.com/api/exchange/{id}

This API endpoint returns the information of a single transaction. Transaction ID is taken from the "Create exchange transaction" endpoint.

Request parameters:

Params
id (Required) Transaction ID from Create transaction request

Successful response fields:

Name Type Description
id string Transaction ID
status string Transaction status:
  • wait
  • confirmation
  • exchanging
  • success
  • overdue
rate float Exchange rate
coin_from string Currency to exchange from
amount_from float Amount of currency to be exchanged
deposit_address string Address for a user to send coins to
deposit_extra string or null Additional ID for deposit_address in case it is required
coin_to string Currency to exchange for
amount_to float Real amount after the exchange that was sent
destination_address string Address where the exchange result will be sent to
destination_extra string or null Additional ID for destination_address in case it is required
refund_address string or null Refund address
refund_extra string or null Refund Extra ID

Example response:

{
    "id": "{created transaction id}",
    "status": "wait",
    "rate": "15.90366570",
    "coin_from": "BTC",
    "amount_from": "0.1",
    "deposit_address": "{btc address to send coins to}",
    "deposit_extra": null,
    "coin_to": "ETH",
    "amount_to": "1.59036657",
    "destination_address": "{eth address to send coins to}",
    "destination_extra": null,
    "refund_address": null,
    "refund_extra": null
}


Create exchange transaction

POST: https://exolix.com/api/exchange

This API endpoint creates a transaction, generates an address for sending funds and returns transaction attributes.

Body fields:

Property Type Required or optional Description
coin_from string required Currency to exchange from
coin_to string required Currency to exchange for
deposit_amount numeric required Amount of currency you are going to send
destination_address string required Recipient address
destination_extra string optional Property for addresses of currencies that use additional ID for transaction processing (XRP, XLM, EOS, BNB, etc...)
refund_address string optional Refund address
refund_extra string optional Refund Extra ID
rate_type string optional The type of the coin rate:
  • float - Floating
  • fixed - Fixed Default

Successful response fields:

Name Type Description
id string Transaction ID
status string Transaction status:
  • wait
  • confirmation
  • exchanging
  • success
  • overdue
rate float Exchange rate
coin_from string Currency to exchange from
amount_from float Amount of currency to be exchanged
deposit_address string Address for a user to send coins to
deposit_extra string or null Additional ID for deposit_address in case it is required
coin_to string Currency to exchange for
amount_to float Real amount after the exchange that was sent
destination_address string Address where the exchange result will be sent to
destination_extra string or null Additional ID for destination_address in case it is required
refund_address string or null Refund address
refund_extra string or null Refund Extra ID

Example request:

{
    "coin_from": "BTC",
    "coin_to": "ETH",
    "deposit_amount": "0.1",
    "destination_address": "{valid eth address}",
    "destination_extra": "",
    "refund_address": "",
    "refund_extra": ""
}

Example response:

{
    "id": "{created transaction id}",
    "status": "wait",
    "rate": "15.86606600",
    "coin_from": "BTC",
    "amount_from": "0.1",
    "deposit_address": "{btc address to send coins to}",
    "deposit_extra": null,
    "coin_to": "ETH",
    "amount_to": "1.58660660",
    "destination_address": "{valid eth address}",
    "destination_extra": null,
    "refund_address": null,
    "refund_extra": null
}