Документация 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=effd430f84604fd2b4fafa8631143e57&currency=BTC&address=bc1uNFE9QuyhnrB5cmkkJwR7XnqeyBcK8ueKrcjTQJ'

Result example :

{
    result: true
}

Параметр

key string effd430f84604fd2b4fafa8631143e57

currency string BTC

address string bc1uNFE9QuyhnrB5cmkkJwR7XnqeyBcK8ueKrcjTQJ

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

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

https://changee.com/v1/api/rate

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

Result example :

{
    fix: false,
    minamount: 0.00025074644081099,
    maxamount: 12.387775473926,
    fromNetwork: "Bitcoin",
    toNetwork: "ERC20",
    rate: 31.655351641454,
    withdrawalFee: "0.0023600204168826 ETH",
    result: true
}

Параметр

key string effd430f84604fd2b4fafa8631143e57

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=effd430f84604fd2b4fafa8631143e57&from=BTC&to=ETH&amountTo=5000'

Result example :

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

Параметр

key string effd430f84604fd2b4fafa8631143e57

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=effd430f84604fd2b4fafa8631143e57'

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 effd430f84604fd2b4fafa8631143e57

Список пар

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

https://changee.com/v1/api/pairs

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

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 effd430f84604fd2b4fafa8631143e57

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

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

https://changee.com/v1/api/exchange-create

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

Result example :

{
    id               : "gjdt6a9050933a5f7",
    depositAddress   : "bc1uNFE9QuyhnrB5cmkkJwR7XnqeyBcK8ueKrcjTQJ",
    depositTag       : "",
    expectedAmountTo : "31.655351641454",
    result           : true
}

Параметр

key string effd430f84604fd2b4fafa8631143e57

destinationAddress string 0x16aa686ba7377eb8b83d531d8c635853fab12a8c

destinationTag string (optional)

refundAddress string bc11PAESy2ovAmyg8bW8UXLKe8yXXWowBiVmrMbSFj

refundTag string (optional)

from string BTC

to string ETH

amount float 1

fix int 0 or 1 0

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

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

https://changee.com/v1/api/exchange-status

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

Result example :

{
    status             : "deposit_received",
    from               : "BTC",
    to                 : "ETH",
    depositAddress     : "bc1uNFE9QuyhnrB5cmkkJwR7XnqeyBcK8ueKrcjTQJ",
    depositTag         : "",
    depositTxId        : "86e66391ecf40a51fa6dfe5da91d6f8077fdffa8a900d26e1a5c14369d17bc75",
    destinationAddress : "0x16aa686ba7377eb8b83d531d8c635853fab12a8c",
    destinationTag     : "",
    refundAddress      : "bc11PAESy2ovAmyg8bW8UXLKe8yXXWowBiVmrMbSFj",
    refundTag          : "",
    expectedAmountFrom : "1",
    expectedAmountTo   : "31.655351641454",
    amountFrom         : "1",
    date               : "04-03-2023 17:16:27",
    txId               : null,
    amountTo           : null,
    emergency          : {status: EXPIRED},
    result             : true
}

Параметр

key string effd430f84604fd2b4fafa8631143e57

id string gjdt6a9050933a5f7

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

waiting_deposit - ожидание депозита

deposit_received - депозит получен

exchanging - в процессе обмена

sending - в процессе отправки

success - обмен успешно завершён

time_expired - время ожидания средств истекло

failed - обмен завершился с ошибкой

sending_failed - попытка отправки не удалась

reverted - средства возвращены клиенту

payment_halted - средства поступили, но обмен приостановлен

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

EXPIRED - транзакция получена после истечения срока заявки

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