رفتن به محتوا

مرجع کامل API

REST API روشا ۱۵ endpoint دارد که همه GET هستند، زیر https://poolick.ir/v1 قرار دارند و JSON برمی‌گردانند. جدول زیر همه را با خانوادهٔ داده‌شان نشان می‌دهد.

نشانی پایه و احراز هویت

Section titled “نشانی پایه و احراز هویت”

نشانی پایه https://poolick.ir/v1 است و هر درخواست کلید را در سرآیند Authorization: Bearer می‌فرستد.

Terminal window
curl "https://poolick.ir/v1/instruments/IRO1FOLD0001" \
-H "Authorization: Bearer $ROSHA_KEY"

طرح ماشین‌خوان همهٔ مسیرها (OpenAPI) در https://poolick.ir/openapi.json است.

روش مسیر خانواده کاربرد
GET /v1/instruments همیشه مجاز جست‌وجوی نماد و شاخص با نام، نماد، InstrumentID یا ISIN
GET /v1/instruments/{ref} همیشه مجاز مشخصات یک نماد، همراه با نام گروه صنعت
GET /v1/instruments/{ref}/daily history سابقهٔ روزانهٔ قیمت و حجم، خام یا تعدیل‌شده
GET /v1/instruments/{ref}/adjustments history رویدادهای تعدیل قیمت (افزایش سرمایه و سود نقدی)
GET /v1/instruments/{ref}/client-type history خرید و فروش حقیقی و حقوقی به تفکیک روز
GET /v1/indices/{ref}/daily history سابقهٔ روزانهٔ یک شاخص
GET /v1/instruments/{ref}/quote intraday آخرین قیمت و عمق بازار
GET /v1/instruments/{ref}/trades intraday ریزمعاملات یک روز
GET /v1/instruments/{ref}/bars intraday کندل‌های OHLCV درون‌روز
GET /v1/calendar همیشه مجاز روزهای معاملاتی یک بازه
GET /v1/funds همیشه مجاز فهرست و جست‌وجوی صندوق‌ها با آخرین ارقام
GET /v1/funds/types همیشه مجاز کد و نام انواع صندوق
GET /v1/funds/{ref} همیشه مجاز شناسنامهٔ صندوق، زیرصندوق‌ها، آخرین ارقام و سودهای تقسیمی
GET /v1/funds/{ref}/history history سابقهٔ روزانهٔ صندوق در سطح شمارهٔ ثبت
GET /v1/funds/{ref}/snapshots history ارقام روزانهٔ هر زیرصندوق

«همیشه مجاز» یعنی هر پلنی به آن دسترسی دارد. اینکه هر پلن کدام خانواده را دارد در محدودیت‌ها و پلن‌ها آمده است.

این قاعده‌ها برای همهٔ endpointها یکی است و شرح کامل آن‌ها در قراردادها و قالب‌ها است.

  • {ref} در مسیرهای نماد و شاخص: insCode، InstrumentID یا ISIN، یا نماد فارسی دقیق.
  • {ref} در مسیرهای صندوق: شمارهٔ ثبت، نماد صندوق، نام دقیق، یا insCode صندوق قابل معامله.
  • تاریخ در درخواست: 2026-11-11، 20261111 یا شمسی 1405-08-20.
  • مبالغ به ریال؛ ins_code رشته؛ ردیف‌های سابقه از قدیم به جدید؛ limit یعنی N ردیف آخر بازه.
  • خطاها در خطاها و زمان تازه‌شدن هر داده در به‌روزرسانی داده‌ها.

۱۲ ابزار MCP همین داده‌ها را به دستیارهای هوش مصنوعی می‌دهند. ریزمعاملات (/trades) و snapshot زیرصندوق‌ها (/snapshots) فقط در REST هستند. جدول تطبیق در ابزارهای MCP است.

صفحهٔ اصلی · قیمت‌ها · وضعیت · پنل · پشتیبانی
داده‌ها توصیهٔ سرمایه‌گذاری نیست. سلب مسئولیت