--- title: "API Leilao" description: "Consulta dados referentes a leilões envolvendo o veículo, incluindo informações sobre a participação em leilões e detalhes dos leiloeiros associados." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/35426b83-762e-46e7-bdaa-38db164c41fe markdown: https://doc.apibrasil.io/apis/creditos/35426b83-762e-46e7-bdaa-38db164c41fe.md source: apibrasil-documentation --- # API Leilao > Consulta dados referentes a leilões envolvendo o veículo, incluindo informações sobre a participação em leilões e detalhes dos leiloeiros associados. - **Categoria:** Segurança Veicular - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 11,50 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/35426b83-762e-46e7-bdaa-38db164c41fe/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 — Leilões por Placa Obtenha, em uma única consulta, histórico de leilões associados a um veículo a partir da placa. O retorno consolida identificação do veículo, quantidade total de ocorrências em leilões, cada registro encontrado (com dados do comitente, data, lote e condição) e um sumário de 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": "leilao", "placa": "ABC1234", "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":"leilao","placa":"ABC1234","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": "249,280", "balance_before": "249,280", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "analise_risco": { "descricaoretorno": "PESQUISA EFETUADA COM SUCESSO", "indicerisco": "1", "parecer": "NAO FOI ENCONTRADO RISCO PARA O VEICULO" }, "dados_veiculo": { "anofabricacaomodelo": 1986, "chassi": "9BWZZZ32ZGP246344", "cor": "VERMELHA", "marcamodelo": "VW SANTANA CG", "placa": "ABC1234" }, "leilao": { "descricaoretorno": "Consta Registro de Leilao para o veiculo informado", "qtdleilao": "5", "registro": [ { "anofabricacaomodelo": "0", "chassi": "9BWZZZ32ZGP246344", "classificacao": "NAO FOI POSSIVEL CLASSIFICAR", "comitente": "SULAMERICA SEGUROS", "condicaogeraldoveiculo": "NAO DIVULGADO", "cor": "VERMELHA", "dataleilao": "20/01/2010", "foto1": "NAO INFORMADO", "foto2": "NAO INFORMADO", "foto3": "NAO INFORMADO", "foto4": "NAO INFORMADO", "identificacaolote": null, "identificacaoveiculo": null, "idleilao": "1", "leiloeiro": "NAO INFORMADO", "lote": "2379", "marcamodelo": "SANTANA CG", "patio": "NAO INFORMADO", "placa": "ABC1234", "quantidaderegistro": null, "situacaogeraldochassi": "NAO DIVULGADO" }, { "anofabricacaomodelo": "1986", "chassi": "9BWZZZ32ZGP246344", "classificacao": "NAO FOI POSSIVEL CLASSIFICAR", "comitente": "HDI SEGUROS S/A", "condicaogeraldoveiculo": "SUCATA INSERVIVEL", "cor": "VERMELHA", "dataleilao": "19/11/2014", "foto1": "NAO INFORMADO", "foto2": "NAO INFORMADO", "foto3": "NAO INFORMADO", "foto4": "NAO INFORMADO", "identificacaolote": null, "identificacaoveiculo": null, "idleilao": "2", "leiloeiro": "N/C", "lote": "0", "marcamodelo": "SANTANA CG", "patio": "NAO INFORMADO", "placa": "ABC1234", "quantidaderegistro": null, "situacaogeraldochassi": "NAO DIVULGADO" }, { "anofabricacaomodelo": "1986", "chassi": "9BWZZZ32ZGP246344", "classificacao": "NAO FOI POSSIVEL CLASSIFICAR", "comitente": "NAO DIVULGADO", "condicaogeraldoveiculo": "NAO INFORMADO", "cor": "VERMELHA", "dataleilao": "03/08/2016", "foto1": "NAO INFORMADO", "foto2": "NAO INFORMADO", "foto3": "NAO INFORMADO", "foto4": "NAO INFORMADO", "identificacaolote": null, "identificacaoveiculo": null, "idleilao": "3", "leiloeiro": "N/C", "lote": "0", "marcamodelo": "SANTANA CG", "patio": "NAO INFORMADO", "placa": "ABC1234", "quantidaderegistro": null, "situacaogeraldochassi": "NAO DIVULGADO" }, { "anofabricacaomodelo": "1986", "chassi": "9BWZZZ32ZGP246344", "classificacao": "NAO FOI POSSIVEL CLASSIFICAR", "comitente": "4O VARA CRIMINAL DA COMARCA DE LONDRINA/PR (AUTOS: 0027401-42.2022.8.16.0014)", "condicaogeraldoveiculo": "NAO INFORMADO", "cor": "VERMELHA", "dataleilao": "01/01/0001", "foto1": "NAO INFORMADO", "foto2": "NAO INFORMADO", "foto3": "NAO INFORMADO", "foto4": "NAO INFORMADO", "identificacaolote": null, "identificacaoveiculo": null, "idleilao": "4", "leiloeiro": "N/C", "lote": "0", "marcamodelo": "SANTANA CG", "patio": "NAO INFORMADO", "placa": "ABC1234", "quantidaderegistro": null, "situacaogeraldochassi": "NAO INFORMADO" }, { "anofabricacaomodelo": "1986", "chassi": "9BWZZZ32ZGP246344", "classificacao": "NAO FOI POSSIVEL CLASSIFICAR", "comitente": "NAO INFORMADO", "condicaogeraldoveiculo": "NAO INFORMADO", "cor": "VERMELHA", "dataleilao": "06/12/2022", "foto1": "NAO INFORMADO", "foto2": "NAO INFORMADO", "foto3": "NAO INFORMADO", "foto4": "NAO INFORMADO", "identificacaolote": null, "identificacaoveiculo": null, "idleilao": "5", "leiloeiro": "N/C", "lote": "0", "marcamodelo": "SANTANA CG", "patio": "NAO INFORMADO", "placa": "ABC1234", "quantidaderegistro": null, "situacaogeraldochassi": "NAO INFORMADO" } ] } } } ``` 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/35426b83-762e-46e7-bdaa-38db164c41fe/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/35426b83-762e-46e7-bdaa-38db164c41fe