Skip to main content

fragment-ton-api

Unofficial async Python client for Fragment.com, TON payments, Telegram Stars, Telegram Premium gifts, and collectible Telegram gifts.

The client signs TON transactions locally. Your wallet mnemonic is not sent to Fragment or to any third-party server.

Links

Installation

pip install fragment-ton-api

Basic Usage

import asyncio
from fragment_api import FragmentClient


async def main():
    client = FragmentClient(
        mnemonic="word1 word2 ... word24",
        toncenter_api_key="API_KEY or None",
        fragment_cookies="stel_ssid=...; stel_token=...",
    )
    try:
        await client.connect_wallet()
        # Fragment operations go here.
    finally:
        await client.close()


asyncio.run(main())

FragmentClient parameters:

  • mnemonic: exactly 24 words for the TON wallet.
  • toncenter_api_key: optional TonCenter API key, useful for some v4r2 wallet operations.
  • wallet_version: "v5r1" by default, or "v4r2".
  • fragment_cookies: cookies from an authorized Telegram session on fragment.com. Without cookies, Fragment may return need_verify.

1. Buy Telegram Stars

result = await client.buy_stars(
    username="@username",
    quantity=50,
    anonymous=True,
)
print(result)

Parameters:

  • username: recipient Telegram username, with or without @.
  • quantity: number of Telegram Stars to buy.
  • anonymous=True: the recipient will not see the sender.
  • anonymous=False: the sender will be visible.

Successful response:

{
  "success": true,
  "error": null
}

Error response:

{
  "success": false,
  "error": {
    "code": "fragment_payment_error",
    "message": "Fragment error description"
  },
  "error_code": "fragment_payment_error"
}

The method finds the user, creates the payment, signs the TON transaction, sends it to the network, and confirms the payment in Fragment.

2. Buy Telegram Premium Gifts

result = await client.buy_premium_gift(
    username="@username",
    months=3,
    anonymous=True,
)
print(result)

Parameters:

  • username: Premium gift recipient.
  • months: usually 3, 6, or 12.
  • anonymous: whether to hide the sender.

Response format:

{
  "success": true,
  "error": null
}

3. List Gift Collections and Gifts

The catalog does not require a wallet:

from fragment_api import FragmentCatalog

catalog = FragmentCatalog()
collections = await catalog.list_collections()
print(collections)

Collection format:

[
  {
    "slug": "lol-pop",
    "name": "Lol Pop",
    "url": "https://fragment.com/gifts/lol-pop"
  }
]

Get available fixed-price gifts:

gifts = await catalog.list_gifts(
    collection_slug="lol-pop",
    limit=20,
    sort="price",
)

Gift item format:

{
  "slug": "lol-pop-12345",
  "collection": "lol-pop",
  "number": 12345,
  "name": "Gift name",
  "price_ton": 1.5,
  "image_url": "https://fragment.com/file/preview.png",
  "url": "https://fragment.com/gift/lol-pop-12345",
  "status": "for_sale"
}

Use the slug value as item_slug or owned_item_slug in purchase and transfer methods.

Current catalog support is focused on fixed-price listings, not auctions.

4. Buy an NFT Gift by item_slug

result = await client.buy_gift(
    item_slug="lol-pop-12345",
    bid_amount="1.5",
)
print(result)

Parameters:

  • item_slug: concrete listing slug from list_gifts().
  • bid_amount: purchase amount in TON. Passing it as a string is recommended.

Example response:

{
  "success": true,
  "error": null
}

After a successful purchase, the gift is assigned to the wallet connected to FragmentClient.

5. Transfer a Purchased Gift to a User

result = await client.transfer_gift(
    owned_item_slug="lol-pop-12345",
    recipient_username="@username",
    anonymous=True,
)
print(result)

Parameters:

  • owned_item_slug: slug of an already purchased gift.
  • recipient_username: Telegram username of the recipient.
  • anonymous: whether to hide the sender.

The method finds the recipient in Fragment, creates the transfer transaction, signs it with the TON wallet, and confirms the transfer.

6. Buy and Deliver a Gift in One Call

result = await client.buy_and_deliver_gift(
    item_slug="lol-pop-12345",
    bid_amount="1.5",
    recipient_username="@username",
    anonymous=True,
)
print(result)

The method performs two steps:

  1. Buys the gift for the connected wallet.
  2. Transfers the gift to the selected Telegram user.

If purchase succeeds but transfer fails, the gift may already be on the sender wallet. Do not buy it again blindly; retry delivery with transfer_gift() first.

7. Check TON Balance

balance, error = await client.get_balance_ton()

if error:
    print("Error:", error)
else:
    print("Balance:", balance, "TON")

Successful result:

(12.345, None)

Error result:

(None, "error description")

Before buying anything, make sure the wallet has enough TON for the gift price and network fees.

Security

Never publish these values in GitHub, README files, examples, logs, screenshots, or issue reports:

  • 24-word TON wallet mnemonic.
  • Fragment cookies.
  • TonCenter API key.
  • PyPI tokens.
  • .env files and local databases.

This package uses Fragment web endpoints, not an official stable public Fragment API. Fragment may change HTML, endpoints, or authorization requirements at any time.

Disclaimer

This is an unofficial project. It is not affiliated with Telegram, Fragment, TON Foundation, or PyPI.

More

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fragment_ton_api-0.1.18.tar.gz (38.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fragment_ton_api-0.1.18-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file fragment_ton_api-0.1.18.tar.gz.

File metadata

  • Download URL: fragment_ton_api-0.1.18.tar.gz
  • Upload date:
  • Size: 38.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.0

File hashes

Hashes for fragment_ton_api-0.1.18.tar.gz
Algorithm Hash digest
SHA256 ba8f48ae33acc50640d5decd14451d05da3ff5072b736c50ac3696781fd9cade
MD5 5618e7ef068c4f05fbb9054457175ea9
BLAKE2b-256 d00bf3d1d593c68b75ad2c1c27404e336ec610459445822f4c0f133b9504d725

See more details on using hashes here.

File details

Details for the file fragment_ton_api-0.1.18-py3-none-any.whl.

File metadata

File hashes

Hashes for fragment_ton_api-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 1f1c1a401a9668086ef225d781ab2a4e2ec6cf596ce4206fd332211667ec0ced
MD5 a38abf38a8edeea947fc5d453c1e8bbc
BLAKE2b-256 ac448b056d55d42bbecf3ad938c258323be5b5302b25c630b2874b2b24bf1700

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page