---
title: "Agregados Basica"
description: "Retorna um conjunto básico de informações agregadas sobre o veículo. Esse endpoint consolida dados de diversas fontes para oferecer um panorama geral, utilizando campos simples como a placa para a consulta."
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/bea49bc8-4a08-4d56-af4e-5bcc95de3020
markdown: https://doc.apibrasil.io/apis/creditos/bea49bc8-4a08-4d56-af4e-5bcc95de3020.md
source: apibrasil-documentation
---

# Agregados Basica

> Retorna um conjunto básico de informações agregadas sobre o veículo. Esse endpoint consolida dados de diversas fontes para oferecer um panorama geral, utilizando campos simples como a placa para a consulta.

- **Categoria:** Segurança Veicular
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 0,14 por consulta
- **Limite:** 990.000 por mês
- **Cadastro:** exige CNPJ
- **Versão:** v2
- **Publicada por:** APIBrasil
- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/bea49bc8-4a08-4d56-af4e-5bcc95de3020/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

Autenticação: cabeçalho `Authorization: Bearer <token>`. Nada além disso.

Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção.

## Endpoints (1 endpoint)

### 1. POST /consulta/veiculos/credits

API Veicular — Consulta e Gestão Inteligente de Veículos

A API Veicular oferece uma solução prática e confiável para consultar, validar e analisar informações de veículos, centralizando dados técnicos, cadastrais e de registro em uma única resposta padronizada. 
É ideal para anúncios automotivos, gestão de frota, processos de compra e venda e análise de risco.

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Corpo da requisição**

```json
{
  "tipo": "agregados-basica",
  "placa": "ABC1234",
  "homolog": false
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"agregados-basica","placa":"ABC1234","homolog":false}'
```

Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação.

**Resposta de exemplo, do catálogo**

```json
{
  "user": {
    "first_name": "[omitido]",
    "email": "[omitido]",
    "cellphone": "[omitido]",
    "notification": "yes"
  },
  "balance": "718.29",
  "error": false,
  "message": "Placa válida! Você foi tarifado em R$ xxxx!",
  "homolog": "false",
  "data": {
    "placa": "ABC1C34",
    "chassi": "9BWZZZ32ZGP246344",
    "fabricante": "VW",
    "modelo": "SANTANA CG",
    "ano_fabricacao": 1986,
    "ano_modelo": null,
    "combustivel": "ALCOOL",
    "tipo_veiculo": "NAO IDENTIFICADO",
    "especie": "DESCONHECIDO",
    "cor": "VERMELHA",
    "tipo_carroceria": "NAO IDENTIFICADO",
    "nacionalidade": "NACIONAL",
    "numero_motor": null,
    "potencia": 94,
    "carga": null,
    "numero_carroceria": null,
    "numero_caixa_cambio": null,
    "numero_eixo_traseiro": null,
    "numero_terceiro_eixo": null,
    "quantidade_eixo": "0",
    "cilindradas": null,
    "capacidade_max_tracao": null,
    "peso_bruto_total": null,
    "quantidade_lugares": 0,
    "tipo_montagem": 1,
    "uf_jurisdicao": "PR",
    "uf_faturado": "PR",
    "cidade": "LOBATO"
  }
}
```

Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica.

## Armadilhas: o que uma integração erra sem avisar

Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto:

1. **O erro chega no CORPO, com HTTP 200.**
   A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`.

2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.**
   Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los.

3. **Cada chamada custa dinheiro.**
   Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas.

4. **HTTP 402 é saldo insuficiente, e repetir não resolve.**
   É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos.

5. **`extra_charges` cobra à parte do preço da consulta.**
   Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois.

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/bea49bc8-4a08-4d56-af4e-5bcc95de3020/openapi.json
- Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md)
- SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md)
- Índice da documentação: https://doc.apibrasil.io/llms.txt
- Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/bea49bc8-4a08-4d56-af4e-5bcc95de3020