Cole no ChatGPT/Claude e peça para resumir/gerar SDK.
Consultar empresa
GET
/companies/[companyIdentifier]
Retorna os detalhes da empresa associada ao [companyIdentifier].
Parâmetros de requisição
| Parâmetro | Local | Descrição | Obrigatório |
|---|---|---|---|
[companyIdentifier] | URL | Identificador da empresa a ser consultada. | Obrigatório |
show_market_cap | Query | Boolean. Se true, retorna o market cap da empresa. | Opcional |
show_logo | Query | Boolean. Se true, retorna logos e ícones da empresa. | Opcional |
show_company_details | Query | Boolean. Se true, retorna detalhes (endereço, website, data de fundação, etc.). | Opcional |
Identificador da empresa
O [companyIdentifier] pode ser:
symbol: símbolo raiz da empresa. Ex.:PETRcompany_id: identificador (CNPJ). Ex.:33000167000101ticker: ticker de negociação. Ex.:PETR3
Diferença entre symbol e ticker (importante)
-
Quando você usa
symbol(ex.:PETR), este endpoint retorna os dados da empresa no nível “corporativo”, independentemente de qual classe de ação está sendo negociada (ex.: ON/PN). Em outras palavras,symbolrepresenta a empresa, e não apenas um papel específico. -
Quando você usa
ticker(ex.:PETR3), você está apontando para um papel específico associado à empresa. Dependendo do endpoint chamado, isso pode afetar o recorte dos dados retornados:- Em endpoints corporativos (como
companies/[companyIdentifier]), o resultado continua representando a empresa, mas a resolução do identificador é feita a partir daquele ticker. - Em endpoints específicos de papel/negociação (ex.: cotações, variações, etc.), usar
tickersignifica que o retorno será daquele ativo específico.
- Em endpoints corporativos (como
Recomendação
Usar ticker nas requisições é preferível em 99,9% dos casos de uso.
Resposta
| Código | Descrição |
|---|---|
| 200 | Retorna os detalhes da empresa. |
| 404 | Empresa não encontrada. |
| 400 | Parâmetros ausentes ou inválidos. |
| 401 | Não autorizado. |
Formato da resposta
A resposta é um objeto com os campos abaixo:
| Campo | Tipo | Descrição |
|---|---|---|
company_id | string | CNPJ/identificador da empresa. |
name | string | Razão social da empresa. |
trading_name | string | Nome de negociação da empresa. |
symbol | string | Símbolo raiz da empresa. |
common_shares | integer | Quantidade de ações ordinárias (ON). |
preferred_shares | integer | Quantidade de ações preferenciais (PN), quando aplicável. |
total_shares | integer | Soma de common_shares + preferred_shares. |
description | string | Descrição resumida da empresa. |
ceo_name | string | Nome do CEO. |
employee_count | integer | Número de funcionários. |
free_float | object | Objeto com value e format do free float. |
sector | object | Setor, quando show_sector=true. |
industry_group | object | Grupo de indústria, quando show_sector=true. |
industry | object | Indústria, quando show_sector=true. |
subindustry | object | Subindústria, quando show_sector=true. |
characteristics | array | Lista de características/riscos/oportunidades da empresa. |
market_cap | object | Objeto com value e format do valor de mercado. |
enterprise_value | object | Objeto com value e format do enterprise value. |
logo | object | URLs de logo em múltiplos formatos/resoluções. |
icon | object | URLs de ícone em múltiplos formatos/resoluções. |
website | string | Website oficial da empresa. |
address | object | Endereço da empresa (line1, line2, city, state, postal_code, country). |
founding_date | string (YYYY-MM-DD) | Data de fundação da empresa. |
logo / icon | Assets para UI (quando show_logo=true) |
Estrutura de classificação setorial (sector, industry_group, industry, subindustry)
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID interno da classificação (ex.: FINANCIALS, BANKS, DIVERSIFIED_BANKS). |
name | string | Nome legível da classificação. |
Exemplo
{
"company_id": "33000167000101",
"name": "PETROLEO BRASILEIRO S.A. PETROBRAS",
"trading_name": "PETROBRAS",
"symbol": "PETR",
"common_shares": 7442231382,
"preferred_shares": 5446501379,
"total_shares": 12888732761,
"description": "A Petrobras atua na cadeia de petróleo e gás natural, gerando receita principalmente com a produção e a venda de petróleo e gás, o refino de petróleo e a venda de derivados, além de operações de transporte e de trading...",
"ceo_name": "Magda Maria de Regina Chambriard",
"employee_count": 41778,
"free_float": {
"value": 0.61212,
"format": "PERCENTAGE"
},
"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"
},
"characteristics": [
{
"id": "OIL_DOWN",
"name": "Queda do preço do petróleo",
"type": "RISK",
"description": "A queda na cotação do preço do petróleo no mercado de commodities é negativa para essa empresa"
}
],
"market_cap": {
"value": 498422328074.4,
"format": "BRL"
},
"enterprise_value": {
"value": 826830328074.4,
"format": "BRL"
},
"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"
},
"website": "https://www.investidorpetrobras.com.br",
"address": {
"line1": "Av. República do Chile, Nº 65",
"line2": "24º Andar",
"city": "Rio de Janeiro",
"state": "RJ",
"postal_code": "20031912",
"country": "BR"
},
"founding_date": "1953-10-03"
}