GramJS

contacts.Search

Returns users found by username substring.

Example

const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.contacts.Search({
      q: "some string here",
      limit: 100,
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.contacts.Found = await client.invoke(
    new Api.contacts.Search({
      q: "some string here",
      limit: 100,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
qstringTarget substring
limitintMaximum number of users to be returned

Result

contacts.Found

Possible errors

CodeTypeDescription
400QUERY_TOO_SHORTThe query string is too short.
400SEARCH_QUERY_EMPTYThe search query is empty.

Can bots use this method?

No