Documentación Técnica de Subreddit API

Rutas, autenticación y filtros para comparar muestras históricas de comunidades. Totales, límites y tratamiento de errores de Subreddit API.

Obtener clave API

Autenticación y Gestión de Errores

Envía peticiones GET a api.subredditapi.com. Las rutas autenticadas aceptan Authorization: Bearer <clave> o X-API-Key: <clave>. La credencial y el saldo pertenecen a este dominio, sin compartirse entre marcas. /v1/status es público y no requiere clave. Mantén el secreto en el servidor y fuera de los archivos de investigación compartidos.

400 indica parámetros inválidos; 401, una clave ausente o inválida; 402, créditos insuficientes; 429, límite de frecuencia. Revisa la causa antes de repetir. La clave aparece una vez al registrarte y puede regenerarse confirmando la contraseña en el panel de la página de claves. La anterior se invalida inmediatamente; no hay recuperación de contraseña o envío de claves por correo.

Cada recuperación correcta cuesta un crédito, también vacía. Las peticiones inválidas no descuentan saldo y los fallos del proveedor de búsqueda devuelven la reserva. Una interrupción del cliente puede ocurrir después de un éxito cobrado en el servidor. Una repetición correcta consume otro crédito; limita los intentos y registra el motivo sin exponer la credencial.

Rutas de Consulta y Estructura de Respuestas

Las rutas principales incluyen /v1/posts, /v1/comments y /v1/item. Las rutas de publicaciones y comentarios no requieren un identificador; solo /v1/item lo necesita. Las respuestas devuelven registros planos, lo que significa que el cliente puede agrupar los registros localmente si aparecen parent_id o link_id.

La salida sigue el orden documental interno _doc, no el cronológico, de relevancia o de puntuación. Un número de página no congela el archivo ni garantiza el mismo contenido futuro. Si parent_id o link_id aparecen, puedes agrupar los elementos recuperados localmente. Esos campos no son filtros expuestos y no garantizan una conversación o ascendencia completa.

Lee el total con su relación: eq significa exacto, gte un límite inferior y unknown la ausencia de un total fiable, posiblemente nulo. Una cantidad exacta no certifica que hayas descargado todos los registros. Los contadores agregados de /v1/subreddits tampoco están garantizados como globalmente exactos. Guarda estos límites junto con la selección analizada.

Filtros, Límites y Estado del Servicio

/v1/search, /v1/posts y /v1/comments aceptan q, subreddit, author, kind, from, to, min_score, limit y page. kind admite post o comment. Las fechas son YYYY-MM-DD en UTC, con to inclusivo. limit y page van de 1 a 100. Solo /v1/item exige id; /v1/subreddits admite prefix y limit para explorar nombres de comunidades.

El estado de la API se verifica mediante /v1/status, que devuelve una divulgación estática. Esto confirma que el servidor HTTP responde, pero no garantiza la salud del backend de búsqueda ni la disponibilidad completa de los registros. Este endpoint no consume créditos ni carga el saldo de la cuenta.

El servicio permite leer registros archivados, no publicar, votar o enviar mensajes. No proporciona análisis de sentimiento ni comparaciones calculadas en el servidor. Para contrastar vocabulario, aplica tus reglas localmente sobre textos recibidos y explica exclusiones, idiomas y cobertura incierta. Una respuesta vacía no demuestra que una comunidad nunca tratara un tema ni que el término carezca de otros significados.

Dos consultas comparables

Empieza por /v1/search?q=soil&subreddit=gardening&limit=3 y conserva la respuesta original. Para la segunda comunidad, cambia solo subreddit si esa es la variable que deseas contrastar. Mantén iguales q, kind, fechas y cualquier umbral utilizado. Si una respuesta carece del texto necesario, registra la exclusión en vez de tratarla como ausencia de vocabulario.

Separa los resultados de publicaciones y comentarios si tu método los cuenta de forma distinta. Guarda filtros, fecha de ejecución y versión de tus reglas. Los datos conservados permiten revisar el análisis local, pero ni un filtro consistente ni el recorrido de las páginas garantizan muestras equivalentes, aleatorias o representativas. Consulta Precios para presupuestar cada página y Obtener clave API para gestionar el acceso.

Rutas de la API

MétodoRutaParámetros
GET/v1/searchq, subreddit, author, kind, from, to, min_score, limit, page
GET/v1/postsq, subreddit, author, kind, from, to, min_score, limit, page
GET/v1/commentsq, subreddit, author, kind, from, to, min_score, limit, page
GET/v1/itemid
GET/v1/subredditsprefix
GET/v1/status—

Parámetros de consulta

ParámetroValor / tipo / intervalo
qtext
subredditkeyword
authorkeyword
kindpost | comment
fromISO date
toISO date
min_scoreinteger
limit1–100
page1–100
iditem ID
prefixsubreddit prefix