POSTEstavel/reports/search

Pesquisar relatorios

Pesquisa trechos de relatorios corporativos com filtros de companhia, periodo e tipo documental.

Parametros

Parametros de body

NomeTipoExigenciaDescricao
querystringObrigatorioConsulta semantica para os relatorios.
limitintegerOpcionalQuantidade maxima de resultados, entre 1 e 100.
doc_namestringOpcionalNome do documento a filtrar.
cd_cvmstringOpcionalCodigo CVM da companhia.
sector_rawstringOpcionalSetor textual da companhia.
subsector_rawstringOpcionalSubsetor textual da companhia.
tickerstringOpcionalTicker associado a companhia.
company_namestringOpcionalNome da companhia.
report_typestringOpcionalTipo de relatorio corporativo.
from_datedateOpcionalData inicial do periodo.
to_datedateOpcionalData final do periodo.

Resposta

Sucesso HTTP
200
{"results":[]}

Erros

StatusDescricao
400Parametros ou corpo da requisicao invalidos.
404Recurso solicitado nao encontrado.
204Nenhum dado encontrado para os criterios informados.
401Chave de API ausente ou invalida.
403Uma assinatura paga ativa e necessaria para acessar a API.
429Limite de requisicoes excedido.
500Erro interno inesperado.
503Servico temporariamente indisponivel. Tente novamente mais tarde.

Relacionados

MCP relacionado: Pesquisar relatorios
Exemplos de codigo

curl -X POST "https://api.crivo.ai/reports/search" \
  -H "X-API-Key: crv_live_..." \
  -H "Content-Type: application/json" \
  -d '{"query":"divida liquida PETR4","limit":5}'