مستندات روشا
روشا (ROSHA)، پلتفرم دادهٔ بازار سرمایه، دادهٔ بورس تهران، فرابورس ایران و صندوق‌های سرمایه‌گذاری را از دو راه تحویل می‌دهد: یک REST API و یک سرور MCP. دادهٔ معاملاتی از TSETMC و دادهٔ صندوق‌ها از فیپیران (FIPIran) گردآوری می‌شود.
چطور به داده وصل شوم؟
Section titled “چطور به داده وصل شوم؟”دو راه دارید و هر دو با یک کلید کار می‌کنند و دادهٔ یکسانی برمی‌گردانند.
| راه | برای چه کسی | نشانی |
|---|---|---|
| REST API | برنامه‌نویس و سامانه؛ درخواست HTTP می‌فرستید و JSON می‌گیرید | https://poolick.ir/v1 |
| سرور MCP | دستیار هوش مصنوعی مثل Claude، Cursor و Gemini CLI؛ به فارسی می‌پرسید و دستیار ابزار مناسب را صدا می‌زند | https://poolick.ir/mcp |
شرح کامل REST در مرجع API و شرح MCP در MCP چیست و چطور وصل شوم؟ آمده است. طرح OpenAPI هم در /openapi.json در دسترس است.
چه داده‌ای موجود است؟
Section titled “چه داده‌ای موجود است؟”هر endpoint در یک «خانوادهٔ داده» قرار دارد و پلن شما مشخص می‌کند به کدام خانواده‌ها دسترسی دارید. پلن‌های زیر مطابق وضعیت آبان ۱۴۰۵ است؛ فهرست به‌روز در قیمت‌ها است.
| خانواده | endpointها | پلن لازم |
|---|---|---|
| پایه (همیشه مجاز) | جست‌وجو و مشخصات نماد، تقویم معاملاتی، فهرست، انواع و شناسنامهٔ صندوق‌ها | همهٔ پلن‌ها، از رایگان |
history |
سابقهٔ روزانهٔ قیمت، رویدادهای تعدیل، حقیقی و حقوقی، سابقهٔ شاخص‌ها، سابقه و snapshot صندوق‌ها | همهٔ پلن‌ها، از رایگان |
intraday |
quote، ریزمعاملات و کندل درون‌روز | حرفه‌ای و سازمانی |
mcp |
همهٔ ابزارهای MCP | همهٔ پلن‌ها، از رایگان |
چیزهایی که روشا پوشش نمی‌دهد: دادهٔ بنیادی و اطلاعیه‌های کدال، و قیمت ارز و طلا.
از کجا شروع کنم؟
Section titled “از کجا شروع کنم؟”در سه گام به اولین پاسخ می‌رسید.
- در پنل با شمارهٔ موبایل یا ایمیل ثبت‌نام کنید. کلید رایگان همان لحظه نمایش داده می‌شود.
- کلید را در متغیر محیطی
ROSHA_KEYبگذارید. - اولین درخواست را بفرستید:
curl "https://poolick.ir/v1/instruments/IRO1FOLD0001/daily?limit=5" \ -H "Authorization: Bearer $ROSHA_KEY"جزئیات هر گام در شروع سریع است.
صفحه‌های پرکاربرد
Section titled “صفحه‌های پرکاربرد”- شروع سریع: اولین پاسخ در دو دقیقه، با curl، پایتون و جاوااسکریپت.
- احراز هویت و کلیدها: سرآیندها، چرخش و ابطال کلید.
- قراردادها و قالب‌ها: تاریخ، ریال،
ins_code، ترتیب ردیف‌ها وlimit. - محدودیت‌ها و پلن‌ها و خطاها: سقف‌ها و هر کد خطا با راه رفع آن.
- به‌روزرسانی داده‌ها: هر داده چه ساعتی تازه می‌شود.
- پایتون و pandas، جاوااسکریپت، اکسل و Power Query.
- همگام‌سازی روزانه با پایگاه داده و مهاجرت از اسکرپینگ TSETMC.
- وضعیت سرویس، قیمت‌ها و پشتیبانی.
English summary
Section titled “English summary”
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 https://poolick.ir/v1 and an MCP server at https://poolick.ir/mcp. Authenticate with Authorization: Bearer $ROSHA_KEY; a free key is issued at https://poolick.ir/panel/. Prices are in Iranian rials, timestamps are Asia/Tehran, request dates accept ISO, yyyymmdd or Jalali, history rows are ordered oldest first, and ins_code is a string. The documentation is in Persian; endpoint names, parameters and code are in English. Machine-readable entry points: /openapi.json and /pricing.json.
صفحهٔ اصلی · قیمت‌ها · وضعیت · پنل · پشتیبانی
داده‌ها توصیهٔ سرمایه‌گذاری نیست. سلب مسئولیت