--- title: "Veicular Agrupados" description: "API Veicular Agrupados - Consulta Completa e Instantânea de Veículos" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/6c0b46c0-c2ad-4624-9f1a-81ac6c2cf369 markdown: https://doc.apibrasil.io/apis/creditos/6c0b46c0-c2ad-4624-9f1a-81ac6c2cf369.md source: apibrasil-documentation --- # Veicular Agrupados > API Veicular Agrupados - Consulta Completa e Instantânea de Veículos - **Categoria:** Relatórios Whitelabel - **Cobrança:** por consulta, só com o Bearer Token - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v1 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/6c0b46c0-c2ad-4624-9f1a-81ac6c2cf369/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. 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 Agrupados - Consulta Veicular Completa em um Único Endpoint Otimize o processo de consulta de informações veiculares com a API Veicular Agrupados. Através do endpoint /default, você realiza uma solicitação POST e recebe dados detalhados e atualizados sobre veículos de forma centralizada, acelerando a integração com seu sistema e reduzindo custos operacionais. Com uma resposta estruturada e fácil de interpretar, sua empresa ganha agilidade na tomada de decisão, aprimora a experiência do usuário e pode criar soluções inovadoras para gestão de frota, validação de dados e prevenção à fraude. Descomplique a integração de dados veiculares e potencialize seu negócio com uma API pronta para entregar resultados. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits` - **Versão da rota:** v1 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "veicular-agrupados", "placa": "ABC1234", "agrupados": { "agregados-propria": true, "fipe": true, "proprietario-atual": true }, "homolog": true } ``` **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":"veicular-agrupados","placa":"ABC1234","agrupados":{"agregados-propria":true,"fipe":true,"proprietario-atual":true},"homolog":true}' ``` 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": "669,960", "error": false, "message": "Consulta agrupada em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "tax": "0,000", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "veicular-agrupados": { "agregados-propria": { "error": false, "data": { "status": true, "consulta": { "debitado": false }, "msg": "Consulta homologacao - dados fictícios.", "dados": { "placa": "ABC1234", "placaMercosul": "ABC1B34", "chassi": "9BWZZZ377VT004251", "fabricante": "VW", "marca": "VW", "marcaDetalhes": { "nome": "VW", "fipeId": "001267-0" }, "modelo": "GOL 1.0", "modeloDetalhes": { "nome": "GOL 1.0", "sintetico": "GOL" }, "versao": "1.0 FLEX 12V 4P", "ano_fabricacao": 2020, "ano_modelo": 2021, "motor_descricao": "1.0 12V FLEX", "transmissao_descricao": "MANUAL 5 MARCHAS", "combustivel": "ALCOOL/GASOLINA", "tipo_veiculo": "AUTOMOVEL", "especie": "PASSAGEIRO", "cor": "PRATA", "numero_carroceria": "000000", "tipo_carroceria": "INEXISTENTE", "nacionalidade": "NACIONAL", "numero_motor": "DLA012345", "potencia": 84, "carga": 0, "numero_caixa_cambio": "02T301103N", "numero_eixo_traseiro": "00000000000", "numero_terceiro_eixo": "00000000000", "quantidade_eixo": 2, "quantidade_portas": 4, "cilindradas": 999, "capacidade_max_tracao": 1870, "peso_bruto_total": 1370, "quantidade_lugares": 5, "tipo_montagem": 1, "uf_jurisdicao": "SP", "cidade": "SAO PAULO", "pais_fabricacao": "BRASIL", "documento_faturado": "00000000000000", "tipo_faturado": "JURIDICA", "uf_faturado": "SP" } } }, "fipe": { "error": false, "data": { "data": [ { "anoFabricacao": 2003, "anoModelo": "2004", "categoria": "carro", "codigoFipe": "001177-0", "combustivel": "gasolina", "extra": { "categoria": { "descricao": "carros", "sintetico": "carro" }, "combustivel": { "descricao": "gasolina", "sintetico": "g" } }, "historico": [ { "mes": "2026-01", "valor": 15693 }, { "mes": "2025-12", "valor": 15923 }, { "mes": "2025-11", "valor": 15613 }, { "mes": "2025-10", "valor": 15963 }, { "mes": "2025-09", "valor": 16044 }, { "mes": "2025-08", "valor": 15503 }, { "mes": "2025-07", "valor": 16066 }, { "mes": "2025-06", "valor": 15685 }, { "mes": "2025-05", "valor": 15592 }, { "mes": "2025-04", "valor": 15514 }, { "mes": "2025-03", "valor": 15221 }, { "mes": "2025-02", "valor": 14815 }, { "mes": "2025-01", "valor": 14883 }, { "mes": "2024-12", "valor": 15053 }, { "mes": "2024-11", "valor": 14861 } ], "ipva": { "aliquota": 4, "uf": "SP", "valor": 627.72, "valor_formatado": "R$ 627,72" }, "marca": "Fiat", "mesReferencia": "janeiro de 2026", "modelo": "Palio 1.0/ Trofeo 1.0 Fire/ Fire Flex 4p", "principal": true, "url": "http://veiculos.fipe.org.br/?carro/fiat/00-2026/001177-0/2004/g", "valor": 15693 }, { "anoFabricacao": 2003, "anoModelo": "2004", "categoria": "carro", "codigoFipe": "001176-2", "combustivel": "gasolina", "extra": { "categoria": { "descricao": "carros", "sintetico": "carro" }, "combustivel": { "descricao": "gasolina", "sintetico": "g" } }, "historico": [ { "mes": "2026-01", "valor": 14669 }, { "mes": "2025-12", "valor": 15202 }, { "mes": "2025-11", "valor": 14956 }, { "mes": "2025-10", "valor": 15010 }, { "mes": "2025-09", "valor": 15445 }, { "mes": "2025-08", "valor": 15396 }, { "mes": "2025-07", "valor": 15134 }, { "mes": "2025-06", "valor": 14623 }, { "mes": "2025-05", "valor": 14280 }, { "mes": "2025-04", "valor": 13875 }, { "mes": "2025-03", "valor": 13406 }, { "mes": "2025-02", "valor": 13280 }, { "mes": "2025-01", "valor": 13574 }, { "mes": "2024-12", "valor": 13115 }, { "mes": "2024-11", "valor": 12890 } ], "ipva": { "aliquota": 4, "uf": "SP", "valor": 586.76, "valor_formatado": "R$ 586,76" }, "marca": "Fiat", "mesReferencia": "janeiro de 2026", "modelo": "Palio 1.0/ Trofeo 1.0 Fire/ Fire Flex 2p", "principal": false, "url": "http://veiculos.fipe.org.br/?carro/fiat/00-2026/001176-2/2004/g", "valor": 14669 } ], "veiculo": { "chassi": "9BD17206G7****321", "cilindradas": "999", "combustivel": "GASOLINA", "cor": "PRATA", "especie": "PASSAGEIRO", "municipio": "SAO PAULO", "nacionalidade": "NACIONAL", "potencia": 73, "quantidade_lugares": 5, "tipo_veiculo": "AUTOMOVEL", "uf": "SP" } } }, "proprietario-atual": { "error": false, "data": { "consulta": { "CicId": 35, "debitado": true, "id": "6a4a4f1b-ff6d-4f15-9158-e3d77ad522b2", "valor": 5 }, "dados": [ { "pdf": "http://proprietario-atual.apiveiculos.com.br/pdf/72c657267dc44e2581394ef32412935e", "veicular": { "proprietario_atual_veiculo": { "ano_fabricacao": "2020", "ano_modelo": "2021", "chassi": "9ZZZZ999999999999", "combustivel": "GASOLINA", "cor_veiculo": "AZUL", "crlv": "", "data_atualizacao": "2024-01-01", "marca_modelo": "FABRICANTE/VEICULO TESTE", "motor": "1.0", "municipio": "CIDADE TESTE", "placa": "ABC1234", "proprietario_documento": "000.000.000-00", "proprietario_nome": "JOAO DA SILVA", "renavam": "00000000000", "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "uf": "SP" } } } ], "homolog": false, "msg": "consulta realizada com sucesso!", "status": true } } }, "agrupados_errors": [], "agrupados_summary": { "total_requested": 3, "total_success": 3, "total_errors": 0, "services_charged": [ "agregados-propria", "fipe", "proprietario-atual" ], "services_not_charged": [] } } ``` 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/6c0b46c0-c2ad-4624-9f1a-81ac6c2cf369/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/6c0b46c0-c2ad-4624-9f1a-81ac6c2cf369