MadelineProto/old_docs/API_docs_v62/methods/contacts_getTopPeers.md

title	description
contacts.getTopPeers	Get most used chats

Method: contacts.getTopPeers

Back to methods index

Get most used chats

Parameters:

Name	Type	Required	Description
correspondents	CLICK ME Bool	Optional	Fetch users?
bots_pm	CLICK ME Bool	Optional	Fetch bots?
bots_inline	CLICK ME Bool	Optional	Fetch inline bots?
groups	CLICK ME Bool	Optional	Fetch groups?
channels	CLICK ME Bool	Optional	Fetch channels and supergroups?
offset	CLICK ME int	Yes	Initially 0, then $offset += $contacts_TopPeers['categories']['count'];
limit	CLICK ME int	Yes	How many results to fetch
hash	CLICK ME int	Yes

Return type: contacts_TopPeers

Can bots use this method: NO

Errors this method can return:

Error	Description
TYPES_EMPTY	The types field is empty

MadelineProto Example:

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';

$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();

$contacts_TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => int, ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/contacts.getTopPeers

Parameters:

correspondents - Json encoded Bool

bots_pm - Json encoded Bool

bots_inline - Json encoded Bool

groups - Json encoded Bool

channels - Json encoded Bool

offset - Json encoded int

limit - Json encoded int

hash - Json encoded int

Or, if you're into Lua:

contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, })