No project description provided
Project description
SDK для работы с TON Rocket
⚙️ Установка
pip install tonrocketapisdk
🔐 Авторизация
Как получить токен написано тут.
from tonrocketapisdk import *
api = RocketApi('токен')
Testnet:
from tonrocketapisdk import *
api = RocketApi('токен', True)
⬇️ Навигация
🚀 Методы
- 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.3.tar.gz
(4.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tonrocketapisdk-1.0.3.tar.gz.
File metadata
- Download URL: tonrocketapisdk-1.0.3.tar.gz
- Upload date:
- Size: 4.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d4a9878045e253f6049c616fce72e092ef39daa2184df0f1e46a58202b502c2b
|
|
| MD5 |
c5d0b39fc585102d64ae5c85eb9eca9b
|
|
| BLAKE2b-256 |
694ed4c4696b0d7f5519fc98f06096251809356b3e6b50e6bfd15962f2cc39ec
|
File details
Details for the file tonrocketapisdk-1.0.3-py3-none-any.whl.
File metadata
- Download URL: tonrocketapisdk-1.0.3-py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c39dd2db95531cceea53f7b20b7fd63ad7cf7546d0e51336ea729d10a82222ce
|
|
| MD5 |
1a0ee66f4e2e7c8e089901580403330c
|
|
| BLAKE2b-256 |
281b3e9159ff218299d436f2a33e7e566ba462c7c101c12f18617b8e1e374651
|