cryptobot package

Subpackages

• cryptobot.models package
  • Module contents
    • App
      • App.__init__()
      • App.app_id
      • App.name
      • App.payment_processing_bot_username
    • AppStats
      • AppStats.__init__()
      • AppStats.conversion
      • AppStats.created_invoice_count
      • AppStats.end_at
      • AppStats.paid_invoice_count
      • AppStats.start_at
      • AppStats.unique_users_count
      • AppStats.volume
    • Asset
      • Asset.BNB
      • Asset.BTC
      • Asset.ETH
      • Asset.LTC
      • Asset.TON
      • Asset.TRX
      • Asset.USDC
      • Asset.USDT
    • Balance
      • Balance.__init__()
      • Balance.available
      • Balance.currency_code
      • Balance.onhold
    • ButtonName
      • ButtonName.callback
      • ButtonName.openBot
      • ButtonName.openChannel
      • ButtonName.viewItem
    • Check
      • Check.__init__()
      • Check.activated_at
      • Check.amount
      • Check.asset
      • Check.bot_check_url
      • Check.check_id
      • Check.created_at
      • Check.hash
      • Check.status
    • CheckStatus
      • CheckStatus.activated
      • CheckStatus.active
    • Currency
      • Currency.__init__()
      • Currency.code
      • Currency.decimals
      • Currency.is_blockchain
      • Currency.is_fiat
      • Currency.is_stablecoin
      • Currency.name
      • Currency.url
    • ExchangeRate
      • ExchangeRate.__init__()
      • ExchangeRate.is_crypto
      • ExchangeRate.is_fiat
      • ExchangeRate.is_valid
      • ExchangeRate.rate
      • ExchangeRate.source
      • ExchangeRate.target
    • Invoice
      • Invoice.__init__()
      • Invoice.accepted_assets
      • Invoice.allow_anonymous
      • Invoice.allow_comments
      • Invoice.amount
      • Invoice.asset
      • Invoice.bot_invoice_url
      • Invoice.comment
      • Invoice.created_at
      • Invoice.currency_type
      • Invoice.description
      • Invoice.expiration_date
      • Invoice.fee
      • Invoice.fee_amount
      • Invoice.fee_asset
      • Invoice.fee_in_usd
      • Invoice.fiat
      • Invoice.hash
      • Invoice.hidden_message
      • Invoice.invoice_id
      • Invoice.is_swapped
      • Invoice.mini_app_invoice_url
      • Invoice.paid_amount
      • Invoice.paid_anonymously
      • Invoice.paid_asset
      • Invoice.paid_at
      • Invoice.paid_btn_name
      • Invoice.paid_btn_url
      • Invoice.paid_fiat_rate
      • Invoice.paid_usd_rate
      • Invoice.pay_url
      • Invoice.payload
      • Invoice.status
      • Invoice.swap_to
      • Invoice.swapped_output
      • Invoice.swapped_rate
      • Invoice.swapped_to
      • Invoice.swapped_uid
      • Invoice.swapped_usd_amount
      • Invoice.swapped_usd_rate
      • Invoice.usd_rate
      • Invoice.web_app_invoice_url
    • Status
      • Status.active
      • Status.expired
      • Status.paid
    • Transfer
      • Transfer.__init__()
      • Transfer.amount
      • Transfer.asset
      • Transfer.comment
      • Transfer.completed_at
      • Transfer.spend_id
      • Transfer.status
      • Transfer.transfer_id
      • Transfer.user_id
    • TransferStatus
      • TransferStatus.completed

Submodules

cryptobot.client module

class cryptobot.client.AsyncCryptoBotClient(api_token: str, is_mainnet: bool = True, timeout: float = 5.0, max_retries: int = 0, retry_backoff: float = 0.5, retryable_status_codes: Set[int] | None = None)

Bases: object

Async Crypto Bot API client for modern service workloads.

__init__(api_token: str, is_mainnet: bool = True, timeout: float = 5.0, max_retries: int = 0, retry_backoff: float = 0.5, retryable_status_codes: Set[int] | None = None)

async close() → None

async create_check(asset: Asset, amount: float, pin_to_user_id: int | None = None, pin_to_username: str | None = None) → Check

Create a new crypto check.

async create_invoice(amount: float, asset: Asset | None = None, currency_type: str | None = None, fiat: str | None = None, accepted_assets: str | None = None, description: str | None = None, hidden_message: str | None = None, paid_btn_name: ButtonName | None = None, paid_btn_url: str | None = None, payload: str | None = None, allow_comments: bool | None = None, allow_anonymous: bool | None = None, expires_in: int | None = None, swap_to: str | None = None) → Invoice

async delete_check(check_id: int) → bool

Delete a check by ID.

async delete_invoice(invoice_id: int) → bool

Delete an invoice by ID.

async get_balances() → List[Balance]

async get_checks(asset: Asset | None = None, check_ids: str | List[int] | None = None, status: CheckStatus | None = None, offset: int = 0, count: int = 100) → List[Check]

Get a list of checks.

async get_currencies() → List[Currency]

async get_exchange_rates() → List[ExchangeRate]

async get_invoices(asset: Asset | None = None, fiat: str | None = None, invoice_ids: str | List[int] | None = None, status: Status | None = None, offset: int = 0, count: int = 100) → List[Invoice]

async get_me() → App

async get_stats(start_at: str | None = None, end_at: str | None = None) → AppStats

Get app statistics.

async get_transfers(asset: Asset | None = None, transfer_ids: str | List[int] | None = None, spend_id: str | None = None, offset: int = 0, count: int = 100) → List[Transfer]

Get a list of transfers.

async iter_check_pages(asset: Asset | None = None, check_ids: str | List[int] | None = None, status: CheckStatus | None = None, page_size: int = 100, start_offset: int = 0) → AsyncIterator[List[Check]]

Iterate over check result pages.

async iter_checks(asset: Asset | None = None, check_ids: str | List[int] | None = None, status: CheckStatus | None = None, page_size: int = 100, start_offset: int = 0) → AsyncIterator[Check]

Iterate checks item-by-item across paginated results.

async iter_invoice_pages(asset: Asset | None = None, invoice_ids: str | List[int] | None = None, status: Status | None = None, page_size: int = 100, start_offset: int = 0) → AsyncIterator[List[Invoice]]

async iter_invoices(asset: Asset | None = None, invoice_ids: str | List[int] | None = None, status: Status | None = None, page_size: int = 100, start_offset: int = 0) → AsyncIterator[Invoice]

async iter_transfer_pages(asset: Asset | None = None, transfer_ids: str | List[int] | None = None, spend_id: str | None = None, page_size: int = 100, start_offset: int = 0) → AsyncIterator[List[Transfer]]

Iterate over transfer result pages.

async iter_transfers(asset: Asset | None = None, transfer_ids: str | List[int] | None = None, spend_id: str | None = None, page_size: int = 100, start_offset: int = 0) → AsyncIterator[Transfer]

Iterate transfers item-by-item across paginated results.

async transfer(user_id: int, asset: Asset, amount: float, spend_id: str, comment: str | None = None, disable_send_notification: bool = False) → Transfer

cryptobot.errors module

exception cryptobot.errors.CryptoBotError(code: int, name: str)

Bases: Exception

__init__(code: int, name: str) → None

code: int

classmethod from_json(json: Any) → CryptoBotError

name: str

cryptobot.webhook module

Module contents

Top-level package for CryptoBot Python.