Home

Instant exchange API

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/v2

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]

For "affiliate program" please pass the authorization headers to all requests.

Common

List of available currencies

GET: https://exolix.com/api/v2/currencies

This API endpoint returns the paginated list of available currencies.

Parameters:

Name	Type	Required or optional	Description
page	number (query)	optional	Current page
size	number (query)	optional	Size per page
search	string (query)	optional	Search by currency code or name
withNetworks	boolean (query)	optional	Show currency with networks: true false Default

Successful response fields:

Name	Type	Description
data	array	List of items
code	string	Currency code
name	string	Currency name
icon	string	Currency icon
notes	string	Currency notes
networks	array	List of currency networks *Only withNetworks=true
network	string	Network code
name	string	Network name
shortName	string	Network short name
addresRegex	string \| null	Address regex
notes	string	Network notes
isDefault	boolean	Is network default
decimal	number \| null	Decimal
icon	string \| null	Icon
blockExplorer	string \| null	Link to explorer
depositMinAmount	number \| null	Network minimum amount to deposit
memoNeeded	boolean	Network has extra ID
memoName	string \| null	Network extra name
memoRegex	string \| null	Memo regex
precision	boolean	Network precision
contract	string \| null	Contract address
count	int	Count of items

Example request:

GET: https://exolix.com/api/v2/currencies?page=1&size=1

Example response:

{
  "data": [
    {
      "code": "BTC",
      "name": "Bitcoin",
      "icon": "https://exolix.com/public/coins/BTC.png",
      "notes": ""
    }
  ],
  "count": 547
}

Get currency networks

GET: https://exolix.com/api/v2/currencies/{code}/networks

This API endpoint returns networks by currency code.

Parameters:

Name	Type	Required or optional	Description
code	string (path)	required	Currency code

Successful response fields:

Name	Type	Description
network	string	Network code
name	string	Network name
shortName	string	Network short name
notes	string \| null	Network notes
addresRegex	string \| null	Address regex
isDefault	boolean	Is network default
blockExplorer	string \| null	Link to explorer
depositMinAmount	number \| null	Network minimum amount to deposit
memoNeeded	boolean	Network has extra ID
memoName	string \| null	Network extra name
memoRegex	string \| null	Memo regex
decimal	number \| null	Decimal
precision	boolean	Network precision
contract	string \| null	Contract address
icon	string \| null	Icon

Example request:

GET: https://exolix.com/api/v2/currencies/eth/networks

Example response:

[
  {
    "network": "ETH",
    "name": "Ethereum (ERC20)",
    "shortName": "ERC20",
    "notes": null,
    "isDefault": true,
    "addressRegex": "^(0x)[0-9A-Fa-f]{40}$",
    "blockExplorer": null,
    "depositMinAmount": null,
    "memoNeeded": false,
    "memoName": null,
    "memoRegex": null,
    "precision": 8,
    "decimal": null,
    "contract": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "icon": "https://exolix.com/icons/coins/ETH.png"
  }
]

Rate for a specific currency

GET: https://exolix.com/api/v2/rate

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

Parameters:

Name	Type	Required or optional	Description
coinFrom	string (query)	required	Currency to exchange from
networkFrom	string (query)	optional	Network to exchange from
coinTo	string (query)	required	Currency to exchange to
networkTo	string (query)	optional	Network to exchange to
amount	string (query)	required	Amount of currency you are going to send
withdrawalAmount	string (query)	optional	Amount of currency you are going to get
rateType	string (query)	required	The type of the coin rate: float - Floating fixed - Fixed Default

Successful response fields:

Name	Type	Description
fromAmount	number	Amount sent
toAmount	number	Amount you will receive
rate	number	Exchange rate
minAmount	number	Minimal payment amount

Example request:

GET: https://exolix.com/api/v2/rate?coinFrom=ETH&coinTo=USDT&networkTo=ETH&amount=0.5&rateType=fixed

Example response:

{
  "fromAmount": 0.5,
  "toAmount": 502.352518,
  "rate": 1004.705036,
  "minAmount": 0.3717403
}

List of transaction history

GET: https://exolix.com/api/v2/transactions

This API endpoint return a paginated list of transaction history.

Parameters:

Name	Type	Required or optional	Description
page	number (query)	optional	Current page
size	number (query)	optional	Size per page
search	string (query)	optional	Search by transaction id
sort	string (query)	optional	Sort by field
order	string (query)	optional	Order (asc\|desc)
dateFrom	datetime (query)	optional	Filter from date
dateTo	datetime (query)	optional	Filter to date
statuses	string (query)	optional	Filter by status

Successful response fields:

Name	Type	Description
data	array	List of items
id	string	Transaction ID
amount	number	Amount sent
amountTo	number	The amount received
coinFrom	object	Currency to exchange from
coinCode	string	Currency from code
coinName	string	Currency from name
network	string	Currency from network
networkName	string	Currency from network name
networkShortName	string \| null	Currency from network short name
icon	string	Currency from icon
memoName	string \| null	Currency from extra name
coinTo	object	Currency to exchange to
coinCode	string	Currency to code
coinName	string	Currency to name
network	string	Currency to network
networkName	string	Currency to network name
networkShortName	string \| null	Currency to network short name
icon	string	Currency to icon
memoName	string \| null	Currency to extra name
comment	string \| null	Additional information about the transaction
createdAt	date	Date of creation
depositAddress	string	Address to send coins to
depositExtraId	string \| null	Extra ID for depositAddress in case it is required
withdrawalAddress	string	Address where the exchange result will be sent to
withdrawalExtraId	string	Extra ID for withdrawalAddress in case it is required
hashIn	object	Hash In
hash	string \| null	Hash In value
link	string \| null	Hash In link
hashOut	object	Hash Out
hash	string \| null	Hash Out value
link	string \| null	Hash Out link
rate	number	Exchange rate
rateType	string	The type of the coin rate: float - Floating fixed - Fixed Default
refundAddress	string \| null	Address for refund
refundExtraId	string	Extra ID for refund address
status	string	Transaction status: wait confirmation confirmed exchanging sending success overdue refunded
source	string	Transaction source: api referral
count	int	Count of items

Example request:

GET: https://exolix.com/api/v2/transactions?page=1&size=25

Example response:

{
"data": [
  {
    "id": "xxx891xxxbab45xx789282",
    "amount": 0.0025,
    "amountTo": 0.03358776,
    "coinFrom": {
      "coinCode": "BTC",
      "coinName": "Bitcoin",
      "network": "BTC",
      "networkName": "Bitcoin",
      "networkShortName": null,
      "icon": "https://exolix.com/public/coins/BTC.png",
      "memoName": null
    },
    "coinTo": {
      "coinCode": "ETH",
      "coinName": "Ethereum",
      "network": "ETH",
      "networkName": "Ethereum (ERC20)",
      "networkShortName": "ERC20",
      "icon": "https://exolix.com/public/coins/ETH.png",
      "memoName": null
    },
    "comment": null,
    "createdAt": "2022-05-12T11:37:56.122Z",
    "depositAddress": "bcxxxxaag52vkxxxxgdqtgxxxxxxylktwja",
    "depositExtraId": null,
    "withdrawalAddress": "0xxxxxxaf5739f8FC9DXXXXf973941xX88F",
    "withdrawalExtraId": "",
    "hashIn": {
      "hash": null,
      "link": null
    },
    "hashOut": {
      "hash": null,
      "link": null
    },
    "rate": 13.435104,
    "rateType": "fixed",
    "refundAddress": null,
    "refundExtraId": null,
    "status": "overdue",
    "source": "api"
  }
],
"count": 1
}

Exchange

Get exchange transaction info

GET: https://exolix.com/api/v2/transactions/{id}

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

Parameters:

Name	Type	Required or optional	Description
id	string (path)	required	Transaction ID from "Create exchange transaction" request

Successful response fields:

Name	Type	Description
id	string	Transaction ID
amount	number	Amount sent
amountTo	number	The amount received
coinFrom	object	Currency to exchange from
coinCode	string	Currency from code
coinName	string	Currency from name
network	string	Currency from network
networkName	string	Currency from network name
networkShortName	string \| null	Currency from network short name
icon	string	Currency from icon
memoName	string	Currency from extra name
coinTo	object	Currency to exchange to
coinCode	string	Currency to code
coinName	string	Currency to name
network	string	Currency to network
networkName	string	Currency to network name
networkShortName	string \| null	Currency to network short name
icon	string	Currency to icon
memoName	string	Currency to extra name
comment	string \| null	Additional information about the transaction
createdAt	date	Date of creation
depositAddress	string	Address to send coins to
depositExtraId	string \| null	Extra ID for depositAddress in case it is required
withdrawalAddress	string	Address where the exchange result will be sent to
withdrawalExtraId	string	Extra ID for withdrawalAddress in case it is required
hashIn	object	Hash In
hash	string \| null	Hash In value
link	string \| null	Hash In link
hashOut	object	Hash Out
hash	string	Hash Out value
link	string	Hash Out link
rate	number	Exchange rate
rateType	string	The type of the coin rate: float - Floating fixed - Fixed Default
refundAddress	string \| null	Address for refund
refundExtraId	string \| null	Extra ID for refund address
status	string	Transaction status: wait confirmation confirmed exchanging sending success overdue refunded

Example request:

GET: https://exolix.com/api/v2/transactions/ab93061434dd0s

Example response:

{
  "id": "ab93061434dd0s",
  "amount": 0.64,
  "amountTo": 0.06584184,
  "coinFrom": {
    "coinCode": "XMR",
    "coinName": "Monero",
    "network": "XMR",
    "networkName": "Monero",
    "networkShortName": null,
    "icon": "https://exolix.com/public/coins/XMR.png",
    "memoName": null
  },
  "coinTo": {
    "coinCode": "ETH",
    "coinName": "Ethereum",
    "network": "ETH",
    "networkName": "Ethereum (ERC20)",
    "networkShortName": "ERC20",
    "icon": "https://exolix.com/public/coins/ETH.png",
    "memoName": null
  },
  "comment": null,
  "createdAt": "2022-06-02T05:56:59.719Z",
  "depositAddress": "8Ac94Ag5AHWJ6UTNhhsxxxVenseJZE1YtSWCEVUkCwjkANaGUtCTBjo51cxxxefLn47RxfMTLhj2dfVix6xDqBmY847F4CK",
  "depositExtraId": null,
  "withdrawalAddress": "0x999e78a3c0xdx8464e0d96xxx0cf33a82d41a153",
  "withdrawalExtraId": "",
  "hashIn": {
    "hash": "6eb14e310e83d68b5xxxc779159a0776e9bae39e3c2f9xxea5138a23bb75c4b6",
    "link": "https://xxx.xx/bitcoin/transaction/6eb14e310e83d68b5xxxc779159a0776e9bae39e3c2f9xxea5138a23bb75c4b6"
  },
  "hashOut": {
    "hash": null,
    "link": null
  },
  "rate": 0.10287788,
  "rateType": "float",
  "refundAddress": null,
  "refundExtraId": null,
  "status": "exchanging"
}

Create exchange transaction

POST: https://exolix.com/api/v2/transactions

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

Body fields:

Property	Type	Required or optional	Description
coinFrom	string	required	Currency to exchange from
networkFrom	string	optional	Network to exchange from
coinTo	string	required	Currency to exchange to
networkTo	string	optional	Network to exchange to
amount	numeric	required	Amount of currency to send
withdrawalAmount	numeric	optional	Amount of currency to get
withdrawalAddress	string	required	Address where the exchange result will be sent to
withdrawalExtraId	string	optional	Extra ID for withdrawalAddress in case it is required
rateType	string	optional	The type of the coin rate: float - Floating fixed - Fixed Default
refundAddress	string	optional	Address for refund
refundExtraId	string	optional	Extra ID for refund address

Successful response fields:

Name	Type	Description
id	string	Transaction ID
amount	number	Amount sent
amountTo	number	The amount received
coinFrom	object	Currency to exchange from
coinCode	string	Currency from code
coinName	string	Currency from name
network	string	Currency from network
networkName	string	Currency from network name
networkShortName	string \| null	Currency from network short name
icon	string	Currency from icon
memoName	string	Currency from extra name
coinTo	object	Currency to exchange to
coinCode	string	Currency to code
coinName	string	Currency to name
network	string	Currency to network
networkName	string	Currency to network name
networkShortName	string \| null	Currency to network short name
icon	string	Currency to icon
memoName	string	Currency to extra name
comment	string \| null	Additional information about the transaction
createdAt	date	Date of creation
depositAddress	string	Address to send coins to
depositExtraId	string \| null	Extra ID for depositAddress in case it is required
withdrawalAddress	string	Address where the exchange result will be sent to
withdrawalExtraId	string	Extra ID for withdrawalAddress in case it is required
hashIn	object	Hash In
hash	string \| null	Hash In value
link	string \| null	Hash In link
hashOut	object	Hash Out
hash	string	Hash Out value
link	string	Hash Out link
rate	number	Exchange rate
rateType	string	The type of the coin rate: float - Floating fixed - Fixed Default
refundAddress	string \| null	Address for refund
refundExtraId	string \| null	Extra ID for refund address
status	string	Transaction status: wait confirmation confirmed exchanging sending success overdue refunded

Example request:

POST: https://exolix.com/api/v2/transactions

Body:

{
  "coinFrom": "ETH",
  "coinTo": "USDT",
  "networkFrom": "",
  "networkTo": "ETH",
  "amount": 0.5,
  "withdrawalAddress": "0x0E29D1E501f90649Ad5982E900c455006e4522FC",
  "withdrawalExtraId": "",
  "refundAddress": "0x0070BeBe9E30429437bD9c84C731031c27Fc7955",
  "refundExtraId": "",
  "rateType": "float"
}

Example response:

{
  "id": "dsd8f65609bb20",
  "amount": 0.5,
  "amountTo": 505.631486,
  "coinFrom": {
    "coinCode": "ETH",
    "coinName": "Ethereum",
    "network": "ETH",
    "networkName": "Ethereum (ERC20)",
    "networkShortName": "ERC20",
    "icon": "https://exolix.com/public/coins/ETH.png",
    "memoName": null
  },
  "coinTo": {
    "coinCode": "USDT",
    "coinName": "TetherUS",
    "network": "ETH",
    "networkName": "Ethereum (ERC20)",
    "networkShortName": "ERC20",
    "icon": "https://exolix.com/public/coins/USDT.png",
    "memoName": null
  },
  "comment": null,
  "createdAt": "2022-06-02T12:45:37.623Z",
  "depositAddress": "0xDb3B8a6dd4ddfDCA3330eaebc1a20aF26fDbbCfa",
  "depositExtraId": null,
  "withdrawalAddress": "0x0E29D1E501q90649Adss982E90dd455006e4522FC",
  "withdrawalExtraId": "",
  "refundAddress": "0x0070BeBe9E30429437bD9c84C731031c27Fc7955",
  "refundExtraId": "",
  "hashIn": {
    "hash": null,
    "link": null
  },
  "hashOut": {
    "hash": null,
    "link": null
  },
  "rate": 1011.262972,
  "rateType": "float",
  "refundAddress": null,
  "refundExtraId": null,
  "status": "wait"
}

API Version

Please always use our Current API version!

API Current: https://exolix.com/developers

API v1 [Deprecated]: https://exolix.com/developers/v1