Skip to content

GramIO API Reference / gramio/dist / GetUserGiftsParams

Interface: GetUserGiftsParams

Defined in: @gramio/types/out/params.d.ts:3043

Params object for getUserGifts method

Properties

PropertyTypeDescriptionDefined in
exclude_from_blockchain?booleanPass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram@gramio/types/out/params.d.ts:3063
exclude_limited_non_upgradable?booleanPass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique@gramio/types/out/params.d.ts:3059
exclude_limited_upgradable?booleanPass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique@gramio/types/out/params.d.ts:3055
exclude_unique?booleanPass True to exclude unique gifts@gramio/types/out/params.d.ts:3067
exclude_unlimited?booleanPass True to exclude gifts that can be purchased an unlimited number of times@gramio/types/out/params.d.ts:3051
limit?numberThe maximum number of gifts to be returned; 1-100. Defaults to 100@gramio/types/out/params.d.ts:3079
offset?stringOffset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results@gramio/types/out/params.d.ts:3075
sort_by_price?booleanPass True to sort results by gift price instead of send date. Sorting is applied before pagination.@gramio/types/out/params.d.ts:3071
user_idnumberUnique identifier of the user@gramio/types/out/params.d.ts:3047