Start
API Endpoint https://fchange.org/v1/api/
All requests sent to API FCHANGE maust include the parameter key
(API key) available after signing up to our Partnership Program.
Address Validation
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/validate-address?key=69ec18c455844bd0b5¤cy=BTC&address=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh'
This request checks the validity of the address. :
https://fchange.org/v1/api/validate-address
Result example :
{
result: true
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
currency | string | BTC |
address | string | bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh |
Exchange rate for transaction amount
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/rate?key=69ec18c455844bd0b5&from=BTC&to=USDT&amount=1'
This request gets the current exchange rate. Transaction fee is not included. :
https://fchange.org/v1/api/rate
Result example :
{
fix: false,
minamount: 0.05,
maxamount: 100,
rate: 13.38099645346961
withdrawalFee: "0.00119 ETH"
result: true
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
from | string | BTC |
to | string | ETH |
amount | float | 1 |
fix | int 0 or 1 | 0 |
* withdrawalFee - approximate commission for withdrawal. Floating parameter.
* fix: true - fixed rate, false - floating rate
Payment rate for transaction amount
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/payment/rate?key=69ec18c455844bd0b5&from=BTC&to=USDT&amountTo=5000'
This request allows you to get the current exchange rate and calculate the amount of funds you need to send to receive a payment. :
https://fchange.org/v1/api/payment/rate
Result example :
{
minamount: 2561.31,
maxamount: 2930799,
rate: 0.19879287
result: true
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
from | string | BTC |
to | string | USDT |
amountTo | float | 5000 |
Currency List
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/currencies?key=69ec18c455844bd0b5'
This request gets the list of all available currencies. :
https://fchange.org/v1/api/currencies
Result example :
{
XMR: {
coinName: "Monero",
minamount: 12.27,
maxamount: 15527,
tagname: "",
network: "",
available: true
},
ETH: {
coinName: "Ethereum",
minamount: 1.33,
maxamount: 1693,
tagname: "",
network: "erc20",
available: true
},
DAI: {
coinName: "Dai",
minamount: 2127.89,
maxamount: 2746236,
tagname: "",
network: "erc20",
available: true
},
EOS: {
coinName: "EOS",
minamount: 2072.91,
maxamount: 2526315,
tagname: "MEMO",
network: "",
available: true
},
...
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
If the tagname is not an empty value, the tag is a mandatory parameter for this currency.
Pairs List
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/pairs?key=69ec18c455844bd0b5'
This request gets all pairs available for exchange. :
https://fchange.org/v1/api/pairs
Result example :
{
BTC: [
"USDT",
"BUSD",
"BNB",
"ETH",
"PAX",
"MATIC"
],
USDT: [
"BTC",
"XRP",
"DOGE",
"ETH"
],
DASH: [
"XMR",
"TUSD",
"ATOM"
],
XTZ: [
"USDT",
"BTC"
],
EOS: [
"ETH",
"PERL"
],
ADA: [
"TRX"
],
TUSD: [
"USDT"
],
ALGO: [
"BTC"
],
...
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
Exchange initiation
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/exchange-create?key=69ec18c455844bd0b5&from=BTC&to=ZEC&amount=0.5&fix=0&destinationAddress=t1PS2q82NcaDvjr2ZSAeVfLh79Xmbfutv5j&refundAddress=1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2'
This request creates – initiates - the exchange. :
https://fchange.org/v1/api/exchange-create
Result example :
{
id : "lgla64f6fce131975",
depositAddress : "3QESviDMoQVEWR68sjHpz8P9eyEPLAUcNZ",
depositTag : "",
expectedAmountTo : "235.11262",
result : true,
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
destinationAddress | string | 0x1ba42e5193dfa8b03d15dd1b86a3113bbbef8eeb |
destinationTag | string | (optional) |
refundAddress | string | 1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2 |
refundTag | string | (optional) |
from | string | BTC |
to | string | ZEC |
amount | float | 0.5 |
fix | int 0 or 1 | 0 |
Getting exchange status
# Here is a curl example
curl \
-X GET 'https://fchange.org/v1/api/exchange-status?key=69ec18c455844bd0b5&id=b4c312e6-199a-4572-a96a-9230badd7346'
Getting information about the current exchange status :
https://fchange.org/v1/api/exchange-status
Result example :
{
status : "deposit_received",
from : "BTC",
to : "ZEC",
depositAddress : "18cBEMRxXHqzWWCxZNtU91F5sbUNKhL5PX",
depositTag : "",
depositTxId : "86e66391ecf40a51fa6dfe5da91d6f8077fdffa8a900d26e1a5c14369d17bc75",
destinationAddress : "t1PS2q82NcaDvjr2ZSAeVfLh79Xmbfutv5j",
destinationTag : "",
refundAddress : "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
refundTag : "",
expectedAmountFrom : "0.5",
expectedAmountTo : "235.11262",
amountFrom : "0.5",
date : "01.01.2023 14:51:22",
txId : null,
amountTo : null,
emergency : {
status : EXPIRED
},
result : true
}
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 69ec18c455844bd0b5 |
id | string | b4c312e6-199a-4572-a96a-9230badd7346 |
List of used statuses :
waiting_deposit
- waiting for the deposit deposit_received
- deposit is received exchanging
- in the process of exchange sending
- in the process of sending success
- exchange completed successfully time_expired
- the waiting time for funds has expired failed
- the exchange ended with an error sending_failed
- sending attempt failed reverted
- the funds were returned to the client payment_halted
- funds have arrived but an exchange is on hold
The list of statuses of suspended orders: EXPIRED
- the transaction was received after the expiration of the order LESS
- a transaction was sent with an amount less than in the order