--- title: "Leilão Simples" description: "API Leilão Simples" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/4eadd895-91ce-4950-a16b-f9c02883aa2f markdown: https://doc.apibrasil.io/apis/creditos/4eadd895-91ce-4950-a16b-f9c02883aa2f.md source: apibrasil-documentation --- # Leilão Simples > API Leilão Simples - **Categoria:** Segurança Veicular - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 6,90 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/4eadd895-91ce-4950-a16b-f9c02883aa2f/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 Envie um POST com tipo=leilao-simples e a placa (7 caracteres, padrão antigo ou Mercosul). A resposta vem em data.dados e traz placa, consta_leilao, quantidade, leiloes (data, comitente, leiloeiro, lote, patio, condicao_geral, situacao_chassi e demais condições), veiculo, veiculo_leilao, score, indicio_sinistro e alertas. A cobrança acontece quando o veículo é localizado (com ou sem leilão); campo placa ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia, sem cobrança, para qualquer placa válido. - **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-simples", "placa": "ABC1D23", "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-simples","placa":"ABC1D23","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": "393,100", "balance_before": "400,000", "tax": "6,900", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 6,90.", "valor_consulta": 6.9, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "placa": "ABC1D23", "consta_leilao": true, "quantidade": 1, "leiloes": [ { "data": "11/06/2021", "comitente": "COMITENTE EXEMPLO", "leiloeiro": "LEILOEIRO EXEMPLO", "lote": "0456", "patio": "", "condicao_geral": "SINISTRADO RECUPERAVEL", "situacao_chassi": "NORMAL", "condicao_motor": "", "condicao_cambio": "", "condicao_mecanica": "", "observacoes": "" } ], "veiculo": { "placa": "ABC1D23", "chassi": "9BGKS48U0JG000001", "renavam": "00123456789", "marca_modelo": "CHEVROLET/ONIX 1.0 LT", "ano_fabricacao": "2017", "ano_modelo": "2018", "cor": "PRATA", "combustivel": "ALCOOL / GASOLINA", "municipio": "CIDADE EXEMPLO", "uf": "SP", "situacao": "S", "data_emplacamento": "" }, "veiculo_leilao": { "marca_modelo": "CHEVROLET/ONIX 1.0 LT", "ano_fabricacao": "2017", "ano_modelo": "2018", "cor": "PRATA", "combustivel": "ALCOOL / GASOLINA", "categoria": "MEDIA MONTA" }, "score": { "pontuacao": "D", "descricao": "MEDIOS DANOS", "aceitacao": "70", "percentual_tabela_referencia": "70", "exige_vistoria_especial": "MAIOR PROBABILIDADE" }, "indicio_sinistro": { "existe": true, "descricao": "INDICIO DE SINISTRO ENCONTRADO NAS BASES CONSULTADAS" }, "alertas": 1 } } } ``` 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/4eadd895-91ce-4950-a16b-f9c02883aa2f/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/4eadd895-91ce-4950-a16b-f9c02883aa2f