Ism bo'yicha foydalanuvchilarni qidirish

GET/v1/search/1₽ per 2xx

Berilgan ism bo’yicha mos keluvchi foydalanuvchilar ro’yxatini qaytaradi. Javobda faqat foydalanuvchilarning asosiy maydonlari bo’ladi (id, username, name, is_bot, is_deleted). To’liq profil uchun GET /v1/users/{identifier} ga murojaat qiling.

Avtorizatsiya

Api-Key sarlavhasi kerak.

Query-parametrlar

Nom	Tur	Majburiy	Standart	Tavsif
name	string	ha	—	Bo’sh bo’lmagan ism yoki qidiruv iborasi.
raw	boolean	yo’q	false	Agar true bo’lsa, faqat aniq mos keluvchilarni qaytaradi.

Misollar

cURL

# Noaniq qidirish
curl -G -H "Api-Key: $API_KEY" \
  --data-urlencode "name=john" \
  https://api.telesint.dev/v1/search/

# Aniq mos kelish
curl -G -H "Api-Key: $API_KEY" \
  --data-urlencode "name=John Doe" \
  --data-urlencode "raw=true" \
  https://api.telesint.dev/v1/search/

Python

import os, requests

def search_users(name: str, raw: bool = False) -> list[dict]:
    response = requests.get(
        "https://api.telesint.dev/v1/search/",
        headers={"Api-Key": os.environ["API_KEY"]},
        params={"name": name, "raw": raw},
        timeout=10,
    )
    response.raise_for_status()
    return response.json()["data"]

matches = search_users("john")

JavaScript

async function searchUsers(name, { raw = false } = {}) {
  const params = new URLSearchParams({ name, raw: String(raw) });
  const res = await fetch(
    `https://api.telesint.dev/v1/search/?${params}`,
    { headers: { 'Api-Key': process.env.API_KEY } },
  );
  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  const { data } = await res.json();
  return data;
}

const users = await searchUsers('john');

Javob — 200 OK

{
  "data": [
    {
      "id": 12345,
      "username": "johndoe",
      "name": "John Doe",
      "is_bot": false,
      "is_deleted": false
    },
    {
      "id": 67890,
      "username": null,
      "name": "John",
      "is_bot": false,
      "is_deleted": false
    }
  ]
}

Maydonlar — data[]

Maydon	Tur	Tavsif
id	integer	Foydalanuvchi ID si.
username	string | null	Username, agar mavjud bo’lsa.
name	string	Ko’rsatiladigan ism.
is_bot	boolean | null	Botlar uchun true.
is_deleted	boolean | null	O’chirilgan hisoblar uchun true.

To’liq matnli va aniq qidirish

• To’liq matnli (standart, raw=false) — dolzarblik bo’yicha tartiblangan 50 tagacha natijani qaytaradi.
• Aniq (raw=true) — name maydoni so’rovga aniq mos kelishi kerak.

Xatoliklar

• 422 — name parametri yo’q yoki bo’sh.
• Qarang Xatoliklar.