Skip to content

mbaneshi/pytonapi

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyTONAPI

PyPI Python Versions License

Python wrapper for tonapi.io
Note: You need an API key to use it, get it here tonconsole.com

Features

  • Asynchronous and Synchronous Calls:
    Enjoy the flexibility of both asynchronous and synchronous variants for API calls.

  • Response Validation with Pydantic Models:
    All response data is validated using Pydantic models, ensuring that you receive structured and validated information.

  • Convenient Data Manipulation:
    The wrapper facilitates seamless manipulation of data, such as converting balances to nanotons or amounts.

  • Extensive Examples:
    Explore a variety of examples in the examples folder to help you get started and understand different use cases.

Dependencies

  • httpx - A fully featured HTTP client for Python 3, which provides sync and async
  • pydantic - Data validation and settings management using Python type hints
  • libscrc - Library for calculating CRC-16, CRC-CCITT, CRC-32 checksums APIs
  • websockets - A library for building WebSocket servers and clients in Python

Installation

pip install pytonapi

Usage

Synchronous Example:

from pytonapi import Tonapi


def main():
    # Create a new Tonapi object with the provided API key
    tonapi = Tonapi(api_key="Your API key")

    # Specify the account ID
    account_id = "EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess"  # noqa

    # Retrieve account information
    account = tonapi.accounts.get_info(account_id=account_id)

    # Print account details
    print(f"Account Address (raw): {account.address.to_raw()}")
    print(f"Account Address (userfriendly): {account.address.to_userfriendly(is_bounceable=True)}")
    print(f"Account Balance (nanoton): {account.balance.to_nano()}")
    print(f"Account Balance (amount): {account.balance.to_amount()}")


if __name__ == '__main__':
    main()

Asynchronous Example:

from pytonapi import AsyncTonapi


# Declare an asynchronous function for using await
async def main():
    # Create a new Tonapi object with the provided API key
    tonapi = AsyncTonapi(api_key="Your API key")

    # Specify the account ID
    account_id = "EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess"  # noqa

    # Retrieve account information asynchronously
    account = await tonapi.accounts.get_info(account_id=account_id)

    # Print account details
    print(f"Account Address (raw): {account.address.to_raw()}")
    print(f"Account Address (userfriendly): {account.address.to_userfriendly(is_bounceable=True)}")
    print(f"Account Balance (nanoton): {account.balance.to_nano()}")
    print(f"Account Balance (amount): {account.balance.to_amount()}")


if __name__ == '__main__':
    import asyncio

    # Run the asynchronous function
    asyncio.run(main())

More Examples:
Additional examples can be found in the examples folder.

Donations:


EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess

About

Python wrapper for tonapi.io v2.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%