get_pinned_stories()

Client.get_pinned_stories()

Get all pinned stories from a chat by using chat identifier.

Usable by Users Bots
Parameters:

  • chat_id (``int`` | ``str``) – Unique identifier (int) or username (str) of the target chat.

  • offset_id (``int``, *optional*) – Offset event identifier from which to start returning results. By default, no offset is applied and events will be returned starting from the latest.

  • limit (``int``, *optional*) – Maximum amount of events to be returned. By default, all events will be returned.

Returns:

``Generator`` (On success, a generator yielding Story objects is returned.)

Example

# Get all pinned story
async for story in app.get_pinned_stories(chat_id):
    print(story)