Перед началом
Добро пожаловать в официальную документацию shaxta24_bot API.
Что бы использовать API, Вам нужен API key. Свяжитесь с нами https://t.me/shaxta3 что бы его получить.
Авторизация
shaxta24_bot API ожидает получить в параметрах каждого вашего запроса apiKey.
apiKey
- ваш публичный ключ;
Пример кода на Python:
import requests
params = {
'apiKey': 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
}
response = requests.post('https://btcapiplus.space/api/?balance', params=params)
Пример Curl command:
curl 'https://btcapiplus.space/api/?balance' \
--data 'apiKey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
В ответ, Вам всегда возвращается JSON строка, в которой имеется обьязательные поля:
status
может быть ok
и error
При статусе ok
возвращается поле data
в котором находится ответ на запрос
{
"status":"ok",
"data":{
"id":1
}
}
При статусе error
возвращается полеerror
в котором находится сообщение об ошибке
{"status":"error","error":"Order already processed"}
Курс валют
Чтобы узнать баланс, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?exchange-rate
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
Ответ data
Поле | Тип | Описание |
---|---|---|
btc_rub_buy | Float | Курс BTC покупка |
ltc_rub_buy | Float | Курс LTC покупка |
usdt_rub_buy | Float | Курс USDT покупка |
btc_rub_sell | Float | Курс BTC продажа |
ltc_rub_sell | Float | Курс LTC продажа |
Проверка баланса
Чтобы узнать баланс, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?balance
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
Ответ data
Поле | Тип | Описание |
---|---|---|
balance | Integer | Баланс |
Создание заявки с покупки криптовалюты
Чтобы создать новую заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?new-order-buy-crypto
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
amount | Integer | Да | Сумма обмена RUB. |
type_fiat | String | Да | Тип оплаты (CARD, SBP) |
cryptocurrency | String | Да | Криптовалюта (BTC, LTC, USDT) |
cryptocurrency_wallet | String | Да | Крипто-адрес. |
callback_url | String | Нет | На этот адрес вы получите пустой GET запрос как только средства будут зачислены |
Ответ data
Поле | Тип | Описание |
---|---|---|
orderId | Integer | ID Вашей заявки в системе. |
amountExc | Integer | Сумма которую нужно первести |
amountCrypto | Float | Сумма которую получите в криптовалюте |
paymentData | Long | Реквизиты. |
bank | String | Банк |
holder_name | String | ФИО |
Создание заявки покупки (баланс ЛК)
Адрес личного кабинета запросите у https://t.me/shaxta3
Чтобы создать новую заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?new-order
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
amount | Integer | Да | Сумма обмена RUB. |
type_fiat | String | Да | Тип оплаты (CARD, SBP) |
callback_url | String | Нет | На этот адрес вы получите пустой GET запрос как только средства будут зачислены |
Ответ data
Поле | Тип | Описание |
---|---|---|
orderId | Integer | ID Вашей заявки в системе. |
amountExc | Integer | Сумма которую нужно первести |
paymentData | Long | Реквизиты. |
bank | String | Банк |
holder_name | String | ФИО |
Создание заявки с продажи криптовалюты
Чтобы создать новую заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?new-order-sell-crypto
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
amount | Integer | Да | Сумма обмена RUB. |
cryptocurrency | String | Да | Криптовалюта (BTC, LTC) |
payment_data | Long | Да | Номер банковской карты |
callback_url | String | Нет | На этот адрес вы получите пустой GET запрос как только средства будут зачислены |
Ответ data
Поле | Тип | Описание |
---|---|---|
orderId | Integer | ID Вашей заявки в системе. |
cryptocurrency | String | Криптовалюта |
amountExc | Integer | Сумма которую получите |
amountCrypto | Float | Количество монет, которое нужно перевести |
paymentData | String | Адрес крипто-кошелька |
Получение списка заявок (Покупка)
Чтобы получить список заявок, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?get-orders-buy
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
status | String | Нет |
Статуст заявки: waiting : Заявка ожидает оплаты или подвержденияconfirmed : Заявка подтвержденаdeclined : Заявка отклонена
|
offset | Integer | Нет | Отступ, пропуск указанного количества строк |
Ответ data
Поле | Тип | Описание |
---|---|---|
id | Integer | ID заявки |
type | String | Тип заявки |
status | String | Статус заявки |
amount_exchange | Integer | Сумма к получению |
amount_without_com | Integer | Сумма без комиссии |
amount_with_com | Integer | Сумма с комиссией |
date | String | Дата создание заявки |
date_processing | String | Дата обработки заявки |
Получение списка заявок (Продажа)
Чтобы получить список заявок, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?get-orders-sell
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
status | String | Нет |
Статуст заявки: waiting : Заявка ожидает оплаты или подвержденияconfirmed : Заявка подтвержденаdeclined : Заявка отклонена
|
offset | Integer | Нет | Отступ, пропуск указанного количества строк |
Ответ data
Поле | Тип | Описание |
---|---|---|
id | Integer | ID заявки |
type | String | Тип заявки |
status | String | Статус заявки |
amount_exchange | Integer | Количество монет |
amount_without | Integer | Сумма выплаты |
wallet | String | Адресс кошелька |
txid | String | TXID транзакции |
card | String | Карта для выплаты |
date | String | Дата создание заявки |
date_processing | String | Дата обработки заявки |
Проверка статуса заявки
Чтобы проверить заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?check-order
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
type_order | String | Да |
Тип заявки: buy : Заявка на покупку (Покупка криптовалюты или баланс ЛК)sell : Заявка на продажу (Продажа криптовалюты)
|
orderId | Integer | Да | ID Вашей заявки |
Ответ data
Поле | Тип | Описание |
---|---|---|
status | String | Статус заявки |
Cтатус | Описание |
---|---|
waiting | Заявка ожидает оплаты или подверждения |
confirmed | Заявка подтверждена |
declined | Заявка отклонена |
error | Ошибка |
Отмена заявки
Чтобы отменить заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://btcapiplus.space/api/?cancel-order
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
type_order | String | Да |
Тип заявки: buy : Заявка на покупку (Покупка криптовалюты или баланс ЛК)sell : Заявка на продажу (Продажа криптовалюты)
|
orderId | Integer | Да | ID Вашей заявки |
Ответ status
Поле | Тип | Описание |
---|---|---|
status | String | Статус заявки (ok или error) |
Ошибки
Вы можете получить следующий текст ошибок
Текст ошибки | Описание |
---|---|
Api Key field is empty |
Вы не передали API ключ
|
Api key invalid |
Некорректный API ключ
|
Api key disabled |
API ключ отключён
|
Method disabled | Метод отключён |
Invalid amount | Некорректная сумма обмена |
Invalid type fiat | Некорректная тип оплаты |
Minimum exchange amount {amount} | Сумма обмена меньше, чем минимальный порог |
Maximum exchange amount {amount} | Сумма обмена больше, чем максимальный порог |
No requisites available | Нет доступных реквизитов |
Error creating order | Ошибка при создании заявки |
Invalid crypto currency | Неверная криптовалюта |
Invalid card number | Некорректный номер карты |
Invalid crypto address | Неверный крипто-адрес |
Invalid callback URL | Некорректный callback URL |
Invalid ID | Некорректный ID заявки |
Invalid type order | Некорректный тип заявки |
Access is denied | Доступ закрыт |
Order already processed | Заявка уже обработана |