API

Начало

Отправляемые данные должны быть в кодировке UTF-8.
Для успешных API-запросов все запросы должны содержать несколько обязательных заголовков:
- Заголовок X-API-KEY должен содержать полученный вами API Key (YOUR_API_KEY)

Пример запроса

bash

curl -X GET \
-H "x-api-key: YOUR_API_KEY" \
"https://xgram.io/api/v1/METHOD"

Все запросы, отправляемые в API Xgram, должны содержать параметр key (API-ключ), доступный после регистрации в нашей Партнёрской программе.

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

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

https://xgram.io/api/v1/crypto-address-verification

Параметр

Тип

Пример

cryptoDigitalCoin

string

BTC

cryptoDigitalAddress

string

bc1q6aas41krwvvcc4hhio6u4euf1y3wkbtap8uhmrt

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/crypto-address-verification?cryptoDigitalCoin=BTC&cryptoDigitalAddress=bc1q6aas41krwvvcc4hhio6u4euf1y3wkbtap8uhmrt" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

{

"result": true

}

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

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

https://xgram.io/api/v1/retrieve-rate-value

Параметр

Тип

Пример

fromCcy

string

BTC

toCcy

string

ETH

ccyAmount

float

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/retrieve-rate-value?fromCcy=BTC&toCcy=ETH&ccyAmount=1" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

{

"fix": false,

"minFrom": "0.0081",

"maxFrom": "138",

"from_network": "Bitcoin",

"to_network": "ERC20",

"rate": 25.084395813448847,

"withdrawalFee": "0.006 ETH",

"result": true

}

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

Получить список валют

Получить все доступные валюты:

https://xgram.io/api/v1/list-currency-options

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/list-currency-options" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

{

"XETA": {

"coinName": "XANA",

"contract": "0x111111111117dc0aa78b770fa6a738034120c302",

"minFrom": 19137.93103448276,

"maxFrom": 18773946,

"tagname": "",

"network": "AVAXC",

"available": true

"FITFI": {

"coinName": "Step App",

"contract": "",

"minFrom": 16989.79591836735,

"maxFrom": 14965986,

"tagname": "",

"network": "AVAXC",

"available": true

"ARB": {

"coinName": "Arbitrum",

"contract": "",

"minFrom": 90.68627450980394,

"maxFrom": 88085,

"tagname": "",

"network": "Arbitrum",

"available": true

"KLAY": {

"coinName": "Klaytn",

"contract": "",

"minFrom": 389.9297423887589,

"maxFrom": 69838833,

"tagname": "",

"network": "Klaytn",

"available": true

...

}

Если значение tagname не пустое, тег является обязательным параметром для данной валюты.

Список пар

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

https://xgram.io/api/v1/load-pairs-options

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/load-pairs-options" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

[

  [
    "ETH",
    "LTC"   
  ],

  [
     "BTC",
     "BCH"
  ],

  [
    "ZEC",
    "BAT"
  ],

  [
    "ETH",
    "USDT"
  ],

  [
    "BNB",
    "XRP"
  ],
]

Инициация обмена

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

https://xgram.io/api/v1/launch-new-exchange

Параметр

Тип

Пример

toAddress

string

0xaeeee8f61f3ccffe8c60e7aed0f4ca753e0ba43d

toAddressTag

optional

string

refundAddress

optional

string

bc1q8dj6psgvmqshkgy9vpl7shtn2ly77qz5dr6mq3

refundTag

optional

string

fromCcy

string

BTC

toCcy

string

ZEC

ccyAmount

float

0.5

type

optional

string

float

Допустимые значения: float и fixed

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/launch-new-exchange?toAddress=0x750c44dB01899176f2e64bD25A2fabAC1140d8e9&fromCcy=BTC&toCcy=ETH&ccyAmount=0.5" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

{

"id": "qeqb36r5qa999th0",

"depositAddress": "2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"depositTag": "",

"result": true,

"ccyAmountToExpected": 14.7316,

}

Инициация платежа

Этот запрос создаёт и инициирует платёж:

https://xgram.io/api/v1/launch-new-payment-exchange

Параметр

Тип

Пример

toAddress

string

0xaeeee8f61f3ccffe8c60e7aed0f4ca753e0ba43d

toAddressTag

optional

string

refundAddress

optional

string

bc1q8dj6psgvmqshkgy9vpl7shtn2ly77qz5dr6mq3

refundTag

optional

string

fromCcy

string

BTC

toCcy

string

ZEC

ccyAmount

float

0.5

type

optional

string

float

Valid values: float and fixed

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/launch-new-payment-exchange?toAddress=0x750c44dB01899176f2e64bD25A2fabAC1140d8e9&fromCcy=BTC&toCcy=ETH&ccyAmount=0.5" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

{

"id": "qeqb36r5qa999th0",

"depositAddress": "2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"depositTag": "",

"result": true,

"ccyAmountFrom": 0.0183883

}

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

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

https://xgram.io/api/v1/fetch-status-info

Параметр

Тип

Пример

string

qeq6r5qa999th0

Пример запроса

bash

curl -X GET "https://xgram.io/api/v1/fetch-status-info?id=qeq6r5qa999th0" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Пример ответа

json

{

"x-status": "deposit_received",

"id": "qeq6r5qa999th0",

"x-fromCcy": "BTC",

"x-toCcy": "ZEC",

"x-ccyDepositAddress": "1Z9VcAgLPQwoAb7fiWuDKZbqwnt5LKrAv",

"x-ccyDepositTag": "",

"x-ccyDepositHash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2g3h",

    "x-ccyDestinationAddress":

"2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"x-ccyDestinationTag": "",

    "x-ccyRefundAddress":

"2B2yQ2fQ6RHejg3ENQUgUM6TMn8e8WjGqOb",

"x-ccyRefundTag": "",

"x-ccyExpectedAmountFrom": 0.5,

"x-ccyExpectedAmountTo": 50.02,

"x-ccyAmountFrom": "0.5",

"date": "21.01.2024 10:01:11",

"txId": null,

"x-ccyAmountTo": null,

"result": true

}

Список используемых статусов:
x-new — новая транзакция (ожидание депозита)
x-awaiting_funds — подтверждение депозита
x-funds_received — депозит получен
x-processing_exchange — обмен в процессе
x-transferring — отправка средств
x-completed — обмен успешно завершён
x-timeout — истекло время ожидания депозита
x-error — обмен завершился с ошибкой
x-transfer_error — ошибка при отправке
x-returned — средства возвращены клиенту

Вы отправляете

Вы получаете

Все комиссии включены

Эта пара сейчас недоступна. Пожалуйста, попробуйте позже.

Плавающий курс или Фиксированный курс

Опции курса

Плавающий курс

Обмен по лучшему доступному рыночному курсу. Курс может измениться в процессе.

Фиксированный курс

Курс фиксируется в начале обмена и остаётся неизменным до завершения.

Движок ликвидности Xgram

Умная защита хеджирования