getChatGifts
Retrieve gifts owned by a chat with filters for saved, unique, unlimited, and blockchain-transferred items, plus sorting by price and pagination.
Instructions
Returns the gifts received and owned by a chat. Returns an OwnedGifts object on success.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of gifts to be returned; 1-100. Defaults to 100. | |
| offset | No | Offset of the first entry to return as received from the previous request. | |
| chat_id | Yes | Unique identifier for the target chat or username of the target channel (format: @channelusername). | |
| exclude_saved | No | Pass True to exclude gifts that are saved to the chat's profile page. | |
| sort_by_price | No | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | |
| exclude_unique | No | Pass True to exclude unique gifts. | |
| exclude_unsaved | No | Pass True to exclude gifts that are not saved to the chat's profile page. | |
| exclude_unlimited | No | Pass True to exclude gifts that can be purchased unlimited number of times. | |
| exclude_from_blockchain | No | Pass True to exclude gifts transferred from the TON blockchain. | |
| exclude_limited_upgradable | No | Pass True to exclude limited gifts that can be upgraded. | |
| exclude_limited_non_upgradable | No | Pass True to exclude limited gifts that cannot be upgraded. |