مستندات BoxAPI
API جامع، کامل و ساده

Search Users

این اندپوینت به شما این امکان را می‌دهد که با وارد کردن یک رشتهٔ متنی (مثل نام کاربری یا بخشی از آن)، حساب‌های اینستاگرامی که نام آن‌ها با این رشته مطابقت دارد را پیدا کنید. این قابلیت برای یافتن کاربران نزدیک به نام مورد نظر یا بررسی سریع حساب‌های مشابه کاربرد دارد.

پارامتر ورودی:

  • query (الزامی): رشته‌ای که می‌خواهید بر اساس آن کاربران را جستجو کنید (مثلاً نام کاربری یا بخشی از آن)

خروجی: پاسخ به صورت JSON شامل لیستی از کاربران (تا ۵۰ مورد) است، که هر کاربر در لیست ممکن است دارای فیلدهایی مانند موارد زیر باشد:

  • id: شناسه عددی کاربر
  • username: نام کاربری کاربر
  • full_name: نام کامل کاربر (در صورت وجود)
  • profile_picture_link: لینک تصویر پروفایل کاربر
  • و اطلاعات تکمیلی…
Name Type Default Description
query (required) string The search query
curl --request POST \
--url https://boxapi.ir/api/instagram/user/search \
--user 'boxapi_username:boxapi_password' \
--data '{
    "query": "Boxapi.ir"
}'