StardDevelopersداشبورد

ساخت هشدار قیمت

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

وقتی قیمت استارز، TON یا یک محصول از حد تعیین‌شده پایین‌تر یا بالاتر رفت، یک بار رویداد وب‌هوک price.alert برایت فرستاده می‌شود (بررسی هر دقیقه). حداکثر ۵۰ هشدار فعال. برای دریافت، یک وب‌هوک هم‌محیط بساز.

درخواست

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

بدنه (JSON)

فیلدنوعتوضیح
assetstringالزامیstars، ton یا product
product_idintegerاختیاریبرای asset=product
conditionstringالزامیbelow یا above
priceintegerالزامیقیمت هدف به تومان

نمونه

curl -X POST "https://stard-market.ir/api/v1/price-alerts" \
  -H "Authorization: Bearer $STARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asset": "stars", "condition": "below", "price": 4000}'
پاسخ — 201
{
  "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"
}
هدرهای پاسخ
content-type: application/json
x-request-id: req_58yHzL3zlPLzO9HFld2x
x-ratelimit-limit: 1000
x-ratelimit-remaining: 979

خطاها

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

محدودیت نرخ

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