MadelineProto/old_docs/API_docs_v57/methods/contacts_getTopPeers.md

title	description
contacts.getTopPeers	contacts.getTopPeers parameters, return type and example

Method: contacts.getTopPeers

Back to methods index

Parameters:

Name	Type	Required
correspondents	Bool	Optional
bots_pm	Bool	Optional
bots_inline	Bool	Optional
groups	Bool	Optional
channels	Bool	Optional
offset	int	Yes
limit	int	Yes
hash	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

Example:

$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
    $MadelineProto->phone_login($number);
    $code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
    $MadelineProto->complete_phone_login($code);
}

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

Or, if you're using the PWRTelegram HTTP API:

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, })