New to APIs? No worries! Let’s break down the basics you’ll need to understand before diving into the Multilogin X API.

API

An API (Application Programming Interface) is a way for different software applications to talk to each other. It acts as a bridge that allows one system to request and exchange data with another.

Think of APIs as digital messengers that pass requests between applications, making workflows smoother and faster. The popular real-world analogy is a waiter at a restaurant (API) which brings to you (the user) the meal you've ordered (response to your request). 

Postman

Postman is a popular tool used for testing, developing, and managing APIs. With Postman, you can:

• Send API requests
• See responses in clear formats like JSON
• Use API tokens to authenticate
• Automate repetitive tasks with scripts
• Organize your requests into collections for easy reuse

We recommend starting with Postman – it’s beginner-friendly and helps you learn API basics without needing to code.

API requests & responses

An API request is like ordering food at a restaurant. You tell the kitchen (API) what you want by providing specific details (parameters). The kitchen processes your request and sends back the meal (response).

An API request usually includes:

• Endpoint (URL): where you send your request
• Method: what you want to do (GET, POST, PUT, DELETE)
• Headers: extra info like your API token
• Body: any data you send, like login details

📌 Example: you request weather data in Tallinn from an API, and the API responds with the current temperature and forecast.

GET https://api.weather.com/data?city=Tallinn

API endpoints

An endpoint is a URL where your API request lands. Think of it like a phone number – you dial it to get info or send commands.

📌 Example in Postman:

• GET request to an endpoint: if you send a GET request https://launcher.mlx.yt:45001/api/v1/version in Postman and click "Send”, the API will the app version.
• POST request to an endpoint: if you send a POST request to https://launcher.mlx.yt:45001/api/v2/profile/quick with user details in the body, the API will start a quick profile

In Postman, just paste the endpoint URL and hit "Send" to test.

HTTP request types

APIs use HTTP request types (also called methods) to specify the type of action needed. 

📌 Example: 

• https://launcher.mlx.yt:45001/api/v1/version is a GET request as it returns info
• https://launcher.mlx.yt:45001/api/v2/profile/quick is a POST request as it creates a new quick profile

API tokens

An API token is like a digital key that allows you to securely access an API. When you make a request to the API, you need to include this token, so the system knows who you are and whether you're allowed to perform the action.

Think of it as a hotel key card. Without it, you can’t enter your room (access the API). 

📌 Example: to send a new request in Postman, you first need to copy an API token to the authorization field to authenticate:

Command Line Interface (CLI)

CLI lets you interact with Multilogin X using commands in your terminal – no clicks needed! CLI is great if you like typing commands or want to script things. Postman is more visual, CLI is more for power users.

📌 For example, using cURL (a common CLI tool for API requests), you can send a GET request like this:

curl -X GET "https://api.example.com/users" -H "Authorization: Bearer YOUR_API_TOKEN"

Rate limits

APIs limit how many requests you can send per minute – this is called rate limiting, measured in RPM (requests per minute). Multilogin RPM limit depends on the subscription type – check the pricing page for details.

• RPM tells you how many requests you can send in one minute
• Each time you ask the API to do something (like fetch data or update a record), it counts as one request

📌 Example: if your limit is 100 RPM, you can send up to 100 requests per minute. If you hit your limit, try waiting a minute or upgrading your plan to send more requests!

WebDrivers

A WebDriver is a tool that allows automated interaction with web browsers. It controls the browser just like a real user would – clicking buttons, filling forms, and navigating pages. Multilogin X supports integration with automation libraries like Selenium, Puppeteer, and Playwright, enabling tasks such as form filling, CAPTCHA solving, and web scraping.

Selenium

The most popular WebDriver is Selenium, which works with browsers like Chrome, Firefox, and Edge: it allows automation using programming languages like Python, Java, JavaScript, and C#. 

📌 Selenium WebDriver code in Python example:

from selenium import webdriver

driver = webdriver.Chrome()
driver.get("https://example.com")
print(driver.title)
driver.quit()

Puppeteer

Puppeteer is a Node.js library developed by Google that allows you to automate and control web browsers like Chrome and Chromium programmatically. It provides a high-level API to interact with web pages – clicking buttons, filling forms, scraping data, generating PDFs, and more.

📌 Puppeteer in JavaScript example:

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await page.screenshot({ path: 'example.png' });
  await browser.close();
})();

Playwright

Playwright is a modern open-source automation framework for web testing, developed by Microsoft. It allows you to control web browsers like Chrome, Firefox, and Edge programmatically, just like a real user.

📌 Playwright in JavaScript example:

const { chromium } = require('playwright');

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  console.log(await page.title());
  await browser.close();
})();