Exolix API
Exolix API provides an opportunity to get an access to the services of Exolix platform. ‘coin_from’ or ‘coin_to’ - such parameters have some of the requests (coin ticker in uppercase). Examples: ‘BTC’, ‘ETH’, ‘DASH’, ‘XRP’, ‘LTC,’ ‘XMR’. The list of coins in our exchanger is constantly expanding. *It’s necessary to be executed using HTTPS, this is a security measure.
An additional field for wallet addresses of currencies that may use additional ID for transaction processing is Extra ID (XRP, STEEM/SBD, XLM, DCT, XEM). This parameter is filled only if the coin has additional identifier, in other cases, this parameter does not need to be filled. *It’s necessary to be executed using HTTPS, this is a security measure. For every request to https://api.exolix.com/api/v1/ following parameters should be used in headers: These parameters should be used in headers for every request:
Content-Type: application/json;
Accept: 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 and getting information from the user’s account).
These parameters should be used in headers to set up API authorisation:
Authorization: Bearer OAuth token
You can get Bearer OAuth token after sending a request to Exolix support team - support@exolix.com
Market info
Get a List of Coins
It returns the list of coins, available for exchange with selected coin at given time, or gets entire list of coins.
The response also contains such parameters as extra id name if it exists, For example, destination tag for Ripple, message for XEM or payment id for Monero.
HTTP Request
GET /api/v1/currency
Response
| Name | Type | Description |
|---|---|---|
| code | string | Coin short name (code). |
| name | string | Currency full name. |
| status | int | The availability of the coins. 0 - available, 1 - unavailable. |
Get Rate for CoinPair
Calculates final amount that user will get, gets current rate, sets minimum and maximum amounts for deposit.
HTTP Request
POST api/v1/rate
Body
| Parameter | Type | Status | Description |
|---|---|---|---|
| coin_from | string | required | Coin code from. |
| coin_to | string | required | Coin code to. |
| deposit_amount | numeric | required | Amount of currency “from”. |
Response
| Name | Type | Description |
|---|---|---|
| min_amount | float | Minimum possible amount to be sent. |
| destination_amount | float | The final amount that user will receive after the exchange. |
| rate | float | Current exchange rate offered by Exolix. |
Exchange
Create exchange
This allows to request creating an exchange transaction. You should select the pair of coins you’d like to exchange, provide sender’s withdrawal address and specify the amount of coins you want to swap. Exolix returns address and extra id (if needed) to deposit to, final amount and some other parameters.
To assign transaction to the particular user it is necessary to be authorized, although API authorization is not mandatory here.
HTTP Request
POST api/v1/exchange
Body
| Parameter | Type | Status | Description |
|---|---|---|---|
| coin_from | string | required | Coin code from. |
| coin_to | string | required | Coin code to. |
| deposit_amount | numeric | required | Amount to be exchanged. |
| destination_address | string | required | Destination address, it is used for sending exchanged coins. |
| destination_extra | string | optional | Additional ID for destination wallet addresses of currencies that use extra ID for transaction processing. |
Response
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for transaction assigned by Exolix. |
| status | string | Transaction status is used to notify user about progress of the exchange process. See *transaction statuses for detailed description. |
| coin_from | string | Coin to exchange from. |
| coin_to | string | Coin to exchange to. |
| amount_from | float | Amount of coins to be exchanged, specified by user. |
| amount_to | float | This is expected amount that user will receive when exchange is completed. |
| deposit_address | string | Deposit address to which user sends the currency. |
| deposit_extra | string or null | Additional ID for deposit wallet addresses of currencies that use extra ID for transaction processing. Important: sending coins without using extra id (when it is provided) may result in money loss!. |
| destination_address | string | Destination address, it is used for sending exchanged coins. |
| destination_extra | string or null | Additional ID for destination wallet addresses of currencies that use extra ID for transaction processing. |
| rate | float | Current exchange rate offered by Exolix. |
Get exchange info
Shows detailed information about a single transaction. ‘rate’ is one of returned parameters, which is current rate offered by Exolix.
HTTP Request
GET api/v1/exchange/{id}
Url Options:
| Parameter | Type | Status | Description |
|---|---|---|---|
| id | string | required | Unique identifier for transaction assigned by Exolix. |
Response
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for transaction assigned by Exolix. |
| status | string | Transaction status is used to notify user about progress of the exchange process. See *transaction statuses for detailed description. |
| coin_from | string | Coin to exchange from. |
| coin_to | string | Coin to exchange to. |
| amount_from | float | Amount of coins to be exchanged, specified by user. |
| amount_to | float | This is expected amount that user will receive when exchange is completed. |
| deposit_address | string | Deposit address to which user sends the currency. |
| deposit_extra | string or null | Additional ID for deposit wallet addresses of currencies that use extra ID for transaction processing. Important: sending coins without using extra id (when it is provided) may result in money loss!. |
| destination_address | string | Destination address, it is used for sending exchanged coins. |
| destination_extra | string or null | Additional ID for destination wallet addresses of currencies that use extra ID for transaction processing. |
| rate | float | Current exchange rate offered by Exolix. |
| hash_in | string | Incoming transaction hash. |
| hash_out | string | Outgoing transaction hash. |
| final_amount_from | float | Displays received deposit amount. It may differ from the amount specified by user. |
| final_amount_to | float | If the received deposit is different, the final amount is being recalculated using the same rate. |
| created_at | date | Creation date of exchange transaction. |
List of exchange statuses
| Status | Description |
|---|---|
| wait | The exchange has just been created and it’s waiting for coins to reach the deposit wallet. |
| confirmation | The transaction appears in mempool and now it is waiting for necessary network confirmations to start. |
| exchanging | The exchange process is running. |
| success | The exchange is completed and currency is successfully sent to the recipient address. |
| overdue | Deposit receiving time for this transaction has expired. |