Obter Fundo

GET

/traded-funds/{fundIdentifier}

Retorna informações detalhadas de um fundo listado específico (ex.: FII, ETF, Fiagro), incluindo identificadores, classificação e — opcionalmente — dados de mercado e assets para UI (logo/ícone).

Quando usar

• Página de detalhe do fundo no app/site
• Resolver a identidade do ativo (símbolo, ticker principal e tickers alternativos)
• Enriquecer UI com logo/ícone e detalhes operacionais (site, endereço, administrador etc.)
• Preparar integrações com módulos de proventos, indicadores e carteira do fundo

Identificador do fundo (fundIdentifier)

Você pode consultar um fundo usando um destes valores:

• ticker (recomendado para uso em produto): ex. HGLG11
• symbol (raiz do ativo): ex. HGLG
• um valor existente em other_tickers (quando aplicável): ex. HGLG11T

Padrão 11 e tickers alternativos

Em fundos listados (especialmente FIIs e muitos Fiagros), o ticker costuma terminar em 11.
Em períodos de eventos como subscrições, podem existir tickers temporários (recibos/direitos) listados em other_tickers. Para “o ativo principal”, prefira o ticker padrão.

Parâmetros

Parâmetro	Local	Descrição	Obrigatório
fundIdentifier	URL	Identificador do fundo (ticker/symbol/other ticker).	Obrigatório
show_market_cap	Query	Boolean. Se true, retorna market cap e valor patrimonial quando disponíveis.	Opcional
show_logo	Query	Boolean. Se true, retorna logos e ícones do fundo quando disponíveis.	Opcional
show_details	Query	Boolean. Se true, retorna detalhes (website, endereço, datas e outros campos quando disponíveis).	Opcional

Boas práticas

• Para telas rápidas, comece sem enriquecimentos e habilite show_logo e show_details apenas quando necessário.
• Se você for exibir uma lista, use Listar Fundos e só chame Obter Fundo no clique do usuário.

Resposta

Código	Descrição
200	Retorna os dados do fundo.
400	Identificador inválido/parâmetros inválidos.
401	Não autorizado.
404	Fundo não encontrado.

Formato da resposta

A resposta é um objeto com os campos abaixo:

Campo	Tipo	Descrição
type	string	Tipo geral do ativo retornado.
symbol	string	Símbolo raiz do fundo.
name	string	Nome completo (razão) do fundo.
trading_name	string	Nome de negociação do fundo.
company_id	string	Identificador/CNPJ do fundo (quando aplicável).
fund_type	string	Tipo do fundo (ex.: FII, ETF, FIAGRO).
ticker	string	Ticker principal de negociação.
other_tickers	array	Tickers alternativos/temporários relacionados.
classification	string	Classificação do fundo (quando disponível).
website	string	Website oficial do fundo/administrador.
address	string	Endereço principal retornado pela fonte.
phone_number	string	Telefone de contato.
position_manager	string	Instituição responsável pela escrituração/posição.
manager_name	string	Nome do gestor/responsável (quando disponível).
segment	string	Segmento de listagem/atuação.
registrar.name	string	Nome do escriturador conforme fonte.
registrar.address	string	Endereço do escriturador.
registrar.phone_number	string	Telefone do escriturador.
registrar.email	string	E-mail do escriturador.
past_symbols	array	Símbolos históricos do fundo.
logo / icon	Assets para UI (quando show_logo=true)

Exemplo

{
  "type": "FII",
  "symbol": "HGLG",
  "name": "PÁTRIA LOG - FUNDO DE INVESTIMENTO IMOBILIÁRIO - RESPONSABILIDADE LIMITADA",
  "trading_name": "FII HGLG PAX",
  "company_id": "11728688000147",
  "fund_type": "FII",
  "ticker": "HGLG11",
  "other_tickers": ["HGLG11T"],
  "classification": "Fundo Imobiliário / Multicategoria",
  "website": "https://www.bancogenial.com/",
  "address": "PRAIA DE BOTAFOGO, 228 - SALA 907, RJ, RIO DE JANEIRO, BOTAFOGO - CEP: 22250040",
  "phone_number": "+552139233000",
  "position_manager": "BANCO GENIAL S.A.",
  "manager_name": "RODRIGO DE GODOY",
  "segment": "Bolsa",
  "registrar": {
    "name": "BANCO GENIAL S.A.",
    "address": "PRAIA DO BOTAFOGO, 228 - SALA 907 - CEP: 22250040 - RIO DE JANEIRO - RJ",
    "phone_number": "null",
    "email": "[email protected]"
  },
  "past_symbols": ["HGLG"],
  "logo": {
    "svg": "https://sa-east-1-public-cdn.partnr.ai/logos/HGLG.svg",
    "png_1024": "https://sa-east-1-public-cdn.partnr.ai/logos/HGLG_1024.png",
    "png_512": "https://sa-east-1-public-cdn.partnr.ai/logos/HGLG_512.png",
    "png_256": "https://sa-east-1-public-cdn.partnr.ai/logos/HGLG_256.png",
    "png_128": "https://sa-east-1-public-cdn.partnr.ai/logos/HGLG_128.png",
    "png_64": "https://sa-east-1-public-cdn.partnr.ai/logos/HGLG_64.png"
  },
  "icon": {
    "svg": "https://sa-east-1-public-cdn.partnr.ai/icons/HGLG.svg",
    "png_1024": "https://sa-east-1-public-cdn.partnr.ai/icons/HGLG_1024.png",
    "png_512": "https://sa-east-1-public-cdn.partnr.ai/icons/HGLG_512.png",
    "png_256": "https://sa-east-1-public-cdn.partnr.ai/icons/HGLG_256.png",
    "png_128": "https://sa-east-1-public-cdn.partnr.ai/icons/HGLG_128.png",
    "png_64": "https://sa-east-1-public-cdn.partnr.ai/icons/HGLG_64.png"
  }
}