Cole no ChatGPT/Claude e peça para resumir/gerar SDK.
Listar Fundos
GET
/traded-funds
Retorna a lista de fundos listados disponíveis na Partnr API (ex.: FIIs, ETFs, Fiagros, FI-Infra, FIDCs e outros), com suporte a filtros e campos opcionais para enriquecer UI e análises.
Este endpoint é o ponto de entrada para:
- montar um catálogo de fundos
- oferecer busca por ticker
- descobrir tickers alternativos (ex.: recibos em subscrições)
- carregar logos/ícones e metadados quando necessário
Quando usar
- Montar um catálogo de fundos no app/site (com busca e filtros)
- Alimentar um screener de fundos por tipo/segmento
- Popular componentes de UI (ex.: logo, setor/segmento, market cap) quando necessário
- Resolver identificadores:
symbol(base),ticker(negociação principal) eother_tickers(variações)
Parâmetros
| Parâmetro | Local | Descrição | Obrigatório |
|---|---|---|---|
show_sector | Query | Boolean. Se true, retorna informações de setor/segmento quando disponíveis. | Opcional |
show_logo | Query | Boolean. Se true, retorna logos e ícones do fundo quando disponíveis. | Opcional |
show_market_cap | Query | Boolean. Se true, retorna market cap e valor patrimonial quando disponíveis. | Opcional |
type | Query | Filtra por tipo de fundo (ver lista abaixo). | Opcional |
Boas práticas
- Para listas grandes, comece sem enriquecimentos (
show_sector=false,show_logo=false,show_market_cap=false) e carregue campos adicionais somente quando precisar (ex.: ao abrir o detalhe). - Use
typepara reduzir payload (ex.: somenteFII). - Para busca por ticker digitado pelo usuário, normalize e compare contra
tickereother_tickers.
Identificadores e tickers (como interpretar)
symbol: identificador base do ativo (normalmente o “raiz” do ticker), útil para padronização e para assets como logo/ícone.ticker: ticker principal de negociação (ex.:HGLG11,BOVA11).other_tickers: tickers alternativos/temporários relacionados ao fundo (por exemplo, variações em eventos de subscrição, recibos e instrumentos negociáveis durante janelas específicas).
Padrão
11 e variaçõesEm fundos listados (especialmente FIIs e muitos Fiagros), o ticker de negociação costuma terminar em 11.
Em períodos de eventos corporativos (ex.: subscrição), podem existir tickers temporários (ex.: sufixos adicionais) que aparecem em other_tickers.
Tipos de Fundos Listados
Os valores abaixo podem ser usados no filtro type:
FIAGRO-FIDC— Fiagro de Direitos CreditóriosFI-INFRA— Fundo de Investimentos em InfraestruturaFIP— Fundo de Investimentos em ParticipaçõesETF-CRIPTO— ETF de CriptomoedasFII— Fundo de Investimentos ImobiliáriosETF-FII— ETF de Fundos de Investimentos ImobiliáriosETF— Exchange Traded Fund (Fundo Negociado em Bolsa)SETORIAL— Fundos SetoriaisFIAGRO-FII— Fundo de Investimento Imobiliário no AgronegócioFIDC— Fundo de Investimentos em Direitos CreditóriosETF-RF— ETF de Renda FixaETF-INT-RF— ETF Internacional de Renda FixaFIAGRO— Fundo de Investimentos no Agronegócio
Resposta
| Campo | Descrição |
|---|---|
data | Lista de fundos listados |
pagination.limit | Quantidade de itens retornados |
pagination.offset | Quantidade de itens ignorados (paginação) |
pagination.total | Total de itens disponíveis |
Campos mais usados no data[]
| Campo | Descrição |
|---|---|
symbol | Identificador base do ativo (raiz) |
ticker | Ticker principal de negociação |
other_tickers | Tickers alternativos/temporários relacionados |
fund_type | Tipo do fundo (ex.: FII, ETF) |
name | Nome completo (razão) |
trading_name | Nome de negociação |
company_id | Identificador (quando aplicável) |
logo / icon | Assets para UI (quando show_logo=true) |
Exemplo de Resposta
{
"data": [
{
"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"],
"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"
}
},
{
"symbol": "HGPO",
"name": "PATRIA PRIME OFFICES - FUNDO DE INVESTIMENTO IMOBILIÁRIO - RESPONSABILIDADE LIMITADA",
"trading_name": "FII HGPO PAX",
"company_id": "11260134000168",
"fund_type": "FII",
"ticker": "HGPO11",
"other_tickers": [],
"logo": {
"svg": "https://sa-east-1-public-cdn.partnr.ai/logos/HGPO.svg",
"png_1024": "https://sa-east-1-public-cdn.partnr.ai/logos/HGPO_1024.png",
"png_512": "https://sa-east-1-public-cdn.partnr.ai/logos/HGPO_512.png",
"png_256": "https://sa-east-1-public-cdn.partnr.ai/logos/HGPO_256.png",
"png_128": "https://sa-east-1-public-cdn.partnr.ai/logos/HGPO_128.png",
"png_64": "https://sa-east-1-public-cdn.partnr.ai/logos/HGPO_64.png"
},
"icon": {
"svg": "https://sa-east-1-public-cdn.partnr.ai/icons/HGPO.svg",
"png_1024": "https://sa-east-1-public-cdn.partnr.ai/icons/HGPO_1024.png",
"png_512": "https://sa-east-1-public-cdn.partnr.ai/icons/HGPO_512.png",
"png_256": "https://sa-east-1-public-cdn.partnr.ai/icons/HGPO_256.png",
"png_128": "https://sa-east-1-public-cdn.partnr.ai/icons/HGPO_128.png",
"png_64": "https://sa-east-1-public-cdn.partnr.ai/icons/HGPO_64.png"
}
}
]
}