No project description provided
Project description
SDK для работы с TON Rocket
⚙️ Установка
pip install tonrocketapisdk
🔐 Авторизация
Как получить токен написано тут.
from tonrocketapisdk import *
api = RocketApi('токен')
⬇️ Навигация
🚀 Методы
- getAppInfo
- transfer
- withdrawal
- createCheque
- getCheques
- getCheque
- editCheque
- deleteCheque
- createInvoice
- getInvoices
- getInvoice
- deleteInvoice
- getCoins
- getCurrencies
🚀 Методы
Параметры отмеченные знаком * являются обзательными
getAppInfo
Параметр | Информация |
---|---|
Не принимает параметров |
Пример:
api.getAppInfo()
transfer
Параметр | Информация |
---|---|
tgUserId* | ID получателя перевода |
amount* | Сумма перевода |
currency | Валюта перевода. По умолчанию: "TONCOIN" |
transferId | По умолчанию: "12345" |
description | По умолчанию: "" |
Пример:
api.transfer({
"tgUserId": 87209764,
"currency": "TONCOIN",
"amount": 1.23,
"transferId": "abc-def",
"description": "You are awesome!"
})
withdrawal
Параметр | Информация |
---|---|
address* | TON кошелек, на который нужно отправить монеты |
amount* | Сумма перевода |
currency | Валюта для вывода. По умолчанию: "TONCOIN" |
withdrawalId | По умолчанию: "12345" |
comment | По умолчанию: "" |
Пример:
api.withdrawal({
"address": "EQB1cmpxb3R-YLA3HLDV01Rx6OHpMQA_7MOglhqL2CwJx_dz",
"currency": "TONCOIN",
"amount": 1.23,
"withdrawalId": "abc-def",
"comment": "You are awesome!"
})
createCheque
Документация Все параметры как в документации
Пример:
api.createCheque({
"chequePerUser": 0.005,
"usersNumber": 100,
"refProgram": 50,
"password": "pwd",
"description": "This cheque is the best",
"sendNotifications": true,
"enableCaptcha": true,
"telegramResourcesIds": [
"-1001799549067"
]
})
getCheques
Параметр | Информация |
---|---|
Не принимает параметров |
Пример:
api.getCheques()
getCheque
Параметр | Информация |
---|---|
id* | ID чека |
Пример:
api.getCheque({
id: 1234
})
deleteCheque
Параметр | Информация |
---|---|
id* | ID чека |
Пример:
api.deleteCheque({
id: 1234
})
createInvoice
Все параметры как в документации
Пример:
api.createInvoice({
"amount": 1.23,
"description": "best thing in the world, 1 item",
"hiddenMessage": "thank you",
"callbackUrl": "https://t.me/ton_rocket",
"payload": "some custom payload I want to see in webhook or when I request invoice",
"expiredIn": 10
})
getInvoices
Параметр | Информация |
---|---|
Не принимает параметров |
Пример:
api.getInvoices()
getInvoice
Параметр | Информация |
---|---|
id* | ID счёта |
Пример:
api.getInvoice({
id: 1234
})
deleteInvoice
Параметр | Информация |
---|---|
id* | ID счёта |
Пример:
api.deleteInvoice({
id: 1234
})
getCoins
Параметр | Информация |
---|---|
Не принимает параметров |
Пример:
api.getCoins()
getCurrencies
Параметр | Информация |
---|---|
coinFrom* | ID токена |
coinTo* | ID токена |
Пример:
api.getCurrencies({
coinFrom: Assets.TON,
coinTo: Assets.SCALE
})
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tonrocketapisdk-1.0.1.tar.gz
(3.9 kB
view hashes)
Built Distribution
Close
Hashes for tonrocketapisdk-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5faf9ba71d49b7a0caeffcd1c64ee2b85b0e1157b222089dbd73e11948e8e2eb |
|
MD5 | 54cd26be38588f8561c35407c802ce85 |
|
BLAKE2b-256 | b4cf96fb373881afe6c97d127ce03cfd095eb7335dddce0ab42a4bca217f30ff |