StardDevelopersداشبورد

فهرست هشدارها

GET/api/v1/price-alerts
scope: prices:readاحراز هویت: Bearerlive و test

هشدارهای همین محیط، با وضعیت active، triggered یا cancelled و آخرین قیمت دیده‌شده.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…

نمونه

curl "https://stard-market.ir/api/v1/price-alerts" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 200
{
  "object": "list",
  "data": [
    {
      "object": "price_alert",
      "id": "pa_9SzgiaSZTsX3dqeX10BI",
      "environment": "test",
      "asset": "stars",
      "product_id": null,
      "condition": "below",
      "price": {
        "amount": 4000,
        "currency": "IRT"
      },
      "status": "active",
      "last_value": null,
      "triggered_at": null,
      "created_at": "2026-10-02T17:43:25Z"
    }
  ],
  "has_more": false,
  "next_offset": null,
  "total": 1
}
هدرهای پاسخ
content-type: application/json
x-request-id: req_UYDrAyIBjU17RVAMfvsK
x-ratelimit-limit: 1000
x-ratelimit-remaining: 978

خطاها

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

محدودیت نرخ

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