# شاخص‌ها

> سابقهٔ روزانهٔ شاخص‌های بورس و فرابورس مثل شاخص کل در API روشا؛ پیدا کردن شناسهٔ شاخص، پارامترها، نمونهٔ پاسخ و شرح فیلدهای close، low و high.
> Source: https://poolick.ir/docs/api/indices/

`GET /v1/indices/{ref}/daily` مقدار پایانی، کمترین و بیشترین یک شاخص را برای هر روز برمی‌گرداند. شاخص‌ها در روشا نماد به شمار می‌آیند؛ شناسهٔ شاخص را با جست‌وجوی نماد پیدا می‌کنید. این endpoint در خانوادهٔ `history` است.

## چطور شناسهٔ یک شاخص را پیدا کنم؟

با [`GET /v1/instruments?q=…`](/docs/api/instruments/) جست‌وجو کنید و نتیجه‌ای را بردارید که `is_index: true` دارد.

```bash
curl -G "https://poolick.ir/v1/instruments" \
  --data-urlencode "q=شاخص کل" -d "limit=3" \
  -H "Authorization: Bearer $ROSHA_KEY"
```

| شاخص | `ins_code` |
|---|---|
| شاخص کل | `32097828799138957` |
| شاخص کل (هم وزن) | `67130298613737946` |
| شاخص کل فرابورس | `43685683301327984` |

## پارامترها

| پارامتر | نوع | پیش‌فرض | معنا |
|---|---|---|---|
| `ref` | رشته، در مسیر | – | `insCode` شاخص یا نام دقیق آن، مثل `شاخص کل` |
| `start` | تاریخ | بدون حد | اولین روز بازه (خود آن روز هم می‌آید) |
| `end` | تاریخ | بدون حد | آخرین روز بازه (خود آن روز هم می‌آید) |
| `limit` | عدد صحیح | `1000` | N ردیف آخر بازه را نگه می‌دارد. سقف `5000`. |

## چطور سابقهٔ شاخص کل را بگیرم؟

```bash
curl "https://poolick.ir/v1/indices/32097828799138957/daily?limit=2" \
  -H "Authorization: Bearer $ROSHA_KEY"
```

پاسخ یک آرایه است، از قدیم به جدید:

```json
[
  {"d": "2026-11-10", "close": 8357840.4, "low": 8337230.0, "high": 8358070.0},
  {"d": "2026-11-11", "close": 8427303.9, "low": 8427300.0, "high": 8540000.0}
]
```

## فیلدهای پاسخ

| فیلد | نوع | واحد | معنا |
|---|---|---|---|
| `d` | تاریخ | میلادی ISO | روز |
| `close` | عدد | واحد شاخص | مقدار پایانی شاخص |
| `low` | عدد | واحد شاخص | کمترین مقدار روز |
| `high` | عدد | واحد شاخص | بیشترین مقدار روز |

## نکته‌ها و حالت‌های مرزی

- **شکل پاسخ:** آرایهٔ ساده است، نه شیئی با `rows`. فیلد `open`، حجم و `jdate` ندارد.
- **مسیر درست:** برای شاخص از `/v1/indices/{ref}/daily` استفاده کنید. `/v1/instruments/{ref}/daily` برای شاخص `rows` خالی برمی‌گرداند.
- **`ref` نامعتبر:** `404` با `{"detail": "instrument not found: …"}`.
- **بازهٔ خالی:** پاسخ `[]` با وضعیت `200`.
- **زمان تازه‌شدن:** با دادهٔ پایان روز، ساعت ۱۸:۱۵ تهران، شنبه تا چهارشنبه.
- **ابزار MCP معادل:** `get_index_history` (پیش‌فرض `limit=120`، سقف `500`).