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

Listar empresas

GET
/companies

Retorna a lista de empresas disponíveis para consulta na Partnr API, incluindo identificadores (CNPJ e symbol), tickers associados e — opcionalmente — setor, logo/ícone e market cap para uso em UI e filtros.

Quando usar

  • Montar um catálogo de empresas (autocomplete, busca e filtros)
  • Descobrir o symbol e os tickers disponíveis para uma empresa
  • Popular telas com logo/ícone e setor (quando necessário)
  • Alimentar componentes como “Top empresas”, “Empresas por setor” e “Pesquisa por ticker”

Parâmetros de requisição

ParâmetroLocalDescriçãoObrigatório
show_sectorQueryBoolean. Se true, retorna o setor das empresas quando disponível.Opcional
show_logoQueryBoolean. Se true, retorna logos e ícones da empresa quando disponível.Opcional
show_market_capQueryBoolean. Se true, retorna o market cap das empresas quando disponível.Opcional
Boas práticas
  • Em listas grandes, comece sem enriquecimentos e habilite show_logo/show_market_cap apenas para telas que realmente exibem esses campos.
  • Para busca por entrada do usuário, consulte o array tickers para resolver rapidamente de ticker → empresa.

Como interpretar os identificadores

  • symbol: identificador “raiz” da empresa (ex.: PETR, BBAS). Útil para chamadas corporativas e padronização.
  • tickers: lista de tickers negociados associados à empresa (ex.: PETR3, PETR4).
  • previous_tickers: tickers antigos/temporários que podem aparecer em históricos ou eventos.
Recomendação

Usar ticker nas requisições é preferível em 99,9% dos casos de uso.

Resposta

CódigoDescrição
200Retorna a lista de empresas.
400Parâmetros ausentes ou inválidos.
401Não autorizado.

Formato da resposta

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

CampoTipoDescrição
company_idstringCNPJ/identificador da empresa.
namestringRazão social da empresa.
trading_namestringNome de negociação da empresa.
symbolstringSímbolo raiz da empresa.
sectorobjectMacrosetor da empresa, quando show_sector=true.
industry_groupobjectGrupo setorial da empresa, quando show_sector=true.
industryobjectIndústria da empresa, quando show_sector=true.
subindustry / sub_industryobjectSubindústria da empresa, quando show_sector=true.
tickersarray de stringLista de tickers associados à empresa.
logo / iconAssets para UI (quando show_logo=true)
market_capobjectValor de mercado com value e format (quando show_market_cap=true).
enterprise_valueobjectEnterprise value com value e format (quando disponível).
previous_tickersarray de stringTickers antigos/temporários da empresa.

Estrutura de classificação setorial (sector, industry_group, industry, subindustry)

CampoTipoDescrição
idstringID interno da classificação (ex.: FINANCIALS, BANKS, DIVERSIFIED_BANKS).
namestringNome legível da classificação.

Estrutura de market_cap e enterprise_value

CampoTipoDescrição
valuenumberValor numérico retornado.
formatstringFormato/moeda do valor (ex.: BRL).

Exemplo

[
{
"company_id": "00000000000191",
"name": "BCO BRASIL S.A.",
"trading_name": "BRASIL",
"symbol": "BBAS",
"sector": {
"id": "FINANCIALS",
"name": "Financeiro"
},
"industry_group": {
"id": "BANKS",
"name": "Bancos"
},
"industry": {
"id": "BANKS",
"name": "Bancos"
},
"sub_industry": {
"id": "DIVERSIFIED_BANKS",
"name": "Bancos Diversificados"
},
"tickers": [
"BBAS3"
],
"logo": {
"svg": "https://sa-east-1-public-cdn.partnr.ai/logos/BBAS.svg",
"png_1024": "https://sa-east-1-public-cdn.partnr.ai/logos/BBAS_1024.png",
"png_512": "https://sa-east-1-public-cdn.partnr.ai/logos/BBAS_512.png",
"png_256": "https://sa-east-1-public-cdn.partnr.ai/logos/BBAS_256.png",
"png_128": "https://sa-east-1-public-cdn.partnr.ai/logos/BBAS_128.png",
"png_64": "https://sa-east-1-public-cdn.partnr.ai/logos/BBAS_64.png"
},
"icon": {
"svg": "https://sa-east-1-public-cdn.partnr.ai/icons/BBAS.svg",
"png_1024": "https://sa-east-1-public-cdn.partnr.ai/icons/BBAS_1024.png",
"png_512": "https://sa-east-1-public-cdn.partnr.ai/icons/BBAS_512.png",
"png_256": "https://sa-east-1-public-cdn.partnr.ai/icons/BBAS_256.png",
"png_128": "https://sa-east-1-public-cdn.partnr.ai/icons/BBAS_128.png",
"png_64": "https://sa-east-1-public-cdn.partnr.ai/icons/BBAS_64.png"
},
"market_cap": {
"value": 142239300872.8,
"format": "BRL"
},
"previous_tickers": [
"BBAS12",
"BBAS11"
]
},
{
"company_id": "33000167000101",
"name": "PETROLEO BRASILEIRO S.A. PETROBRAS",
"trading_name": "PETROBRAS",
"symbol": "PETR",
"sector": {
"id": "ENERGY",
"name": "Energia"
},
"industry_group": {
"id": "ENERGY",
"name": "Energia"
},
"industry": {
"id": "OIL_GAS_CONSUMABLE_FUELS",
"name": "Petróleo, Gás e Combustíveis Consumíveis"
},
"subindustry": {
"id": "OIL_GAS_EXPLORATION_PRODUCTION",
"name": "Exploração e Produção de Petróleo e Gás"
},
"tickers": [
"PETR4",
"PETR3"
],
"logo": {
"svg": "https://sa-east-1-public-cdn.partnr.ai/logos/PETR.svg",
"png_1024": "https://sa-east-1-public-cdn.partnr.ai/logos/PETR_1024.png",
"png_512": "https://sa-east-1-public-cdn.partnr.ai/logos/PETR_512.png",
"png_256": "https://sa-east-1-public-cdn.partnr.ai/logos/PETR_256.png",
"png_128": "https://sa-east-1-public-cdn.partnr.ai/logos/PETR_128.png",
"png_64": "https://sa-east-1-public-cdn.partnr.ai/logos/PETR_64.png"
},
"icon": {
"svg": "https://sa-east-1-public-cdn.partnr.ai/icons/PETR.svg",
"png_1024": "https://sa-east-1-public-cdn.partnr.ai/icons/PETR_1024.png",
"png_512": "https://sa-east-1-public-cdn.partnr.ai/icons/PETR_512.png",
"png_256": "https://sa-east-1-public-cdn.partnr.ai/icons/PETR_256.png",
"png_128": "https://sa-east-1-public-cdn.partnr.ai/icons/PETR_128.png",
"png_64": "https://sa-east-1-public-cdn.partnr.ai/icons/PETR_64.png"
},
"market_cap": {
"value": 498422328074.4,
"format": "BRL"
},
"enterprise_value": {
"value": 826830328074.4,
"format": "BRL"
},
"previous_tickers": []
}
]