Collections

API ver.: 2.0

Returns up-to-date information on Telegram gift collections

HTTP Request

GET https://api.giftstat.app/current/collections

Query Parameters

Parameter

Description

limit

UInt
Number of elements in data. Maximum: 500, default: 200

offset

UInt
Data offset for pagination

fields

String (optional)
Comma-separated list of fields to return. If not specified, all fields are returned
Example: fields=id,collection,star_price

Response Structure

HTTP code: 200 - OK

{
    "data": [],
    "meta": {
        "limit": 200, 
        "offset": 0,
        "count": 0,
        "api_path": "/current/collections",
    }
}

Available Fields

Field

Description

_id

String
Collection ID (string, alias for str_id)

id

UInt
Collection ID (unsigned integer)

str_id

String
Collection ID (string)

collection

String
Collection name

collection_slug

String
Collection slug (name without spaces and special characters)

star_price

UInt
Base gift price in Telegram Stars

is_limited

Bool
Is the collection limited edition?

is_sold_out

Bool
Is the collection sold out?

first_sale_date

DateTime
Date and time of first gift sale in the collection (UTC +0)

last_sale_date

DateTime
Date and time of last available gift sale in the collection (UTC +0)

total_amount

UInt
Total collection supply

issued

UInt
Maximum available quantity of gifts. Total supply minus gifts exchanged for stars and burned through crafting

minted

UInt
Number of minted (upgraded) gifts

non_minted

UInt
Number of non-minted gifts
issued - minted

burned

UInt
Number of gifts exchanged for stars and burned through crafting
total_amount - issued

blockchain_address

String
Collection address in TON blockchain

API ver.: 2.0