MadelineProtoDocs/docs/API_docs/methods/contacts.search.md
2019-12-27 17:48:04 +01:00

55 lines
1.4 KiB
Markdown

---
title: contacts.search
description: Returns users found by username substring.
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: contacts.search
[Back to methods index](index.md)
Returns users found by username substring.
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|q|[string](../types/string.md) | Target substring | Yes|
|limit|[int](../types/int.md) | Maximum number of users to be returned | Yes|
### Return type: [contacts\_Found](../types/contacts_Found.md)
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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_Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]);
```
Or, if you're into Lua:
```lua
contacts_Found = contacts.search({q='string', limit=int, })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|QUERY_TOO_SHORT|The query string is too short|
|400|SEARCH_QUERY_EMPTY|The search query is empty|
|-503|Timeout|Timeout while fetching data|