Guides

Starting the Client

Main Walkthrough 2 of 25

This guide explains how to construct a client and authorize an account with start. It assumes that you have already installed MTKruto.

Acquiring API Credentials

For your client to be able to authorize accounts, you need to have your own Telegram API credentials. To do that, you should create an application.

Visit my.telegram.org/apps.
Enter your phone number and log in.
Fill in the form.
Click “Create application.”

After creating the application, the site displays its API ID and API hash.

It is recommended that these credentials are not leaked.

Constructing the Client

Client is the most essential class—it represents an MTProto client. Through it, you can interact with Telegram.

In fact, the constructor has no required arguments, but you usually pass the parameters storage, apiId, and apiHash, unless you know what you are doing.

The following examples show you how you can construct a client that uses the storage adapter StorageLocalStorage.

import { Client, StorageLocalStorage } from "@mtkruto/mtkruto";

const client = new Client({
  storage: new StorageLocalStorage("my_client"),
  // Replace these with your app's credentials.
  apiId: 123456,
  apiHash: "",
});

import { Client, StorageLocalStorage } from "@mtkruto/node";

const client = new Client({
  storage: new StorageLocalStorage("my_client"),
  // Replace these with your app's credentials.
  apiId: 123456,
  apiHash: "",
});

import { Client, StorageLocalStorage } from "https://cdn.jsdelivr.net/npm/@mtkruto/browser@0.214.0/esm/mod.js";

const client = new Client({
  storage: new StorageLocalStorage("my_client"),
  // Replace these with your app's credentials.
  apiId: 123456,
  apiHash: "",
});

Connecting the Client and Authorizing an Account

The start method connects the client and authorizes an account.

If you pass no arguments to it, you will be requested the authorization credentials in runtime. You can also design your own user authorization experience by specifying resolver functions for each authorization step. For bots, it is recommended that the bot token is passed directly. If an account is already authorized or all credentials are passed directly, no credentials will be requested.

Here is how you can authorize a bot with its token.

await client.start({ botToken: "1234567890:AABCDEFGHIJKLMNOP" });

Here is an example of using custom resolver functions to authorize a user.

// The functions may also return promises.
await client.start({
  phone: () => prompt("Enter your phone number:")!,
  code: () => prompt("Enter the code you received:")!,
  password: () => prompt("Enter your account's password:")!,
});

console.log("Started.");

const { createInterface } = require("node:readline");
const { stdin: input, stdout: output } = require("node:process");

const readline = createInterface({ input, output });
const prompt = (q) => new Promise((r) => readline.question(q + " ", r));

// Note that you cannot have top-level awaits in CommonJS contexts.
// It is recommended that this call is moved into a main async function,
// and that you continue with the other guides in that function's body.
client.start({
  phone: () => prompt("Enter your phone number:"),
  code: () => prompt("Enter the code you received:"),
  password: () => prompt("Enter your account's password:"),
}).then(() => {
  console.log("Started.");
});

Run the code and confirm that it logs “Started.”