Pular para o conteúdo principal
Cole no ChatGPT/Claude e peça para resumir/gerar SDK.

Indicadores fundamentalistas de fundos listados

GET
/traded-funds/[fundIdentifier]/ratios

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 VACANCY e LEVERAGE_RATIO em 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âmetroLocalDescriçãoObrigatório
[fundIdentifier]URLIdentificador do fundo: ticker (ex.: HGLG11), symbol (ex.: HGLG) ou company_id numérico.Obrigatório
idsQueryLista de IDs de indicadores separada por vírgula (ex.: VACANCY,LEVERAGE_RATIO). Não diferencia maiúsculas de minúsculas.Opcional
idQueryID de um único indicador (equivalente a ids com um único valor).Opcional
reference_dateQueryFiltra por data de referência (considera o dia inteiro).
Formato: ISO 8601
Opcional
publish_dateQueryFiltra documentos publicados após esta data.
Formato: ISO 8601
Opcional
retrieval_dateQueryFiltra documentos coletados após esta data.
Formato: ISO 8601
Opcional
frequencyQueryFrequência dos dados (ver abaixo).Opcional
latest_by_reference_dateQuerySe true, retorna apenas o último ponto publicado por data de referência, para cada indicador.
true/false
Opcional
limitQueryNúmero de documentos retornados.
Mín: 1, Máx: 500. Padrão: 500
Opcional
offsetQueryNúmero de documentos ignorados (paginação).
Mín: 0. Padrão: 0
Opcional
Sobre o parâmetro 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.

Quais ids existem

Os 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
Boas práticas
  • Combine ids com latest_by_reference_date=true para 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 frequency junto com reference_date no mesmo request.
  • O padrão de limit neste endpoint é 500 (o máximo); para séries muito longas, pagine com offset.

Resposta​

CódigoDescrição
200Retorna os indicadores do fundo.
400Parâmetros ausentes ou inválidos.
401Não autorizado.
404Fundo 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 id do 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
CampoTipoDescrição
valuenumberValor do indicador para o ponto retornado.
reference_datestring (ISO 8601)Data de referência do período do indicador.
publish_datestring (ISO 8601)Data/hora de publicação do documento fonte.
retrieval_datestring (ISO 8601)Data/hora em que o dado foi coletado/processado pela Partnr.
sourcesarrayDocumentos fonte do ponto; veja a estrutura abaixo.

Estrutura de sources[]​

CampoTipoDescrição
visualization_urlstringURL para visualização do documento original na FNET.
download_urlstring | nullURL para download do documento original na FNET. null quando o ponto não tem documento na FNET.
published_atstring (ISO 8601)Data de publicação do documento na fonte.
retrieved_atstring (ISO 8601)Data/hora em que a Partnr coletou o documento.
namestringNome 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"
}
]
}
]
}
}