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.17.tar.gz (37.5 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.17-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fragment_ton_api-0.1.17.tar.gz
  • Upload date:
  • Size: 37.5 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.17.tar.gz
Algorithm Hash digest
SHA256 5ed97ba076b03a574362ba1ad9cab8050b37ad10557ab3fb78a0dacef3cf6326
MD5 ddbccc9d8e44144468cd1fcc935ab878
BLAKE2b-256 9df7fe71e88ab954bb2796fb6a4e96cdfb1e40a1993d6d9774936167566740cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fragment_ton_api-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 079c24478e0ac4cfefd8c3df3277c5bc7e2f64c90f371c99d5a9eb8966a713d5
MD5 41987bb55a99bd50d334649f1bcc5fa7
BLAKE2b-256 bd5f6aa1c578eabd6c95e0bda55803ce801fa9b3bb45a99d14c8bd1f695a2be9

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