Chat.get_members()

Chat.get_members()

Bound method get_members of Chat.

Use as a shortcut for:

async for member in client.get_chat_members(chat_id):
    print(member)

Example

async for member in chat.get_members():
    print(member)
Parameters:

  • query (str, optional) – Query string to filter members based on their display names and usernames. Only applicable to supergroups and channels. Defaults to “” (empty string). A query string is applicable only for SEARCH, BANNED and RESTRICTED filters only.

  • limit (int, optional) – Limits the number of members to be retrieved.

  • filter (ChatMembersFilter, optional) – Filter used to select the kind of members you want to retrieve. Only applicable for supergroups and channels.

Returns:

Generator – On success, a generator yielding ChatMember objects is returned.