Документация API

API

Начало

Все запросы к API Changee должны содержать параметр key

(API-ключ) доступен после регистрации в нашей Партнёрской программе.

API Endpoint https://changee.com/v1/api/

Проверка адреса

Этот запрос проверяет корректность адреса :

https://changee.com/v1/api/validate-address
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/validate-address?key=f4fce843f5034139951b70e9cf090289&currency=BTC&address=bc165Riv8YrDoV23yBZb87UYTBvga2NXwMuzX5xekR'
Result example :

{
    result: true
}

Параметр

key string f4fce843f5034139951b70e9cf090289
currency string BTC
address string bc165Riv8YrDoV23yBZb87UYTBvga2NXwMuzX5xekR

Курс обмена для суммы транзакции

Этот запрос возвращает текущий курс обмена. Комиссия за транзакцию не включена :

https://changee.com/v1/api/rate
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/rate?key=f4fce843f5034139951b70e9cf090289&from=BTC&to=ETH&amount=1'
Result example :

{
    fix: false,
    minamount: 0.0011128050476837,
    maxamount: 12.902038062404,
    fromNetwork: "Bitcoin",
    toNetwork: "ERC20",
    rate: 31.270264180631,
    withdrawalFee: "0.0024624030415862 ETH",
    result: true
}

Параметр

key string f4fce843f5034139951b70e9cf090289
from string BTC
to string ETH
amount float 1
fix int 0 or 1 0

* withdrawalFee — приблизительная комиссия за вывод средств. Плавающий параметр.

* fix: true — фиксированный курс, false — плавающий курс

Курс оплаты для суммы транзакции

Этот запрос позволяет получить текущий курс обмена и рассчитать сумму средств, которую необходимо отправить для получения платежа :

https://changee.com/v1/api/payment/rate
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/payment/rate?key=f4fce843f5034139951b70e9cf090289&from=BTC&to=ETH&amountTo=5000'
Result example :

{
    minamount: 2561.31,
    maxamount: 2930799,
    rate: 0.19879287,
    result: true
}

Параметр

key string f4fce843f5034139951b70e9cf090289
from string BTC
to string ETH
amountTo float 5000

Список валют

Этот запрос возвращает список всех доступных валют :

https://changee.com/v1/api/currencies
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/currencies?key=f4fce843f5034139951b70e9cf090289'
Result example :

{
  XMR: {
    coinName: "Monero",
    minamount: 12.27,
    maxamount: 15527,
    tagname: "",
    network: "Monero",
    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: "EOS",
    available: true
  },
  ...
}

Параметр

key string f4fce843f5034139951b70e9cf090289

Список пар

Этот запрос возвращает все пары, доступные для обмена :

https://changee.com/v1/api/pairs
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/pairs?key=f4fce843f5034139951b70e9cf090289'
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"
  ],
  ...
}

Параметр

key string f4fce843f5034139951b70e9cf090289

Создание обмена

Этот запрос создаёт — инициирует — обмен :

https://changee.com/v1/api/exchange-create
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/exchange-create?key=f4fce843f5034139951b70e9cf090289&from=BTC&to=ETH&amount=1&fix=0&destinationAddress=0xeb079bfd536e02c3ceedff0fd6be84e7d6295fb7&refundAddress=bc19fHU4XEZ3y4LneGwoRsnSngb7xmrbAzEaWU8iyf'
Result example :

{
    id               : "hfoo6aabc04a027e4",
    depositAddress   : "bc165Riv8YrDoV23yBZb87UYTBvga2NXwMuzX5xekR",
    depositTag       : "",
    expectedAmountTo : "31.270264180631",
    result           : true
}

Параметр

key string f4fce843f5034139951b70e9cf090289
destinationAddress string 0xeb079bfd536e02c3ceedff0fd6be84e7d6295fb7
destinationTag string (optional)
refundAddress string bc19fHU4XEZ3y4LneGwoRsnSngb7xmrbAzEaWU8iyf
refundTag string (optional)
from string BTC
to string ETH
amount float 1
fix int 0 or 1 0

Создание платежа

Этот запрос создаёт — инициирует — платёж: обмен с фиксированной суммой к получению в валюте to :

https://changee.com/v1/api/payment/exchange-create
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/payment/exchange-create?key=f4fce843f5034139951b70e9cf090289&from=BTC&to=ETH&amountTo=5000&destinationAddress=0xeb079bfd536e02c3ceedff0fd6be84e7d6295fb7&refundAddress=bc19fHU4XEZ3y4LneGwoRsnSngb7xmrbAzEaWU8iyf'
Result example :

{
    id               : "hfoo6aabc04a027e4",
    depositAddress   : "bc165Riv8YrDoV23yBZb87UYTBvga2NXwMuzX5xekR",
    depositTag       : "",
    expectedAmountTo : "5000",
    result           : true
}

Параметр

key string f4fce843f5034139951b70e9cf090289
destinationAddress string 0xeb079bfd536e02c3ceedff0fd6be84e7d6295fb7
destinationTag string (optional)
refundAddress string bc19fHU4XEZ3y4LneGwoRsnSngb7xmrbAzEaWU8iyf
refundTag string (optional)
from string BTC
to string ETH
amountTo float 5000

* amountTo — сумма, которую должен получить получатель в валюте to. Сумму к отправке в валюте from возвращает запрос payment/rate (поле rate); курс фиксируется в момент создания платежа.

* refundAddress — необязательный, но рекомендуемый параметр: на этот адрес возвращаются средства, если платёж не может быть завершён.

* при ошибке ответ имеет вид { error: "причина", result: false }. Типичные причины: payment exchanges are disabled, impossible to create fixed exchange for pair BTC/ETH, destination address is invalid, refund address is invalid.

Получение статуса обмена

Получение информации о текущем статусе обмена :

https://changee.com/v1/api/exchange-status
# Here is a curl example
curl \
-X GET 'https://changee.com/v1/api/exchange-status?key=f4fce843f5034139951b70e9cf090289&id=hfoo6aabc04a027e4'
Result example :

{
    status             : "deposit_received",
    from               : "BTC",
    to                 : "ETH",
    depositAddress     : "bc165Riv8YrDoV23yBZb87UYTBvga2NXwMuzX5xekR",
    depositTag         : "",
    depositTxId        : "86e66391ecf40a51fa6dfe5da91d6f8077fdffa8a900d26e1a5c14369d17bc75",
    destinationAddress : "0xeb079bfd536e02c3ceedff0fd6be84e7d6295fb7",
    destinationTag     : "",
    refundAddress      : "bc19fHU4XEZ3y4LneGwoRsnSngb7xmrbAzEaWU8iyf",
    refundTag          : "",
    expectedAmountFrom : "1",
    expectedAmountTo   : "31.270264180631",
    amountFrom         : "1",
    date               : "28-07-2023 09:36:34",
    txId               : null,
    amountTo           : null,
    emergency          : {status: EXPIRED},
    result             : true
}

Параметр

key string f4fce843f5034139951b70e9cf090289
id string hfoo6aabc04a027e4

Список используемых статусов:

waiting_deposit - ожидание депозита
deposit_received - депозит получен
exchanging - в процессе обмена
sending - в процессе отправки
success - обмен успешно завершён
time_expired - время ожидания средств истекло
failed - обмен завершился с ошибкой
sending_failed - попытка отправки не удалась
reverted - средства возвращены клиенту
payment_halted - средства поступили, но обмен приостановлен

Список статусов приостановленных заявок:

EXPIRED - транзакция получена после истечения срока заявки
LESS - отправлена транзакция с суммой меньше, чем в заявке