Назви спільнот та окремі записи
Захищені маршрути використовують GET на https://api.redditapihub.com. Передавайте X-API-Key: <ключ> або Authorization: Bearer <ключ>. Обидві схеми підтримуються й використовують ключ архіву цього домену, а не Reddit OAuth. Зберігайте секрет на сервері. Cookie Secure HttpOnly для сесії панелі облікового запису відокремлена від отримання даних і не замінює заголовка ключа у вашому застосунку.
/v1/subreddits приймає лише prefix і limit. Необов’язковий prefix обмежує назви спільнот, а не текст дописів. Указане значення має містити 1–64 латинські літери ASCII, цифри або підкреслення. limit від 1 до 100 обмежує кількість спільнот. Елемент містить subreddit і count, без гарантії глобально точного підрахунку. Для цього маршруту немає page, author, дат, текстового запиту чи курсора повного каталогу.
/v1/item?id=... потребує ідентифікатора та шукає один архівний запис. Він приймає лише id, а не URL-адресу Reddit чи запит цілого обговорення. Шуканий запис може бути відсутній. Перевіряйте формат ідентифікаторів в отриманих документах, не переносячи автоматично перетворення з іншого клієнта. /v1/status публічний, не потребує ключа й не витрачає кредитів. Статичний опис підтверджує відповідь HTTP-застосунку без перевірки пошукового рушія, доступності архіву та балансу.
Пошук вмісту та дозволені фільтри
/v1/search шукає дописи й коментарі. /v1/posts додатково обмежує тип дописами, /v1/comments — коментарями. Усі три приймають q, subreddit, author, kind, from, to, min_score, limit і page, але не id чи prefix. kind допускає post і comment; для обох типів через search не задавайте його. q — текстовий пошук, а не довільна мова запитів, аналіз тональності або серверна статистика.
from і to потребують YYYY-MM-DD в UTC та фільтрують created_utc, а не час надходження до архіву. Останній день to включений повністю. min_score задає числовий поріг оцінки без сортування та визначення якості. Документи видаються в порядку _doc, не за часом вставлення, хронологією, релевантністю чи оцінкою. Локально можна сортувати й аналізувати отриману вибірку, зберігаючи застереження, що відсутні записи до неї не входять.
Відповідь отримання містить data, pagination і credits. Документи вмісту плоскі, поля можуть різнитися. Наявність parent_id та link_id дозволяє пов’язувати записи локально, але жодне поле не є доступним фільтром запиту. Групування не гарантує всіх батьківських записів, відповідей або повної розмови. Не приховуйте відсутніх полів і нерозв’язаних посилань, замінюючи їх вигаданими початковими значеннями для зручності власної схеми.
Пагінація, помилки та облік кредитів
Пошук вмісту приймає limit і page від 1 до 100, по одній сторінці за запит. Це не пагінація /v1/subreddits. Читайте pagination.total разом із relation: eq — точний підсумок запиту, gte — нижня межа, unknown — відсутність надійного підсумку, можливо null. У каталогу підсумок невідомий; ознака truncated може вказувати на пропущені групи агрегації, але не дає способу перебрати їх сторінками.
Точний підсумок не доводить повного вивантаження чи охоплення архіву. Поділ періодів, обхід сторінок і локальне усунення дублікатів не встановлюють вичерпного збирання або унікальності. Немає гарантій фіксованих дат покриття, незмінного знімка чи постійного зберігання записів. Зберігайте ознаки has_more, window_exhausted і truncated разом із відповіддю та тлумачте їх у контексті маршруту, не перетворюючи на вигаданий курсор.
HTTP 400 означає неправильні параметри, 401 — відсутній або недійсний ключ, 402 — нестачу кредитів, 429 — обмеження частоти. Некоректні запити не списуються; збій джерела повертає резерв. Успішне отримання коштує один кредит навіть за порожнього результату. Тайм-аут або втрата відповіді може статися після оплаченого успіху, новий успішний повтор оплачується окремо. Помилка власного зберігання чи перетворення не повертає кредиту за успішний запит.
