# مستندات روشا

> شروع کار با REST API و سرور MCP روشا برای دادهٔ بورس تهران، فرابورس ایران و صندوق‌های سرمایه‌گذاری.
> Source: https://poolick.ir/docs/

روشا (ROSHA)، پلتفرم دادهٔ بازار سرمایه، دادهٔ بورس تهران، فرابورس ایران و صندوق‌های سرمایه‌گذاری را از دو راه تحویل می‌دهد: یک REST API و یک سرور MCP. دادهٔ معاملاتی از TSETMC و دادهٔ صندوق‌ها از فیپیران (FIPIran) گردآوری می‌شود.

## چطور به داده وصل شوم؟

دو راه دارید و هر دو با یک کلید کار می‌کنند و دادهٔ یکسانی برمی‌گردانند.

| راه | برای چه کسی | نشانی |
|---|---|---|
| REST API | برنامه‌نویس و سامانه؛ درخواست HTTP می‌فرستید و JSON می‌گیرید | `https://poolick.ir/v1` |
| سرور MCP | دستیار هوش مصنوعی مثل Claude، Cursor و Gemini CLI؛ به فارسی می‌پرسید و دستیار ابزار مناسب را صدا می‌زند | `https://poolick.ir/mcp` |

شرح کامل REST در [مرجع API](/docs/api/) و شرح MCP در [MCP چیست و چطور وصل شوم؟](/docs/mcp/) آمده است. طرح OpenAPI هم در [`/openapi.json`](https://poolick.ir/openapi.json) در دسترس است.

## چه داده‌ای موجود است؟

هر endpoint در یک «خانوادهٔ داده» قرار دارد و پلن شما مشخص می‌کند به کدام خانواده‌ها دسترسی دارید. پلن‌های زیر مطابق وضعیت آبان ۱۴۰۵ است؛ فهرست به‌روز در [قیمت‌ها](/pricing/) است.

| خانواده | endpointها | پلن لازم |
|---|---|---|
| پایه (همیشه مجاز) | [جست‌وجو و مشخصات نماد](/docs/api/instruments/)، [تقویم معاملاتی](/docs/api/calendar/)، [فهرست، انواع و شناسنامهٔ صندوق‌ها](/docs/api/funds/) | همهٔ پلن‌ها، از رایگان |
| `history` | [سابقهٔ روزانهٔ قیمت](/docs/api/daily/)، [رویدادهای تعدیل](/docs/api/adjustments/)، [حقیقی و حقوقی](/docs/api/client-type/)، [سابقهٔ شاخص‌ها](/docs/api/indices/)، [سابقه و snapshot صندوق‌ها](/docs/api/funds/) | همهٔ پلن‌ها، از رایگان |
| `intraday` | [quote، ریزمعاملات و کندل درون‌روز](/docs/api/intraday/) | حرفه‌ای و سازمانی |
| `mcp` | همهٔ [ابزارهای MCP](/docs/mcp/tools/) | همهٔ پلن‌ها، از رایگان |

چیزهایی که روشا پوشش نمی‌دهد: دادهٔ بنیادی و اطلاعیه‌های کدال، و قیمت ارز و طلا.

## از کجا شروع کنم؟

در سه گام به اولین پاسخ می‌رسید.

1. در [پنل](/panel/signup/) با شمارهٔ موبایل یا ایمیل ثبت‌نام کنید. کلید رایگان همان لحظه نمایش داده می‌شود.
2. کلید را در متغیر محیطی `ROSHA_KEY` بگذارید.
3. اولین درخواست را بفرستید:

```bash
curl "https://poolick.ir/v1/instruments/IRO1FOLD0001/daily?limit=5" \
  -H "Authorization: Bearer $ROSHA_KEY"
```

جزئیات هر گام در [شروع سریع](/docs/quickstart/) است.

## صفحه‌های پرکاربرد

- [شروع سریع](/docs/quickstart/): اولین پاسخ در دو دقیقه، با curl، پایتون و جاوااسکریپت.
- [احراز هویت و کلیدها](/docs/authentication/): سرآیندها، چرخش و ابطال کلید.
- [قراردادها و قالب‌ها](/docs/conventions/): تاریخ، ریال، `ins_code`، ترتیب ردیف‌ها و `limit`.
- [محدودیت‌ها و پلن‌ها](/docs/limits/) و [خطاها](/docs/errors/): سقف‌ها و هر کد خطا با راه رفع آن.
- [به‌روزرسانی داده‌ها](/docs/freshness/): هر داده چه ساعتی تازه می‌شود.
- [پایتون و pandas](/docs/python/)، [جاوااسکریپت](/docs/javascript/)، [اکسل و Power Query](/docs/guides/excel/).
- [همگام‌سازی روزانه با پایگاه داده](/docs/guides/daily-sync/) و [مهاجرت از اسکرپینگ TSETMC](/docs/guides/migrate-from-scraping/).
- [وضعیت سرویس](/status/)، [قیمت‌ها](/pricing/) و [پشتیبانی](/contact/).

## English summary

<p lang="en" dir="ltr">
ROSHA (روشا) is a market-data platform. It serves Tehran Stock Exchange (TSE), Iran Fara Bourse (IFB) and Iranian mutual-fund data through a REST API at <code>https://poolick.ir/v1</code> and an MCP server at <code>https://poolick.ir/mcp</code>. Authenticate with <code>Authorization: Bearer $ROSHA_KEY</code>; a free key is issued at <code>https://poolick.ir/panel/</code>. Prices are in Iranian rials, timestamps are Asia/Tehran, request dates accept ISO, <code>yyyymmdd</code> or Jalali, history rows are ordered oldest first, and <code>ins_code</code> is a string. The documentation is in Persian; endpoint names, parameters and code are in English. Machine-readable entry points: <code>/openapi.json</code> and <code>/pricing.json</code>.
</p>