MadelineProtoDocs/docs/API_docs/methods/contacts.getTopPeers.md

title	description	grand_parent	parent	image	redirect_from
contacts.getTopPeers	Get most used peers	Telegram RPC API	Methods	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
phone_calls	Bool	Most frequently called users	Optional
forward_users	Bool	Users to which the users often forwards messages to	Optional
forward_chats	Bool	Chats to which the users often forwards messages to	Optional
groups	Bool	Often-opened groups and supergroups	Optional
channels	Bool	Most frequently visited channels	Optional
bots_app	Bool		Optional
offset	int	Offset for pagination	Optional
limit	int	Maximum number of results to return, see pagination	Optional
hash	Array of [long|string](/API_docs/types/long	string.html)	Hash for pagination, for more info click here

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, phone_calls: $Bool, forward_users: $Bool, forward_chats: $Bool, groups: $Bool, channels: $Bool, bots_app: $Bool, offset: $int, limit: $int, hash: [$long|string, $long|string], );