MadelineProtoDocs/old_docs/API_docs_v66/methods/contacts.getTopPeers.md

title	description	image	redirect_from
contacts.getTopPeers	Get most used peers	https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png	/API_docs/methods/contacts_getTopPeers.html

Method: contacts.getTopPeers

Back to methods index

Get most used peers

Parameters:

Name	Type	Description	Required
correspondents	Bool	Users we've chatted most frequently with	Optional
bots_pm	Bool	Most used bots	Optional
bots_inline	Bool	Most used inline bots	Optional
groups	Bool	Often-opened groups and supergroups	Optional
channels	Bool	Most frequently visited channels	Optional
offset	int	Offset for pagination	Yes
limit	int	Maximum number of results to return, see pagination	Yes
hash	Array of int	Peer IDs of previously cached peers	Optional

Return type: contacts.TopPeers

Can bots use this method: NO

MadelineProto Example (now async for huge speed and parallelism!):

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

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$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, 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}, })

Errors

Code	Type	Description
400	TYPES_EMPTY	No top peer type was provided