Changelog
04-04-2023
- Опубликована документация AlfaBit Exchange API v1
Термины и сокращения
API (Application Programming Interface) — это инструмент, который позволяет взаимодействовать программам, сервисам, приложениям.
JSON (JavaScript Object Notation) — текстовый формат обмена данными, основанный на JavaScript RFC 7159.
Список принимаемых валют
import requests
url = "https://alfabit.org/api/v1/cashe/currencies-test/"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
curl --location "https://alfabit.org/api/v1/cashe/currencies-test/"
Пример ответа:
[
{
"code": "Qiwi(RUB)",
"currency_type": "FIAT",
"bestchange_code": "QWRUB",
"position_num_left": 1,
"re": "^(7|38|77)\(?([0-9]{3})\)?[-.•]?([0-9]{3})[-.•]?([0-9]{4})$",
"exemple": "79123456789"
},
{
"code": "Сбербанк(RUB)",
"currency_type": "FIAT",
"bestchange_code": "SBERRUB",
"position_num_left": 2,
"re": "^\d{16}$",
"exemple": "4890494593850217"
},
...
]
Эндпоинт предназначен для получения списка принимаемых валют
HTTP Request
GET
https://alfabit.org/api/v1/cashe/currencies-test/
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
code | str | Валюта |
currency_type | str | Тип валюты. FIAT (фиатные валюты) COIN (криптовалюты) CODE (гарантекс код) CASH (наличные) |
bestchange_code | str | Общепринятный код валюты |
position_num_left | int | Позиция в списке принимаемых от клиента валют для сортировки |
re | str | Регулярное выражение для валюты |
exemple | str | Пример адреса/номера кошелька |
Список операций для валюты
import requests
url = "https://alfabit.org/api/v1/cashe/operations/Bitcoin(BTC)/"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
curl --location "https://alfabit.org/api/v1/cashe/operations/Bitcoin(BTC)/"
Пример ответа:
[
{
buy_currency: {
id: 1,
code: "Qiwi(RUB)",
bestchange_code: "QWRUB",
currency_type: "FIAT",
exponent: 2
},
position_num_right: 1,
exchange_rate: 2189552.1498225,
reserv_value: 90763.06,
min_buy: 5000
},
{
buy_currency: {
id: 4,
code: "Тинькофф(RUB)",
bestchange_code: "TCSBRUB",
currency_type: "FIAT",
exponent: 2
},
position_num_right: 1,
exchange_rate: 2267078.5992825,
reserv_value: 13457700,
min_buy: 40000
},
...
]
Эндпоинт предназначен для получения списка операций для валюты
HTTP Request
GET
https://alfabit.org/api/v1/cashe/operations/{coin}/
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
coin | да | Отдаваемая клиентом валюта |
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
id | int | ID валюты |
buy_currency | dict | Информация о валюте для покупки |
code | str | Код валюты |
currency_type | str | Тип валюты. FIAT (фиатные валюты) COIN (криптовалюты) CODE (гарантекс код) CASH (наличные) |
bestchange_code | str | Общепринятный код валюты |
position_num_right | int | Позиция в списке отдаваемых валют для сортировки |
exchange_rate | float | Курс обмена |
reserv_value | float | Сумма резерва |
min_buy | int | Минимальная сумма для обмена |
Детали операции
import requests
url = "https://alfabit.org/api/v1/cashe/operations/detail/Bitcoin(BTC)/Qiwi(RUB)/"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
curl --location 'https://alfabit.org/api/v1/cashe/operations/detail/Bitcoin(BTC)/Qiwi(RUB)/'
Пример ответа:
{
"position_num_right": 1,
"buy_currency": {
"id": 1,
"aditional_fields": [ ],
"code": "Qiwi(RUB)",
"bestchange_code": "QWRUB",
"fiat_code": "RUB",
"re": "^(7|38|77)\(?([0-9]{3})\)?[-.•]?([0-9]{3})[-.•]?([0-9]{4})$",
"label_buy": "Ваш номер кошелька",
"label_sell": "Ваш номер кошелька",
"exemple": "79123456789",
"error_message": "Некорректный номер кошелька",
"payment_features": "<div data-column-width="50" data-layout-column="true" data-pm-slice='2 2 ["layoutSection",null]' id="isPasted" style="flex-basis: 50%;"><div data-layout-content="true"><p data-renderer-start-pos="7697" id="isPasted"><strong><span style="font-size: 14px;">Перевод принимается только с РФ Qiwi кошельков в валюте РУБЛЬ. </span></strong></p><p data-renderer-start-pos="9190" id="isPasted" style='margin: 0.75rem 0px 0px; padding: 0px; font-size: 16px; line-height: 1.714; font-weight: 400; letter-spacing: -0.005em; color: rgb(23, 43, 77); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: pre-wrap; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;'><span style="font-size: 14px;">Перевод принимается только с РФ Qiwi кошельков в валюте <strong data-renderer-mark="true">рубль</strong>.</span></p><p data-renderer-start-pos="9254" style='margin: 0.75rem 0px 0px; padding: 0px; font-size: 16px; line-height: 1.714; font-weight: 400; letter-spacing: -0.005em; color: rgb(23, 43, 77); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: pre-wrap; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;'><span style="font-size: 14px;">Все иные переводы с карт, терминалов и прочих платежных систем <strong data-renderer-mark="true">не принимаются</strong>, не будут зачислены и возврату не подлежат.Сумма переводится одним платежом с точностью до копеек с указанного вами в заявке кошелька.<br>Обменный пункт не гарантирует выплату и возврат денежных средств, если сумма активов отправленных клиентом отличается от суммы в заявке.</span></p><p data-renderer-start-pos="7697"><span style="font-size: 14px; font-family: Arial; color: rgb(65, 65, 65); background-color: rgb(255, 255, 255); font-weight: 700; font-style: normal; font-variant: normal; text-decoration: none; vertical-align: baseline; white-space: pre-wrap;">Курс в заявке фиксируется на 15 мин</span><span style="font-size: 14px; font-family: Arial; color: rgb(65, 65, 65); background-color: rgb(255, 255, 255); font-weight: 400; font-style: normal; font-variant: normal; text-decoration: none; vertical-align: baseline; white-space: pre-wrap;">.</span></p></div></div><p data-f-id="pbf" style="text-align: center; font-size: 14px; margin-top: 30px; opacity: 0.65; font-family: sans-serif;">Powered by <a href='https://www.froala.com/wysiwyg-editor?pb=1" title="Froala Editor">Froala Editor</a></p>',
"reception_features": "<p data-renderer-start-pos="7973" id="isPasted"><strong><span style="font-size: 14px;">Выплата производится с Qiwi кошельков РФ. </span></strong></p><p data-renderer-start-pos="9650" style='margin: 0.75rem 0px 0px; padding: 0px; font-size: 16px; line-height: 1.714; font-weight: 400; letter-spacing: -0.005em; color: rgb(23, 43, 77); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: pre-wrap; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;'><span style="font-size: 14px;">Выплаты производим только на кошельки QIWI RUB (РФ). Время выплаты заявки занимает 1-ч. В редких случаях Служба безопасности КИВИ Банк (АО) удерживает средства до 48 часов. Наш сервис <strong data-renderer-mark="true">не несет ответственности за задержку</strong> со стороны КИВИ Банк (АО).</span></p><p data-f-id="pbf" style="text-align: center; font-size: 14px; margin-top: 30px; opacity: 0.65; font-family: sans-serif;">Powered by <a href='https://www.froala.com/wysiwyg-editor?pb=1" title="Froala Editor">Froala Editor</a></p>',
"exponent": 2,
"currency_type": "FIAT",
"isAskReqSell": true,
"isAskReqBuy": true,
"use_reserv_type": "API",
"reserv_data": {
"data": {
"value": 1238158.2,
"time": 1680687967.480579,
"next": 1680687987.480589,
"duration": 20
}
},
"position_num_left": 1,
"min_sell": 5000,
"max_sell": 300000,
"min_buy": 5000,
"max_buy": 300000,
"requisite_verif": false,
"view_comment": false,
"view_pay_button": true,
"view_qr_code": true,
"min_value_if_sell": true,
"min_value_if_buy": true,
"max_value_if_sell": true,
"max_value_if_buy": true,
"cities": "",
"require_check_upload": false,
"hedging_from": null,
"hedging_to": null,
"use_hadge": false,
"repurchase": false,
"repurchase_coin_out": "",
"view_cancel_button": true,
"count_minutes_pay": 15,
"reserv_value": 2248410.06
},
"sell_currency": {
"id": 41,
"aditional_fields": [ ],
"code": "Bitcoin(BTC)",
"bestchange_code": "BTC",
"fiat_code": null,
"re": "^(?:[13]{1}[a-km-zA-HJ-NP-Z1-9]{26,33}|bc1[a-z0-9]{39,59})$",
"label_buy": "Ваш адрес кошелька",
"label_sell": null,
"exemple": "3QiqLBDCFYaCt6JAGr48DdHRmrsVqznU7H",
"error_message": "Некорректный номер кошелька",
"payment_features": "<p data-renderer-start-pos="156" id="isPasted" style='margin: 0.75rem 0px 0px; padding: 0px; font-size: 16px; line-height: 1.714; font-weight: 400; letter-spacing: -0.005em; color: rgb(23, 43, 77); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: pre-wrap; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;'>Курс в заявке фиксируется на 15 минут. Средства будут зачислены после 3 подтверждений сети. </p><p data-renderer-start-pos="250" style='margin: 0.75rem 0px 0px; padding: 0px; font-size: 16px; line-height: 1.714; font-weight: 400; letter-spacing: -0.005em; color: rgb(23, 43, 77); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: pre-wrap; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;'>Все входящие активы получают оценку риска, проходя AML проверку на основании<a data-renderer-mark="true" href='https://alfabit.org/ru/docs/custom-referral" rel="noopener noreferrer" style="color: var(--ds-link, #0052CC); text-decoration: none;" target="_blank" title="https://alfabit.org/ru/custom-referral"><u data-renderer-mark="true"> Пользовательского Соглашения П.8.5. и П.9.4.</u></a> и<a data-renderer-mark="true" href="https://alfabit.org/ru/docs/aml" rel="noopener noreferrer" style="color: var(--ds-link, #0052CC); text-decoration: none;" target="_blank" title="https://alfabit.org/ru/aml"><u data-renderer-mark="true"> AML политики</u></a> с помощью сервиса <a data-renderer-mark="true" href="https://t.me/AlfaBitAml_bot" rel="noopener noreferrer" style="color: var(--ds-link, #0052CC); text-decoration: none;" target="_blank" title="https://aml.alfabit.org/"><u data-renderer-mark="true">Alfabit AML</u></a>. Если сумма активов окажется меньше минимальной суммы обмена, обмен будет приостановлен. В возврате средств клиенту будет отказано</p><p data-f-id="pbf" style="text-align: center; font-size: 14px; margin-top: 30px; opacity: 0.65; font-family: sans-serif;">Powered by <a href="https://www.froala.com/wysiwyg-editor?pb=1" title="Froala Editor">Froala Editor</a></p>',
"reception_features": "<p data-renderer-start-pos="422" id="isPasted">Выплата производится в <strong>автоматическом</strong> режиме с биржи Binance и занимает 0-45 мин. </p><p data-renderer-start-pos="506">Скорость подтверждения транзакции <strong>НЕ</strong> зависит от нашего сервиса. </p><p data-renderer-start-pos="572">За технический сбой выводов с данной биржи сервис ответственности не несет.</p><p data-f-id="pbf" style="text-align: center; font-size: 14px; margin-top: 30px; opacity: 0.65; font-family: sans-serif;">Powered by <a href='https://www.froala.com/wysiwyg-editor?pb=1" title="Froala Editor">Froala Editor</a></p>',
"exponent": 8,
"currency_type": "COIN",
"isAskReqSell": false,
"isAskReqBuy": true,
"use_reserv_type": "API",
"reserv_data": {
"data": {
"value": 44.0030195538199,
"time": 1680689331.921519,
"next": 1680689351.921533,
"duration": 20
}
},
"position_num_left": 28,
"min_sell": 0.0035,
"max_sell": 1.5211,
"min_buy": 0.0035,
"max_buy": 1.3,
"requisite_verif": false,
"view_comment": false,
"view_pay_button": true,
"view_qr_code": true,
"min_value_if_sell": false,
"min_value_if_buy": false,
"max_value_if_sell": false,
"max_value_if_buy": false,
"cities": "",
"require_check_upload": false,
"hedging_from": "btc",
"hedging_to": "usdt",
"use_hadge": true,
"repurchase": true,
"repurchase_coin_out": "USDT",
"view_cancel_button": true,
"count_minutes_pay": 15,
"reserv_value": 44.034037082623996
},
"min_money1": "0.00220567",
"max_money1": "0.13234004",
"min_money2": 5000,
"max_money2": 300000,
"features_operations": "Выплата происходит после 3-ого подтверждения в сети Bitcoin.",
"requisite_verif": false,
"isAskReqSell": false,
"isAskReqBuy": true,
"turn_the_course": false,
"view_comment": false,
"view_pay_button": true,
"view_qr_code": true,
"rate_data": {
"time": 1680701435784,
"next": 1680701455784,
"duration": 20,
"position": 1,
"money1_best_code": "BTC",
"money2_best_code": "QWRUB",
"rateGive": 1,
"rateReceive": 2286006.63518464,
"value": 2266887.627,
"money1": "BTC",
"money2": "QWRUB"
},
"count_minutes_pay": 15,
"require_check_upload": false,
"hedging_from": "btc",
"hedging_to": "usdt",
"use_hadge": true,
"repurchase": false,
"repurchase_coin_out": "",
"city": [ ],
"exchange_rate": 2266887.627
}
Эндпоинт предназначен для получения деталей операций для валют
HTTP Request
GET
https://alfabit.org/api/v1/cashe/operations/detail/{money_in}/{money_out}/
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
money_in | да | Отдаваемая валюта |
money_out | да | Принимаемая валюта |
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
position_num_right | int | Позиция в списке отдаваемых валют для сортировки |
buy_currency | dict | Информация о валюте для покупки |
id | int | ID валюты |
aditional_fields | list | Дополнительные поля для валюты (например, memo_tag) |
code | str | Код валюты |
fiat_code | str | Код фиатной валюты |
re | str | Регулярное выражение для валюты |
label_buy | str | Сообщение для поля Получаю |
label_sell | str | Сообщение для поля Отдаю |
exemple | str | Пример адреса/номера кошелька |
error_message | str | Сообщение для ошибки ввода реквизитов |
payment_features | str | Информация особенностей оплаты |
reception_features | str | Информация особенностей приема |
exponent | int | Кол-во знаков после запятой |
currency_type | str | Тип валюты. FIAT (фиатные валюты) COIN (криптовалюты) CODE (гарантекс код) CASH (наличные) |
isAskReqSell | bool | Запрос реквизитов для поля Отдаю |
isAskReqBuy | bool | Запрос реквизитов для поля Получаю |
reserv_data | dict | Данные резерва |
data | dict | Подробные данные резерва |
value | float | Значение резерва |
time | float | Время фиксации резерва |
next | float | Следующее время фиксации резерва |
duration | int | Переодичность обновления курса |
position_num_left | int | Позиция в списке принимаемых валют для сортировки |
min_buy | int | Минимальная сумма для обмена |
min_sell | int | Минимальная сумма для получения |
max_buy | int | Максимальная сумма для обмена |
max_sell | int | Максимальная сумма для получения |
requisite_verif | bool | Проверять реквизиты |
view_comment | bool | Показывать комметарии к заказу |
view_pay_button | bool | Показывать кнопку "Я оплатил" |
view_qr_code | bool | Показывать qr код в заказе |
min_value_if_sell | bool | Показывать минимальную сумму для обмена |
min_value_if_buy | bool | Показывать минимальную сумму для получения |
max_value_if_sell | bool | Показывать максимальную сумму для обмена |
max_value_if_buy | bool | Показывать максимальную сумму для получения |
cities | str | Доступные города для обмена наличных |
require_check_upload | bool | Проверка чека после оплаты |
hedging_from | str | Валюта, которую хэджировать |
hedging_to | str | Валюта, в которую хэджировать |
use_hadge | bool | Использовать хэджирование |
repurchase | bool | Использовать докупку |
repurchase_coin_out | str | За какую валюту докупать |
view_cancel_button | bool | Показывать кнопку отменить заказ |
count_minutes_pay | int | Время фиксации курса в минутах |
reserv_value | float | Сумма резерва |
bestchange_code | str | Общепринятный код валюты |
position_num_right | int | Позиция в списке отдаваемых валют для сортировки |
exchange_rate | float | Курс обмена |
sell_currency | dict | Информация о валюте для продажи |
min_money1 | str | Минимальная сумма для валюты Отдаю |
max_money1 | str | Максимальная сумма для валюты Отдаю |
min_money2 | int | Минимальная сумма для валюты Получаю |
max_money2 | int | Максимальная сумма для валюты Получаю |
features_operations | str | Сообщение с кол-вом подтверждений |
turn_the_course | bool | |
rate_data | dict | Данные для курса |
time | float | Время фиксации курса |
next | float | Следующее время фиксации курса |
duration | int | Переодичность обновления курса |
position | int | Позиция курса |
money1_best_code | str | Бестчендж код валюты для обмена |
money2_best_code | str | Бестчендж код валюты для получения |
rateGive | int | Курс в поле Отдаю |
rateReceive | float | Курс в поле Получаю |
city | list | Доступные города для обмена наличных |
exchange_rate | str | Курс в заказе |
Создание заказа
import requests
url = "https://alfabit.org/api/v1/order/create"
payload = {
"email": "email@gmail.com",
"money1": "Qiwi(RUB)",
"money2": "Bitcoin(BTC)",
"req_money1": "1111",
"req_money2": "2222",
"amount_money1": "10000",
"amount_money2": "1",
"rid": "none",
"rate": "45454545",
"fixed_side": "sell",
"money1_additional_fields": {"MEMO": "12345", "FULL_NAME": "John Doe"},
"money2_additional_fields": {"MEMO": "12345", "FULL_NAME": "John Doe"}
}
headers = {}
response = requests.request("POST", url, headers=headers, json=payload)
curl --location 'https://alfabit.org/api/v1/order/create' \
--data-raw '{
"email":"email@gmail.com",
"money1":"Qiwi(RUB)",
"money2":"Bitcoin(BTC)",
"req_money1":"1111",
"req_money2":"2222",
"amount_money1":"10000",
"amount_money2":"1",
"rid": "none",
"rate": "45454545",
"fixed_side": "sell",
"money1_additional_fields": {"MEMO": "12345", "FULL_NAME": "John Doe"},
"money2_additional_fields": {"MEMO": "12345", "FULL_NAME": "John Doe"}
}'
Пример ответа:
{
"id": 421,
"uid": "6e18794d-1d12-44b2-904e-2f6242de5a13",
"email": "email@gmail.com",
"money1": "Qiwi(RUB)",
"money2": "Bitcoin(BTC)",
"money1_memo_tag": "12345",
"money2_memo_tag": "12345",
"req_money1": "1111",
"req_money2": "2222",
"amount_money1": "10000",
"amount_money2": "1",
"status": 0,
"date_make_order": 1595762185.2446876,
"fixed_side": "sell"
}
Эндпоинт предназначен для создания заказа
HTTP Request
POST
https://alfabit.org/api/v1/order/create
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
да | Емэйл адрес | |
money1 | да | Отдаваемая валюта |
money2 | да | Получаемая валюта |
req_money1 | да | Реквизиты отдаваемой валюты |
req_money2 | да | Реквизиты получаемой валюты |
amount_money1 | да | Сумма отдаваемой валюты |
amount_money2 | да | Сумма получаемой валюты |
rid | нет | ID рефовода |
rate | нет | Курс |
fixed_side | нет | Сторона, в которой будет зафиксирована сумма заказа ("buy", "sell") |
money1_additional_fields | зависит от направления | Дополнительные поля отдаваемой валюты (MEMO, PHONE_NUMBER, FULL_NAME и т.д.) |
money2_additional_fields | зависит от направления | Дополнительные поля получаемой валюты (MEMO, PHONE_NUMBER, FULL_NAME и т.д.) |
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
id | int | ID заказа |
uid | str | Уникальный идентификатор заказа |
str | Емэйл адрес в заказе | |
money1 | str | Отдаваемая валюта |
money2 | str | Принимаемая валюта |
money1_memo_tag | str | Мемо-тэг для отдаваемой валюты |
money2_memo_tag | str | Мемо-тэг для получаемой валюты |
req_money1 | str | Реквизиты отдаваемой валюты |
req_money2 | str | Реквизиты принимаемой валюты |
amount_money1 | str | Сумма отдаваемой валюты |
amount_money2 | str | Сумма принимаемой валюты |
status | int | Статус заказа |
date_make_order | float | Дата и время создания заказа |
fixed_side | str | Сторона, в которой зафиксирована сумма заказа |
Загрузка реквизитов для верификации
import requests
url = "https://alfabit.org/api/v1/order/send/image/upload/6e18794d-1d12-44b2-904e-2f6242de5a13/"
headers = {}
with open("requisites.png", "r") as file:
response = requests.request("POST", url, headers=headers, files={"file": file})
curl --location 'https://alfabit.org/api/v1/order/send/image/upload/6e18794d-1d12-44b2-904e-2f6242de5a13/' \
-F 'file=@requisites.png'
Пример ответа:
{
"result": true
}
Эндпоинт предназначен для загрузки реквизитов для заказа
HTTP Request
POST
https://alfabit.org/api/v1/order/send/image/upload/{uid}/"
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
file | да | Файл с изображением реквизитов |
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
result | bool | Результат |
Загрузка чека о выполненном переводе
import requests
url = "https://alfabit.org/api/v1/order/send/check/6e18794d-1d12-44b2-904e-2f6242de5a13/"
headers = {}
with open("check.png", "r") as file:
response = requests.request("POST", url, headers=headers, files={"file": file})
curl --location 'https://alfabit.org/api/v1/order/send/check/6e18794d-1d12-44b2-904e-2f6242de5a13' \
-F 'file=@check.png'
Пример ответа:
{
"result": true
}
Эндпоинт предназначен для загрузки чека для заказа
HTTP Request
POST
https://alfabit.org/api/v1/order/send/check/{uid}/"
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
file | да | Файл с изображением чека |
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
result | bool | Результат |
Детали заказа
import requests
url = "https://alfabit.org/api/v1/order/6e18794d-1d12-44b2-904e-2f6242de5a13/"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
curl --location 'https://alfabit.org/api/v1/order/6e18794d-1d12-44b2-904e-2f6242de5a13/'
Пример ответа:
{
"id": 372908,
"req_money1":"null",
"req_money2":"5536914012341234",
"unique_id":"6e18794d-1d12-44b2-904e-2f6242de5a13",
"email":"test@gmail.com",
"money1":"Bitcoin(BTC)",
"money2":"Тинькофф(RUB)",
"money1_id":"41",
"money2_id":"4",
"money2_bcode":"TCSBRUB",
"money2_memo_tag":null,
"money1_bcode":"BTC",
"amount_money1":0.3,
"amount_money2":421042.7,
"exchange_rate":"1403475.65",
"date_make_order":1662988413.704994,
"date_end_order":1662989614.454143,
"leftToCloseSeconds":0,
"count_minutes_pay":20,
"status":34,
"payment_number":"3JyjcyLnnq4bWgWSsSSEk16Vw6C4Ls9YJ1",
"comment_in":"garantex:order#000000",
"pay_link":null,
"view_comment":false,
"view_qr_code":true,
"view_cancel_button":true,
"requisite_verif":false,
"view_pay_button":true,
"money2_currency_type":"FIAT",
"money1_currency_type":"COIN",
"money2_link_blockchain":null,
"money1_view_pay_link":false,
"result":null,
"requisite_fail_message":null,
"require_check_upload":false,
"recalc_exchange_rate":"1403475.6520742488",
"is_recalc":true,
"turn_the_course":false,
"payment_is_in_blockchain":false
}
Эндпоинт предназначен для получения деталей заказа
HTTP Request
GET
https://alfabit.org/api/v1/order/{uid}/
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
uid | да | Уникальный идентификатор заказа |
Схема ответа
Параметр | Тип поля | Описание |
---|---|---|
id | int | ID заказа |
req_money1 | str | Реквизиты отдаваемой валюты |
req_money2 | str | Реквизиты принимаемой валюты |
unique_id | str | Уникальный идентификатор заказа |
str | Емэйл адрес в заказе | |
money1 | str | Отдаваемая валюта |
money2 | str | Принимаемая валюта |
money1_id | str | ID Отдаваемой валюты |
money2_id | str | ID Принимаемой валюты |
money1_bcode | str | Общепринятый код отдаваемой валюты |
money2_bcode | str | Общепринятый код принимаемой валюты |
money1_memo_tag | str | MEMO TAG отдаваемой валюты |
money2_memo_tag | str | MEMO TAG принимаемой валюты |
amount_money1 | str | Сумма отдаваемой валюты |
amount_money2 | str | Сумма принимаемой валюты |
exchange_rate | str | Курс в заказе |
date_make_order | str | Дата и время создания заказа |
date_end_order | str | Дата и время закрытия заказа |
leftToCloseSeconds | int | Дата и время закрытия заказа |
count_minutes_pay | int | Время фиксации курса в минутах |
status | int | Статус заказа |
payment_number | str | Реквизиты для оплаты |
comment_in | str | Комментарии |
pay_link | str | Ссылка для оплаты |
view_comment | bool | Показывать комметарии к заказу |
view_qr_code | bool | Показывать qr код в заказе |
view_cancel_button | bool | Показывать кнопку отменить заказ |
requisite_verif | bool | Проверять реквизиты |
view_pay_button | bool | Показывать кнопку "Я оплатил" |
money1_currency_type | str | Тип отдаваемой валюты. FIAT (фиатные валюты) COIN (криптовалюты) CODE (гарантекс код) CASH (наличные) |
money2_currency_type | str | Тип принимаемой валюты. FIAT (фиатные валюты) COIN (криптовалюты) CODE (гарантекс код) CASH (наличные) |
money1_view_pay_link | bool | Показывать ссылку на оплату |
money2_link_blockchain | str | Ссылка на обозреватель |
result | bool | Результат заказа |
requisite_fail_message | str | Текст ошибки при указании некорректных реквизитов |
require_check_upload | bool | Проверка чека после оплаты |
recalc_exchange_rate | str | Курс перерассчета |
is_recalc | bool | Перерассчет заявки |
turn_the_course | bool | |
payment_is_in_blockchain | bool | Транзакция в блокчейн |
Файл курсов
import requests
url = "https://alfabit.org/api/exchage.xml"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
curl --location 'https://alfabit.org/api/exchage.xml'
Эндпоинт предназначен для получения курсов
HTTP Request
GET
https://alfabit.org/api/exchage.xml
Состояние приложения
import requests
url = "https://alfabit.org/api/v1/state"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
curl --location 'https://alfabit.org/api/v1/state'
Пример ответа:
{
"result": true
}
Эндпоинт предназначен для получения состояния приложения
HTTP Request
GET
https://alfabit.org/api/v1/state
Websockets
- Базовый URL вебсокета: wss://alfabit.org/stream
- Пользователи могут прослушивать несколько вебсокетов.
Курсы
Пример ответа:
["monitor",{"null_value":4841.8015,"correct_value":4740.524740520001,"time":1681197828627,"next":1681197848627,"type":"monitoring","duration":20,"state":true,"rate_type":"operation","rate_value":4711.861000000001,"min_reserv_competitor":1,"money1_best_code":"DASH","money2_best_code":"GPBRUB","step":0.0001,"monitoring_type":"greed","api_client":"alfabit","use_greed_type":"general","use_step_type":"general","use_position_type":"general","correct_type":"decrease","value":4740.524740520001,"text":"text","action":"end_correction","money1":"DASH","money2":"GPBRUB"}]
["monitor",{"null_value":4841.8015,"correct_value":4740.4863404816,"time":1681197828627,"next":1681197848627,"type":"monitoring","duration":20,"state":true,"rate_type":"operation","rate_value":4711.861000000001,"min_reserv_competitor":1,"money1_best_code":"DASH","money2_best_code":"POSTBRUB","step":0.0001,"monitoring_type":"greed","api_client":"alfabit","use_greed_type":"general","use_step_type":"general","use_position_type":"general","correct_type":"decrease","value":4740.4863404816,"text":"text","action":"end_correction","money1":"DASH","money2":"POSTBRUB"}]
["monitor",{"null_value":104.1875,"correct_value":103.34580334569999,"time":1681197828627,"next":1681197848627,"type":"monitoring","duration":20,"state":true,"rate_type":"operation","rate_value":101.4706,"min_reserv_competitor":1,"money1_best_code":"EOS","money2_best_code":"TCSBRUB","step":0.0001,"monitoring_type":"greed","api_client":"alfabit","use_greed_type":"general","use_step_type":"general","use_position_type":"general","correct_type":"decrease","value":103.34580334569999,"text":"text","action":"end_correction","money1":"EOS","money2":"TCSBRUB"}]
["monitor",{"null_value":270.13734999999997,"correct_value":268.7810687808,"time":1681197828627,"next":1681197848627,"type":"monitoring","duration":20,"state":true,"rate_type":"operation","rate_value":262.48530000000005,"min_reserv_competitor":1,"money1_best_code":"QTUM","money2_best_code":"SBERRUB","step":0.0001,"monitoring_type":"greed","api_client":"alfabit","use_greed_type":"general","use_step_type":"general","use_position_type":"general","correct_type":"decrease","value":268.7810687808,"text":"text","action":"end_correction","money1":"QTUM","money2":"SBERRUB"}]
Подключение к сокету курсов
HTTP Request
wss://alfabit.org/stream/rates/?transport=websocket
Статус заказа
Подключение к сокету статуса заказа
HTTP Request
wss://alfabit.org/stream/order/status/{order_id}?transport=websocket
Параметры запроса
Параметр | Обязательный | Описание |
---|---|---|
order_id | да | Уникальный идентификатор заказа |