GramJS

messages.GetRecentLocations

Get live location history of a certain user

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.messages.GetRecentLocations({
      peer: "username",
      limit: 100,
      hash: 0,
    })
  );
  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.messages.Messages = await client.invoke(
    new Api.messages.GetRecentLocations({
      peer: "username",
      limit: 100,
      hash: 0,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
peerInputPeerUser
limitintMaximum number of results to return, see pagination
hashintHash for pagination, for more info click here

Result

messages.Messages

Possible errors

CodeTypeDescription

Can bots use this method?

No

Pagination in the API

How to fetch results from large lists of objects.