StardDevelopersداشبورد

بررسی یوزرنیم

GET/api/v1/usernames/check
scope: products:readاحراز هویت: Bearerlive و test

آیا این یوزرنیم در فروشگاه Stard برای فروش هست و قیمتش چقدر است. وضعیت مالکیت یا حراج خارج از Stard را از fragment_url ببین. برای ابزارهای مانیتورینگ یوزرنیم.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…
usernamequerystringالزامییوزرنیم با یا بدون @

نمونه

curl "https://stard-market.ir/api/v1/usernames/check?username=example" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 200
{
  "object": "username",
  "username": "example",
  "listed_on_stard": false,
  "available_to_buy": false,
  "price": null,
  "product_id": null,
  "fragment_url": "https://fragment.com/username/example",
  "note": "در فروشگاه Stard نیست؛ وضعیت مالکیت/حراج را در Fragment ببین."
}
هدرهای پاسخ
content-type: application/json
x-request-id: req_0pt9R1qkU4RWLcuyDhSh
x-ratelimit-limit: 1000
x-ratelimit-remaining: 986

کاربرد و نکته‌ها

کی به کار می‌آید؟ برای ابزار جست‌وجو یا مانیتورینگ یوزرنیم: می‌گوید یوزرنیم در فروشگاه Stard فروشی هست یا نه (listed_on_stard، available_to_buy)، قیمتش (price به تومان) و شناسه‌ی محصول برای خرید با POST /orders.

  • اگر یوزرنیم در Stard نیست، fragment_url صفحه‌ی همان یوزرنیم در فرگمنت است؛ مالکیت، مزایده و فروش خارج از Stard را آنجا ببین.
  • ورودی با یا بدون @ پذیرفته می‌شود؛ یوزرنیم معتبر ۴ تا ۳۲ کاراکتر است و با حرف شروع می‌شود، وگرنه 400 parameter_invalid.
  • برای فهرست کامل یوزرنیم‌های فروشی از GET /products/usernames استفاده کن و برای راهنمای عمومی خرید یوزرنیم تلگرام را ببین.

خطاها

HTTPcodeکی
400parameter_invalidیوزرنیم نامعتبر (۴ تا ۳۲ کاراکتر، شروع با حرف)
403insufficient_scopeکلید scope products:read را ندارد
401invalid_api_key / missing_api_key / api_key_revoked / api_key_expiredکلید نیامده، نامعتبر، باطل یا منقضی است
429rate_limit_exceededسقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست

محدودیت نرخ

پیش‌فرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمی‌گردد — جزئیات.