Sahmino API · 1.0.0
مستندات API
نشانی پایه
https://sahmino.com/api/v1سند «OpenAPI»سربرگ احراز هویت
Authorization: Bearer <token>کلیدی که برای سرور MCP ساخته شده کلید API نیست و اینجا پذیرفته نمی‌شود.
سقف‌ها
۲۴۰ درخواست در دقیقه
۱۰۰ ردیف در هر صفحه
بودجهٔ روزانهٔ درخواست‌ها را طرح حساب تعیین می‌کند. هزینهٔ هر نشانی کنار خودش آمده است.
یک درخواست نمونه
curl -H "Authorization: Bearer $SAHMINO_TOKEN" \ "https://sahmino.com/api/v1/instruments"
به‌جای متغیر کلید، کلید API خود را بگذارید. این نمونه نخستین نشانی فعال فهرست را می‌خواند.
شکل پاسخ
- یک رکورد
- پاسخ یک رکورد به شکل
{"data": {...}}است. - یک صفحه از رکوردها
- پاسخ فهرست به شکل
{"data": [...], "meta": {"page", "perPage", "total", "lastPage"}}است. اندازهٔ صفحه ثابت است و فرستنده نمی‌تواندperPageرا تغییر دهد. - درخواست ردشده
- پاسخ خطا به شکل
{"error": {"code", "message", "detail?"}}است. بر اساسcodeتصمیم بگیرید؛ متنmessageممکن است در نسخه‌های بعدی تغییر کند.
نشانی‌های درخواست
۱۷ از ۱۷ نقطهٔ پایانی
/api/v1/instrumentsفهرست نمادها، صفحه‌بندی‌شده.
شناسه، محل پذیرش و آخرین قیمت موجود. نام نماد در هر دو زبان همیشه همراه پاسخ است.
دامنهapi:instruments
/api/v1/instruments/{instrument}یک نماد با مشخصات منتشرشدهٔ بورس.
ردیف فهرست به‌همراه خوانش شبانهٔ مشخصات: سهام شناور، ارزش بازار و صنعت ثبت‌شده.
دامنهapi:instruments
/api/v1/boardیک صفحه از تابلوی امروز.
نام، نماد معاملاتی و fullName که می‌تواند خالی باشد: نام رسمی شرکت در زبان جاری و در نبود ترجمه، متن منبع. قیمت آخر، پایانی، تغییر، حجم، ارزش و سهم حقیقی در هر سمت. پایانی دیروز در نشانی قیمت خود نماد است و در همهٔ ردیف‌های تابلو تکرار نمی‌شود.
دامنهapi:instruments
/api/v1/instruments/{instrument}/pricesتاریخچهٔ روزانه و آمار بازهٔ محاسبه‌شده از آن.
نقاط از قدیمی به تازه مرتب‌اند؛ جلسهٔ توقف هم ردیف دارد و توقف را مشخص می‌کند. unit را حتماً بخوانید؛ هر تومان ۱۰ ریال است.
دامنهapi:prices
/api/v1/instruments/{instrument}/indicatorsاندیکاتورهای تکنیکال ذخیره‌شدهٔ یک نماد.
خوانش ذخیره‌شده بازگردانده می‌شود و دوباره محاسبه نمی‌شود؛ seriesHash جلسه‌های مبنای آن را مشخص می‌کند. اندیکاتور بدون خوانش در پاسخ نمی‌آید و مقدار null نمی‌گیرد.
دامنهapi:indicators
/api/v1/screener/fieldsهمهٔ فیلدهای قابل‌پالایش، با گروه، قالب و عنوان.
فهرستی که برنامه پیش از نوشتن شرط نیاز دارد، از همان مرجع فیلدهای پالایشگر ساخته می‌شود.
دامنهapi:screener
/api/v1/screensپالایش‌های ذخیره‌شدهٔ خود فرستنده.
همه یکجا می‌آیند و صفحه‌بندی نمی‌شوند؛ تعداد ذخیره‌ها سقف حساب دارد. مقایسهٔ meta.kept با meta.limit نشان می‌دهد ذخیرهٔ بعدی مجاز است یا نه.
دامنهapi:screener
/api/v1/screener/runاجرای پالایش ذخیره‌شده یا شرط‌های فرستاده‌شده همراه درخواست.
نمادی که برای فیلدی خوانش ندارد از شرط آن فیلد عبور نمی‌کند؛ مقدار غایب صفر نیست. matched تعداد پذیرفته‌شده‌ها، shown تعداد فرستاده‌شده‌ها و rowCap سقف ردیف‌های طرح در یک درخواست است؛ null یعنی سقفی اعمال نشده.
دامنهapi:screener
/api/v1/filingsاطلاعیه‌های کدال، از تازه به قدیمی.
periodMonths طول دوره‌ای است که اطلاعیه گزارش می‌کند؛ مقایسهٔ دوره‌های نابرابر می‌تواند نتیجهٔ نادرست بسازد.
دامنهapi:filings
/api/v1/instruments/{instrument}/statementsصورت‌های مالی استخراج‌شده از اطلاعیه‌های یک نماد.
تعداد دوره‌های پاسخ از مقدار statement_periods طرح می‌آید و quota آن را کنار ردیف‌ها گزارش می‌کند: total تعداد دوره‌های منتشرشدهٔ شرکت و shown تعداد مجاز طرح است.
دامنهapi:filings
/api/v1/valuationsارزش‌گذاری‌های ذخیره‌شدهٔ خود فرستنده.
gapAtSave فاصله‌ای است که هنگام ذخیره دیده‌اید؛ gapNow اثر حرکت قیمت بازار از آن زمان را نشان می‌دهد.
دامنهapi:valuations
/api/v1/instruments/{instrument}/valuationsارزش‌گذاری‌های ذخیره‌شدهٔ خود فرستنده برای یک نماد.
دامنهapi:valuations
/api/v1/macroهمهٔ سری‌های اقتصاد کلان با وضعیت تازگی‌شان.
freshAt زمان آخرین ورود دادهٔ سری است و stale آن را با تناوب خود سری مقایسه می‌کند؛ سری ماهانه‌ای که این هفته مشاهده ندارد لزوماً عقب‌مانده نیست.
دامنهapi:macro
/api/v1/macro/seriesمشاهده‌های حداکثر ۵ سری.
نقاط از قدیمی به تازه‌اند و روز بدون مشاهده حذف می‌شود، نه اینکه صفر بگیرد. کلید ناشناخته پاسخ ۴۰۴ با کد not_found می‌دهد و سری خالی بازنمی‌گرداند.
دامنهapi:macro
/api/v1/instruments/{instrument}/ownershipفهرست سهامداران، هیئت‌مدیره و اطلاعات محاسبه‌شده از آن‌ها.
کد ملی شخص حقیقی هرگز فرستاده نمی‌شود؛ پیش از ساخت دادهٔ پاسخ حذف شده است.
دامنهapi:ownership
/api/v1/alertsقواعد اعلان خود فرستنده، از تازه به قدیمی.
فقط خواندنی است. قاعده در صفحهٔ اعلان‌ها ساخته می‌شود، جایی که سقف طرح و روش فعال‌سازی دوباره اعمال می‌شوند. فهرست صفحه‌بندی می‌شود چون در طرحی که API دارد، تعداد قواعد می‌تواند زیاد شود.
دامنهapi:alerts
/api/v1/alerts/deliveriesاعلان‌های ارسال‌شده، از تازه به قدیمی.
برای اتصال به برنامهٔ دیگر: اعلان رخ‌داده را می‌خوانید تا آن را به سامانهٔ خود برسانید.
دامنهapi:alerts