Indicadores fundamentalistas de fundos listados
Retorna os indicadores financeiros (ratios) de um fundo listado específico (FII, ETF, Fiagro, FI-Infra etc.), agrupados por ID do indicador e por frequência (ex.: MONTHLY).
Veja também o endpoint relacionado Indicadores de preço.
Quando usar
- Exibir indicadores como
VACANCYeLEVERAGE_RATIOem telas de detalhe do fundo - Montar séries históricas de indicadores para gráficos e dashboards
- Comparar fundos em análises e rankings com base em indicadores padronizados
- Automatizar monitoramento de indicadores usando
latest_by_reference_date=true
Parâmetros de requisição
| Parâmetro | Local | Descrição | Obrigatório |
|---|---|---|---|
[fundIdentifier] | URL | Identificador do fundo: ticker (ex.: HGLG11), symbol (ex.: HGLG) ou company_id numérico. | Obrigatório |
ids | Query | Lista de IDs de indicadores separada por vírgula (ex.: VACANCY,LEVERAGE_RATIO). Não diferencia maiúsculas de minúsculas. | Opcional |
id | Query | ID de um único indicador (equivalente a ids com um único valor). | Opcional |
reference_date | Query | Filtra por data de referência (considera o dia inteiro). Formato: ISO 8601 | Opcional |
publish_date | Query | Filtra documentos publicados após esta data. Formato: ISO 8601 | Opcional |
retrieval_date | Query | Filtra documentos coletados após esta data. Formato: ISO 8601 | Opcional |
frequency | Query | Frequência dos dados (ver abaixo). | Opcional |
latest_by_reference_date | Query | Se true, retorna apenas o último ponto publicado por data de referência, para cada indicador.true/false | Opcional |
limit | Query | Número de documentos retornados. Mín: 1, Máx: 500. Padrão: 500 | Opcional |
offset | Query | Número de documentos ignorados (paginação). Mín: 0. Padrão: 0 | Opcional |
ids (recomendado)Se ids não for informado, o endpoint pode retornar todos os indicadores disponíveis para o fundo na(s) frequência(s) solicitada(s).
Isso pode gerar um payload muito grande, impactando tempo de resposta, transferência e renderização (principalmente em apps e dashboards).
Para uso em produção, prefira sempre informar ids com os indicadores necessários.
ids existemOs indicadores dependem do tipo do fundo e dos informes que ele publica. Chame a rota sem ids para ver os do fundo. Quando os ids pedidos não encontram nenhum ponto, a rota devolve 404 (No ratios found.), como nas rotas de empresas. Quando só parte deles existe, a resposta traz os que existem. O P/VP e o dividend yield estão em Indicadores de preço (PRICE_TO_NAV, DIVIDEND_YIELD).
Frequência
- DAILY: frequência diária
- MONTHLY: frequência mensal
- QUARTERLY: frequência trimestral
- ANNUAL: frequência anual
- TRIAL_BALANCE: balancete
- CDA: composição e diversificação de aplicações
- Combine
idscomlatest_by_reference_date=truepara obter apenas o ponto mais recente de cada data de referência, sem duplicidades causadas por republicações. - Para um snapshot de um período específico, use
frequencyjunto comreference_dateno mesmo request. - O padrão de
limitneste endpoint é500(o máximo); para séries muito longas, pagine comoffset.
Resposta
| Código | Descrição |
|---|---|
| 200 | Retorna os indicadores do fundo. |
| 400 | Parâmetros ausentes ou inválidos. |
| 401 | Não autorizado. |
| 404 | Fundo não encontrado ou nenhum indicador encontrado para os filtros e ids pedidos. |
Formato da resposta
A resposta é um objeto onde:
- cada chave de primeiro nível é o
iddo indicador (ex.:VACANCY,LEVERAGE_RATIO) - cada chave interna é a frequência (ex.:
MONTHLY,ANNUAL) - o valor de cada frequência é uma lista de pontos com os campos abaixo
| Campo | Tipo | Descrição |
|---|---|---|
value | number | Valor do indicador para o ponto retornado. |
reference_date | string (ISO 8601) | Data de referência do período do indicador. |
publish_date | string (ISO 8601) | Data/hora de publicação do documento fonte. |
retrieval_date | string (ISO 8601) | Data/hora em que o dado foi coletado/processado pela Partnr. |
sources | array | Documentos fonte do ponto; veja a estrutura abaixo. |
Estrutura de sources[]
| Campo | Tipo | Descrição |
|---|---|---|
visualization_url | string | URL para visualização do documento original na FNET. |
download_url | string | null | URL para download do documento original na FNET. null quando o ponto não tem documento na FNET. |
published_at | string (ISO 8601) | Data de publicação do documento na fonte. |
retrieved_at | string (ISO 8601) | Data/hora em que a Partnr coletou o documento. |
name | string | Nome do documento (ex.: Informe Mensal Estruturado). |
Exemplo
{
"VACANCY": {
"QUARTERLY": [
{
"value": 0.0245,
"reference_date": "2024-06-30T00:00:00.000Z",
"publish_date": "2024-07-15T00:00:00.000Z",
"retrieval_date": "2024-07-16T10:00:00.000Z",
"sources": [
{
"visualization_url": "https://fnet.bmfbovespa.com.br/fnet/publico/exibirDocumento?id=765432",
"download_url": "https://fnet.bmfbovespa.com.br/fnet/publico/downloadDocumento?id=765432",
"published_at": "2024-07-15T00:00:00.000Z",
"retrieved_at": "2024-07-16T10:00:00.000Z",
"name": "Informe Trimestral Estruturado"
}
]
}
]
},
"LEVERAGE_RATIO": {
"MONTHLY": [
{
"value": 0.2088,
"reference_date": "2024-06-30T00:00:00.000Z",
"publish_date": "2024-07-15T00:00:00.000Z",
"retrieval_date": "2024-07-16T10:00:00.000Z",
"sources": [
{
"visualization_url": "https://fnet.bmfbovespa.com.br/fnet/publico/exibirDocumento?id=765432",
"download_url": "https://fnet.bmfbovespa.com.br/fnet/publico/downloadDocumento?id=765432",
"published_at": "2024-07-15T00:00:00.000Z",
"retrieved_at": "2024-07-16T10:00:00.000Z",
"name": "Informe Mensal Estruturado"
}
]
}
]
}
}