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

Composição do portfólio

GET
/traded-funds/[fundIdentifier]/portfolio

Retorna a composição da carteira (posições consolidadas) de um fundo listado específico (FII, FIAGRO, FIDC, ETFs e ETFs de renda fixa), extraída dos documentos oficiais do fundo. Os dados são ideais para análise de alocação e concentração de ativos, com fonte rastreável em cada registro.

Quando usar

  • Exibir a composição da carteira na tela de detalhe do fundo (ex.: HGLG11)
  • Montar dashboards de alocação por tipo de ativo (imóveis, CRIs, cotas de fundos, ativos de liquidez)
  • Analisar a concentração e a evolução das posições ao longo do tempo (reference_date)
  • Automatizar a sincronização incremental de carteiras usando publish_date e/ou retrieval_date

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
fund_typeQueryFiltra pelo tipo de fundo (ver valores aceitos abaixo).Opcional
report_typeQueryFiltra pelo tipo de relatório de origem (ver valores aceitos abaixo).Opcional
reference_dateQueryISO 8601. Filtra pela data de referência (considera o dia inteiro informado).Opcional
publish_dateQueryISO 8601. Retorna apenas documentos com publish_date posterior ao valor informado.Opcional
retrieval_dateQueryISO 8601. Retorna apenas documentos com retrieval_date posterior ao valor informado.Opcional
latest_by_reference_dateQuerySe true, retorna apenas o documento publicado mais recentemente por reference_date.Opcional
limitQueryQuantidade de resultados retornados. Mín.: 1, máx.: 500. Padrão: 50.Opcional
offsetQueryQuantidade de resultados a pular. Mín.: 0. Padrão: 0.Opcional
Boas práticas
  • Para acompanhar a carteira mais recente sem duplicidade por data, combine latest_by_reference_date=true com report_type=MONTHLY_REPORT.
  • Para sincronização incremental, use publish_date e/ou retrieval_date como "cursor" (maior que a data informada) junto com limit e offset.
  • Os campos de cada item de holdings variam conforme o tipo de fundo e de ativo; trate o array de forma flexível na sua integração.

Valores aceitos

Tipos de fundo (fund_type)

  • FII: fundo de investimento imobiliário
  • FIAGRO: fundo de investimento nas cadeias produtivas agroindustriais
  • FIDC: fundo de investimento em direitos creditórios
  • ETFs: fundo de índice (renda variável)
  • ETFs_RF: fundo de índice de renda fixa

Tipos de relatório (report_type)

  • DAILY_REPORT: informe diário
  • MONTHLY_REPORT: informe mensal
  • QUARTERLY_REPORT: informe trimestral
  • ANNUAL_REPORT: informe anual
  • TRIAL_BALANCE: balancete
  • CDA: composição e diversificação das aplicações

Resposta

CódigoDescrição
200Retorna a composição da carteira do fundo.
400Parâmetros ausentes ou inválidos.
401Não autorizado.
404Fundo não encontrado.

Formato da resposta

A resposta é uma lista de objetos com os campos abaixo:

CampoTipoDescrição
fund_typestringTipo do fundo (FII, FIAGRO, FIDC, ETFs, ETFs_RF).
report_typestringTipo do relatório de origem (ex.: MONTHLY_REPORT).
reference_datestring (ISO 8601)Data de referência da carteira.
publish_datestring (ISO 8601)Data de publicação do documento na fonte.
retrieval_datestring (ISO 8601)Data/hora de coleta do documento pela Partnr.
holdingsarrayPosições consolidadas da carteira — ver explicação abaixo.
lease_contractsarrayContratos de locação, presentes quando aplicável (ex.: FIIs de tijolo com contratos de aluguel).
sourcesarrayLista de fontes oficiais usadas para compor o registro.

Sobre os itens de holdings

A API consolida as diferentes categorias de posição do documento de origem (como imóveis, direitos, ativos financeiros e ativos de liquidez) em um único array unificado. Os campos de cada item variam conforme o tipo de fundo e o tipo de ativo (imóvel, CRI, cota de fundo, ativo de liquidez etc.).

Estrutura de sources[]

CampoTipoDescrição
visualization_urlstringURL para visualização do documento original na FNET.
download_urlstring | nullURL para download do documento original (quando disponível).
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 de origem (ex.: Monthly Report).

Exemplo

[
{
"fund_type": "FII",
"report_type": "MONTHLY_REPORT",
"reference_date": "2024-06-30T00:00:00.000Z",
"publish_date": "2024-07-15T00:00:00.000Z",
"retrieval_date": "2024-07-16T10:00:00.000Z",
"holdings": [
{
"asset_name": "Galpão logístico - Guarulhos (SP)",
"value": 185000000,
"...": "..."
},
{
"asset_name": "LFT - Tesouro Selic",
"value": 12500000,
"...": "..."
}
],
"lease_contracts": [
{
"...": "..."
}
],
"sources": [
{
"visualization_url": "https://fnet.bmfbovespa.com.br/fnet/publico/exibirDocumento?id=771234&cvm=true",
"download_url": null,
"published_at": "2024-07-15T00:00:00.000Z",
"retrieved_at": "2024-07-16T10:00:00.000Z",
"name": "Monthly Report"
}
]
}
]