---
title: فهرست هشدارها — GET /api/v1/price-alerts | Stard API
url: https://stard-market.ir/docs/reference/price-alerts-list
markdown: https://stard-market.ir/docs/reference/price-alerts-list.md
language: fa
updated: 2026-11-18
description: هشدارهای همین محیط، با وضعیت active، triggered یا cancelled و آخرین قیمت دیده‌شده.
---

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

`GET /api/v1/price-alerts`

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

## درخواست

| نام | محل | نوع |  | توضیح |
|---|---|---|---|---|
| `Authorization` | header | `string` | الزامی | `Bearer sk_live_…` یا `Bearer sk_test_…` |

## نمونه

```bash
curl "https://stard-market.ir/api/v1/price-alerts" \
  -H "Authorization: Bearer $STARD_API_KEY"
```

```javascript
const res = await fetch("https://stard-market.ir/api/v1/price-alerts", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.STARD_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);
```

```typescript
type StardError = { error: { type: string; code: string; message: string; param: string | null; request_id: string } };

const res = await fetch("https://stard-market.ir/api/v1/price-alerts", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.STARD_API_KEY}`,
  },
});
if (!res.ok) {
  const { error } = (await res.json()) as StardError;
  throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const data: Record<string, unknown> = await res.json();
```

```python
import os
import requests

r = requests.get(
    "https://stard-market.ir/api/v1/price-alerts",
    headers={
    "Authorization": f"Bearer {os.environ['STARD_API_KEY']}",
    },
    timeout=20,
)
data = r.json()
if r.status_code >= 400:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)
```

```php
<?php
$ch = curl_init("https://stard-market.ir/api/v1/price-alerts");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("STARD_API_KEY"),
  ],
  CURLOPT_TIMEOUT => 20,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) {
  throw new RuntimeException($data["error"]["code"] . ": " . $data["error"]["message"]);
}
print_r($data);
```

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://stard-market.ir/api/v1/price-alerts", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("STARD_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(b))
}
```

**پاسخ — 200**

```json
{
  "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
}
```

**هدرهای پاسخ**

```http
content-type: application/json
x-request-id: req_UYDrAyIBjU17RVAMfvsK
x-ratelimit-limit: 1000
x-ratelimit-remaining: 978
```

## خطاها

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

## محدودیت نرخ

پیش‌فرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای `X-RateLimit-*` برمی‌گردد — [جزئیات](https://stard-market.ir/docs/rate-limits).
