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

Metadata

Release files for fragment-ton-api 0.1.23

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fragment-ton-api 0.1.23
File Size Uploaded
fragment_ton_api-0.1.23.tar.gz 38.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fragment-ton-api 0.1.23
File Interpreter ABI Platform
fragment_ton_api-0.1.23-py3-none-any.whl Python 3 none any Details

Total release size: 65.5 kB

Release files / fragment_ton_api-0.1.23.tar.gz

Download URL fragment_ton_api-0.1.23.tar.gz
Size 38.6 kB
Tags Source
SHA-256 checksum
How to use checksums
090b1d2f511b3851b5408c4e92eef8d4b15017fe0651900df67b3fab8fcf0584
BLAKE2b-256 checksum
How to use checksums
dda98a4e0db84731ed44c72b73b1222b672b12627e409b22ac201c15913d4c7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.0

Release files / fragment_ton_api-0.1.23-py3-none-any.whl

Download URL fragment_ton_api-0.1.23-py3-none-any.whl
Size 27.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ef6a598cbc750d3dab4b7dfe2712279460208bf3220fa8824e29e056273e84a0
BLAKE2b-256 checksum
How to use checksums
588b022886570158d08502820b1e0574112657f3d563895ada6754bd7d5deeb2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.0

Release history Release notifications | RSS feed

This release

0.1.23 This release

2 release files

0.1.15

1 release file

0.1.14

1 release file

0.1.13

1 release file

0.1.12

1 release file

0.1.11

1 release file

0.1.10

1 release file

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page