q, subreddit, author, kind, from, to, min_score, limit, page
GET
/v1/posts
q, subreddit, author, kind, from, to, min_score, limit, page
GET
/v1/comments
q, subreddit, author, kind, from, to, min_score, limit, page
GET
/v1/item
id
GET
/v1/subreddits
prefix, limit
GET
/v1/status
—
Parâmetros de consulta
Parâmetro
Valor / tipo / intervalo
q
text
subreddit
keyword
author
keyword
kind
post | comment
from
ISO date
to
ISO date
min_score
integer
limit
1–100
page
1–100
id
item ID
prefix
subreddit prefix
Autenticação e limites das rotas
Use GET em https://api.redditscraping.com com X-API-Key: <chave> ou Authorization: Bearer <chave>; as duas alternativas são válidas. Guarde o segredo no seu servidor. A sessão Secure HttpOnly do painel é separada desses cabeçalhos e não autentica automaticamente seu aplicativo. O serviço consulta registros históricos; não executa uma coleta de páginas atuais nem recebe instruções para contornar restrições de outro site.
/v1/search pesquisa publicações e comentários; /v1/posts restringe a publicações e /v1/comments a comentários. Essas rotas admitem q, subreddit, author, kind, from, to, min_score, limit e page, mas não id. kind aceita os valores literais post e comment. q faz busca textual, sem executar uma linguagem arbitrária de consultas ou produzir classificações de sentimentos.
/v1/item?id=... exige id e busca um registro individual, sem outros filtros ou recuperação recursiva. /v1/subreddits aceita somente prefix e limit para descobrir comunidades, cujas contagens não são um censo global exato garantido. /v1/status é público e gratuito: sua declaração estática confirma apenas que o aplicativo HTTP responde, sem consultar a busca ou verificar disponibilidade de registros.
Datas, ordem e respostas
from e to usam YYYY-MM-DD em UTC e se aplicam a created_utc. O dia to é incluído por inteiro. Os parâmetros não recebem horários ou segundos e não selecionam o momento de inclusão no arquivo. min_score define um limiar numérico de pontuação, sem ordenar os resultados ou identificar automaticamente boas publicações. Valide os valores antes de programar novas páginas.
As respostas da API são registros planos, o que significa que não há árvores de discussão montadas pelo servidor. Se os campos parent_id e link_id estiverem presentes, o cliente pode agrupá-los localmente conforme necessário. Essa estrutura simplificada garante que o desenvolvedor tenha controle total sobre a visualização dos dados, sem promessas de completude na árvore de conversa.
A resposta de recuperação contém data, pagination e credits. Os campos dos documentos em data podem variar. Não presuma que texto, datas e identificadores estejam presentes em todos os registros. Não existem filtros parent_id ou link_id. Guarde o corpo original antes de normalizar e separe um valor ausente de texto vazio ou zero; essa diferença pode importar ao interpretar a saída do seu aplicativo.
Paginação, falhas e créditos
limit e page aceitam valores de 1 a 100. Cada chamada recebe uma página de até 100 registros e uma consulta permite solicitar até 100 páginas. A ordem interna _doc não é cronológica, por relevância ou pontuação. Dividir períodos ou percorrer páginas pode organizar a coleta, mas não garante recuperação exaustiva, registros únicos ou resultados iguais em uma nova consulta remota.
Leia pagination.total com relation: eq significa total exato da consulta, gte um limite inferior e unknown ausência de total confiável, possivelmente null. Desconhecido não é zero. Mesmo um total exato não comprova que todos os resultados foram baixados ou que o arquivo contém toda a história. Preserve os indicadores de paginação e as limitações junto aos seus arquivos locais.
HTTP 400 indica parâmetros inválidos, 401 chave ausente ou inválida, 402 saldo insuficiente e 429 limite de frequência. Uma recuperação bem-sucedida custa um crédito, mesmo vazia. Pedidos inválidos não descontam saldo; falhas do serviço de origem devolvem a reserva. A conexão do cliente pode cair depois de um sucesso cobrado, e outra tentativa bem-sucedida custa outro crédito. Grave o resultado antes de avançar o controle local.
