TablokhaniAPIمرجع
/api/v1

داده‌های بورس تهران، یک‌جا در قالب API

این API قیمت و دفتر سفارش لحظه‌ای، تاریخچه‌ی قیمت، اطلاعات بنیادی شرکت‌ها، سهامداران عمده، هم‌گروه‌های صنعت، تعدیل سرمایه و اندیکاتورهای تکنیکال بورس و فرابورس تهران را در اختیارتان می‌گذارد — به‌همراه یک استریم لحظه‌ای برای حساب‌های Pro و Gold. برای امتحان زنده‌ی هر اندپوینت، کلید خود را در بالای صفحه وارد کنید و روی «نمایش خروجی» بزنید؛ همین صفحه مستقیماً همان API واقعی را فرا می‌خواند و پاسخ واقعی نشان می‌دهد.

● زنده — درخواست واقعی، پاسخ واقعی۳۰+ اندپوینت REST۱ استریم لحظه‌ای

شروع به کار

  1. با موبایل یا ایمیل خود در صفحه‌ی ورود ثبت‌نام کنید — یک حساب رایگان روی پلن Free برایتان ساخته می‌شود.
  2. اگر به سقف درخواست بالاتر یا قابلیت‌های Pro/Gold نیاز دارید، از داشبورد پلن خود را ارتقا دهید.
  3. از همان داشبورد یک کلید API بسازید و در جای امنی نگه دارید — مقدار خام آن فقط یک‌بار نمایش داده می‌شود.
  4. کلید را در فیلد بالای همین صفحه وارد کنید تا بتوانید هر اندپوینت را همین‌جا زنده امتحان کنید.

احراز هویت

کلید خود را در هدر X-API-Key بفرستید. کلید نامعتبر یا باطل‌شده خطای 401 برمی‌گرداند؛ ارسال کلید در query-string یا به‌صورت Bearer-token پشتیبانی نمی‌شود.

پلن‌ها و محدودیت نرخ

تفاوت اصلی پلن‌ها، سقف تعداد درخواست در دقیقه است (برای هر کلید API، در یک بازه‌ی متحرک ۶۰ ثانیه‌ای). استریم لحظه‌ای و اطلاعات بنیادی فقط برای Pro و Gold، و فیلتر بازار (Screener) فقط برای Gold در دسترس است؛ در غیر این صورت همه‌ی داده‌ها روی هر پلنی یکسان است. تمدید هر ساعت از کیف پول شما انجام می‌شود — در صورت کمبود موجودی، به‌جای قطع سرویس، حساب به پلن Free برمی‌گردد.

  • Freeرایگان
    • محدودیت نرخ: ۲ درخواست در دقیقه
    • استریم لحظه‌ای: ندارد
    • اطلاعات بنیادی: ندارد
    • فیلتر بازار (Screener): ندارد
  • Basic۴۹۰,۰۰۰ تومان / ۳۰ روزه
    • محدودیت نرخ: ۵ درخواست در دقیقه
    • استریم لحظه‌ای: ندارد
    • اطلاعات بنیادی: ندارد
    • فیلتر بازار (Screener): ندارد
  • Pro۱,۴۹۰,۰۰۰ تومان / ۳۰ روزه
    • محدودیت نرخ: ۳۰ درخواست در دقیقه
    • استریم لحظه‌ای: دارد
    • اطلاعات بنیادی: دارد
    • فیلتر بازار (Screener): ندارد
  • Gold۴,۹۹۰,۰۰۰ تومان / ۳۰ روزه
    • محدودیت نرخ: نامحدود
    • استریم لحظه‌ای: دارد
    • اطلاعات بنیادی: دارد
    • فیلتر بازار (Screener): دارد

اندپوینت‌های داده بازار

تمام مسیرهای این بخش نسبت به /api/v1 هستند.

GET/fundamentals

P/E، P/B، ROE، حاشیه‌های سود، رشد، بازده و قدرت خرید همه‌ی نمادها در یک پاسخ — مخصوص پلن‌های Pro و Gold. با symbol یا industry می‌توانید نتیجه را به یک نماد یا صنعت خاص محدود کنید.

Free Basic Pro Gold
نماد — اختیاری، برای گرفتن فقط یک نماد به‌جای کل بازار (تطبیق دقیق روی ticker)
صنعت یا زیرمجموعه‌ی صنعت — اختیاری، جست‌وجوی زیررشته‌ای روی industry و sector (مثلاً «فلزات» یا «خودرو»)
GET/market/sector

صنعت یک نماد و تمام هم‌گروه‌های آن را همراه با آخرین قیمت پایانی‌شان برمی‌گرداند.

Free Basic Pro Gold
نماد، نام شرکت یا insCode
GET/market/statistics

آمارهای رسمی خود tsetmc برای هر نماد، از جمله میانگین ارزش معاملات و رتبه‌ی آن در ۳ و ۱۲ ماه اخیر.

Free Basic Pro Gold
نماد، نام شرکت یا insCode
GET/market/adjustments

فهرست رویدادهای تعدیل قیمت یک نماد (افزایش سرمایه، تقسیم سود) به‌همراه ضریب هر رویداد، مستقیماً از tsetmc.

Free Basic Pro Gold
نماد، نام شرکت یا insCode
GET/market/snapshot

عکس لحظه‌ای کل بازار سهام در یک پاسخ — قیمت، تغییرات، حجم/ارزش/تعداد معاملات و دفتر سفارش ۵سطحی هر نماد، بدون آمارهای شبانه‌ی /screener. با symbol می‌توانید نتیجه را به یک نماد محدود کنید. روی همه‌ی پلن‌ها در دسترس است.

Free Basic Pro Gold
نماد یا insCode — اختیاری، برای گرفتن فقط یک نماد به‌جای کل بازار
GET/market/shareholder-companies

⚠️ غیرقابل‌اتکا — جست‌وجوی معکوس فهرست شرکت‌هایی که یک سهامدار عمده در آن‌ها سهم دارد (shareholderShareId از خروجی متدهای سهامداران به‌دست می‌آید)، اما منبع آن در tsetmc ناپایدار است: در آزمایش زنده، فراخوانی مکرر همان شناسه در عرض یک دقیقه سه پاسخ کاملاً متفاوت و بی‌ربط برگرداند. تا رفع این ناپایداری در سمت tsetmc، خروجی این متد را یک نمونه‌ی احتمالی بدانید، نه پاسخ قطعی.

Free Basic Pro Gold
عدد شناسه سهامدار
GET/screener

خروجی کامل فیلتر بازار برای همه‌ی سهام بورس و فرابورس در یک پاسخ — قیمت و دفتر سفارش لحظه‌ای، به‌همراه ده‌ها آمار رسمی فیلتر tsetmc (is1 تا is89) که هر شب محاسبه می‌شوند. فیلترسازی را خودتان روی این داده انجام می‌دهید. مخصوص پلن Gold.

Free Basic Pro Gold
insCode یا نماد — اختیاری، برای گرفتن فقط یک نماد به‌جای کل بازار
GET/screener/history

کندل هر نماد در چند نقطه‌ی زمانی مشخص (n روز معاملاتی قبل)، برای همه‌ی نمادها در یک پاسخ — مثلاً برای مقایسه‌ی قیمت ۴ روز پیش با ۹ روز پیش کافی است daysAgo=4,9 بدهید. مخصوص پلن Gold.

Free Basic Pro Gold
لیست offsetهای موردنظر با کاما جدا شده — حداکثر ۳۰ مورد
GET/screener/prompt

فیلتر بازار با یک جمله‌ی آزاد فارسی یا انگلیسی — مثلاً «سهم‌هایی که سهامدار عمده‌شان امروز تغییر کرده و RSI زیر ۵۰ دارند». هوش مصنوعی جمله را به یک فیلتر ساختاریافته تبدیل می‌کند و این سرویس آن را روی داده‌ی واقعی اجرا می‌کند؛ فیلد interpreted نشان می‌دهد درخواستتان چطور تفسیر شده. شرط‌های سنگین‌تر (اندیکاتور، تغییر سهامدار) فقط روی نقدشونده‌ترین نمادها اجرا می‌شوند، نه کل بازار. مخصوص پلن Gold.

Free Basic Pro Gold
توصیف فارسی یا انگلیسی معیارهای موردنظر
GET/api

سازگار با API سورس‌آرنا (sourcearena.ir) — نام پارامترها و فیلدهای خروجی دقیقاً مطابق سورس‌آرناست تا با کمترین تغییر به این آدرس سوئیچ کنید. مثل خود سورس‌آرنا، همه‌ی متدها روی یک آدرس واحد (/api) هستند و «متد» با حضور پارامترهای مختلف در query string تعیین می‌شود؛ این کارت متد «کندل روزانه» را نشان می‌دهد، بقیه‌ی متدها را در کارت‌های بعدی همین بخش ببینید. به‌جای هدر X-API-Key می‌توانید ?token=کلید_شما را هم مستقیماً در URL بدهید.

Free Basic Pro Gold
نام نماد
دوره به‌صورت سال/ماه شمسی
GET/api

همان کندل روزانه، اما بر اساس تعداد روز اخیر به‌جای یک دوره‌ی تقویمی مشخص.

Free Basic Pro Gold
نام نماد
تعداد روز اخیر
GET/api

اطلاعات لحظه‌ای همه‌ی نمادهای بازار در یک پاسخ — type=0 فقط سهام، type=2 همه‌ی نمادهای زنده (صندوق، حق‌تقدم، اختیارمعامله، اوراق). با پارامتر اختیاری time می‌توانید عکس کل بازار سهام (type=0) را در یک روز گذشته هم بگیرید.

Free Basic Pro Gold
بدون مقدار خاص — فقط حضور این فیلد لازم است (۱ صرفاً برای پر شدن باکس)
0 = فقط سهام، 2 = همه‌ی نمادها
تاریخ شمسی YYYY/MM/DD — اختیاری، برای عکس کل بازار در یک روز گذشته (فقط type=0)
GET/api

اطلاعات کامل یک نماد — قیمت، وضعیت واقعی معاملاتی و دفتر سفارش ۵سطحی.

Free Basic Pro Gold
نام نماد یا insCode
GET/api

اندیکاتورهای تکنیکال یک نماد: RSI، MFI، CCI، Williams %R، استوکاستیک، MACD، ایچیموکو، بولینگر، میانگین‌های متحرک و نوسان محقق‌شده.

Free Basic Pro Gold
بدون مقدار خاص — فقط حضور این فیلد لازم است
نام نماد
GET/api

همان اندیکاتورهای متد «اندیکاتور»، یک رکورد به‌ازای هر روز.

Free Basic Pro Gold
نام نماد
تعداد روز اخیر
GET/api

سهامداران عمده‌ی یک نماد — بدون date وضعیت لحظه‌ای، با date وضعیت همان روز از آرشیو واقعی tsetmc.

Free Basic Pro Gold
نام نماد
تاریخ شمسی YYYY/MM/DD — اختیاری، بدون آن وضعیت لحظه‌ای برمی‌گردد
GET/api

سرانه‌ی خرید و فروش حقیقی یک نماد و نسبت آن‌ها، برای هر روز در بازه‌ی درخواستی.

Free Basic Pro Gold
نام نماد
تعداد روز اخیر
GET/api

تک‌تک معاملات یک نماد به‌ترتیب زمان. بدون date، آخرین روز معاملاتی موجود نمایش داده می‌شود.

Free Basic Pro Gold
نام نماد
تاریخ شمسی YYYY/MM/DD — اختیاری
GET/api

اطلاعیه‌های رسمی افشا از سامانه‌ی کدال، برای یک نماد یا (با codal=all) کل بازار.

Free Basic Pro Gold
نام نماد یا all برای همه‌ی شرکت‌ها
شماره صفحه
GET/api

پیام‌های ناظر بازار برای یک نماد مشخص — مثل توقف نماد یا اطلاعیه‌های تسویه.

Free Basic Pro Gold
نام نماد
GET/api

فهرست زنده‌ی قراردادهای اختیارمعامله، همراه با قیمت و اطلاعات سهم پایه‌ی هر قرارداد. برای اندازه‌ی واقعی قرارداد و موقعیت‌های باز، متد «اختیارمعامله (نسخه کامل)» را ببینید.

Free Basic Pro Gold
بدون مقدار دیگری — دقیقاً e
GET/api

نسخه‌ی کامل‌تر متد «اختیارمعامله» — شامل اندازه‌ی واقعی قرارداد، موقعیت‌های باز امروز/دیروز، و قیمت‌گذاری Black-Scholes واقعی (قیمت منصفانه و یونانی‌های delta/theta/gamma/vega/rho) بر پایه‌ی نوسان محقق‌شده‌ی سهم پایه و نرخ بدون ریسک قابل‌تنظیم در پنل مدیریت. این متد پارامتر time را نادیده می‌گیرد و همیشه داده‌ی امروز را می‌دهد.

Free Basic Pro Gold
بدون مقدار خاص — فقط حضور این فیلد لازم است
بدون مقدار خاص — فقط حضور این فیلد لازم است
GET/api

تغییرات سهامداران عمده‌ی یک نماد در آخرین n روز معاملاتی، از آرشیو واقعی tsetmc.

Free Basic Pro Gold
نام نماد
بدون مقدار دیگری — دقیقاً true
حداکثر ۶۰
GET/api

وضعیت لحظه‌ای شاخص کل بورس یا فرابورس.

Free Basic Pro Gold
market_bourse یا market_farabourse
GET/api

تاریخچه‌ی واقعی شاخص کل بورس یا فرابورس، از آرشیو خود tsetmc.

Free Basic Pro Gold
bourse یا farabourse
حداکثر ۳۶۵۰
GET/api

عدد رسمی شاخص هر صنعت از آرشیو tsetmc، با امکان گرفتن مقدار یک روز مشخص از گذشته با پارامتر time.

Free Basic Pro Gold
بدون مقدار دیگری — دقیقاً indices
تاریخ شمسی YYYY/MM/DD — اختیاری، بدون آن آخرین روز برمی‌گردد
GET/api

NAV رسمی صندوق‌های سرمایه‌گذاری، مستقیماً از داده‌ی رسمی TSE. با nav=<نماد> یک صندوق و با nav=all همه‌ی حدود ۵۰۰ صندوق برمی‌گردد؛ خروجی all شامل ترکیب پرتفوی، بازده در بازه‌های مختلف و اطلاعات مدیر/متولی نیز هست.

Free Basic Pro Gold
نام نماد صندوق، یا all برای دریافت همه‌ی صندوق‌ها
GET/api

تشخیص محاسباتی الگوهای رایج کندل‌استیک (دوجی، چکش، ماروبوزو، پوشا، ستاره صبحگاهی/عصرگاهی و…) روی کندل‌های روزانه‌ی یک نماد.

Free Basic Pro Gold
نام نماد
GET/api

سری روزانه‌ی قیمت تعدیل‌شده با افزایش سرمایه و سود تقسیمی. فقط type=1 (تعدیل ترکیبی) پشتیبانی می‌شود.

Free Basic Pro Gold
بدون مقدار خاص — فقط حضور این فیلد لازم است
نام نماد
تاریخ شمسی YYYY/MM/DD — اختیاری
تاریخ شمسی YYYY/MM/DD — اختیاری
فقط ۱ پشتیبانی می‌شود
GET/api

کندل‌های حدود ۲دقیقه‌ای روز معاملاتی جاری برای یک نماد، مستقیماً از فید داخلی tsetmc.

Free Basic Pro Gold
نام نماد
GET/api

نمادهای شناخته‌شده‌ای که امروز در فید زنده‌ی بازار حضور ندارند — توقف تمام‌روز و حذف از فهرست را پوشش می‌دهد، نه توقف میان‌روز.

Free Basic Pro Gold
بدون مقدار خاص — فقط حضور این فیلد لازم است

استریم لحظه‌ای Pro / Gold

یک namespace از Socket.IO که در هر به‌روزرسانی (حدود هر ۱ ثانیه در ساعات معاملاتی) کل دیده‌بان بازار را ارسال می‌کند. نیازمند کلید سطح Pro یا Gold است.

متصل نیست
// برای مشاهده لاگ رویدادها متصل شوید

خطاها

هر پاسخ خطا به‌صورت { "error": "..." } همراه با یکی از این کدهای وضعیت است.

400پارامتر الزامی وارد نشده یا نامعتبر است (مثلاً بدون symbol).
401کلید API وارد نشده، نامعتبر یا باطل‌شده است.
403اشتراک فعالی ندارید، یا پلن شما این قابلیت را پوشش نمی‌دهد.
404نماد در دیده‌بان بازار فعلی پیدا نشد.
429از محدودیت نرخ پلن شما عبور شده — به هدر RateLimit-Reset نگاه کنید.
502منبع داده بورس در سمت بالادست خطا داد یا timeout شد — تلاش دوباره بی‌خطر است.
503داده بازار هنوز آماده نیست (سرور تازه بالا آمده و اولین دریافت داده در انتظار است).