مستندات فنی وب‌سرویس اخبار ایران | SheedNews API v1
راهنمای استفاده از API رویدادها و اخبار ایران
این وب‌سرویس تمامی اخبار، تحولات سیاسی، اقتصادی، تحریمی و منطقه‌ای مرتبط با ایران را از بیش از ۵۰ رسانه جهانی و فارسی‌زبان تجمیع، خلاصه‌سازی و رتبه‌بندی می‌کند. برای فراخوانی API به یک کلید معتبر نیاز دارید که می‌توانید در هدر Authorization: Bearer YOUR_KEY یا پارامتر ?apiKey=YOUR_KEY ارسال کنید. (سقف پلن رایگان: ۲۰ درخواست در روز).
کنسول تست تعاملی (Playground)
پارامترها را تنظیم کرده و خروجی زنده JSON را مشاهده کنید.
GET/api/v1/news?min_score=25&limit=5
نمونه کدهای آماده
curl -X GET "https://sheednews.com/api/v1/news?q=ایران&limit=5" \
-H "Authorization: Bearer YOUR_API_KEY"
جدول پارامترهای اندپوینت GET /api/v1/news
| پارامتر | نوع | پیش‌فرض | توضیحات |
|---|---|---|---|
| q | string | - | کلمه یا عبارت برای جستجو در تیتر و خلاصه اخبار. |
| category | string | - | فیلتر موضوعی (مانند politics, economy, general). |
| source | string | - | کد خبرگزاری (مانند cnn, reuters, iranwire). |
| min_score | number | 0 | حداقل امتیاز اهمیت اختصاصی SheedNews Score (۰ تا ۱۰۰). |
| limit | number | 20 | تعداد اخبار خروجی (حداقل ۱ و حداکثر ۵۰). |
| page | number | 1 | شماره صفحه برای صفحه‌بندی نتایج. |
| from_date | string | - | فیلتر شروع تاریخ به فرمت YYYY-MM-DD یا ISO. |
| to_date | string | - | فیلتر پایان تاریخ. |
کدهای وضعیت HTTP
200 OK
درخواست با موفقیت پردازش شد و آرایه اخبار برگردانده شد.
401 Unauthorized
کلید API ارائه نشده یا باطل شده است.
429 Rate Limit Exceeded
سقف ۲۰ درخواست روزانه تمام شده است. در 00:00 UTC ریست می‌شود.