Skip to main content
POST
https://localapi.lazydata.com.br
/
v1
/
search
/
vehicle
Busca por placa
curl --request POST \
  --url https://localapi.lazydata.com.br/v1/search/vehicle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "plate": "<string>",
  "datasets": [
    "<string>"
  ],
  "additional": {},
  "mode": "<string>"
}
'
{
  "code": 200,
  "message": "Consulta realizada com sucesso.",
  "result": {
    "id": "9fcb573b-7f62-4774-978b-07e89dfef5f2",
    "status": "completed",
    "target": "vehicle",
    "query": {
      "plate": "ABC0A00",
      "datasets": ["vehicle_basic_data"],
      "additional": {}
    },
    "cost": {
      "total": 0.12,
      "refunded": 0,
      "datasets": {
        "vehicle_basic_data": {
          "charged": 0.12,
          "refunded": 0
        }
      }
    },
    "timing": {
      "total": 1.84,
      "datasets": {
        "vehicle_basic_data": 1.84
      }
    },
    "errors": {},
    "datasets_status": {
      "vehicle_basic_data": "completed"
    },
    "result": {
      "vehicle_basic_data": {
        "plate": "ABC0A00",
        "state": "SP",
        "city": "São Paulo",
        "brand": "MARCA EXEMPLO",
        "model": "MODELO EXEMPLO",
        "manufacture_year": "2020",
        "model_year": "2021",
        "fuel": "FLEX",
        "color": "PRATA",
        "vehicle_type": "AUTOMÓVEL",
        "status": "EM CIRCULACAO"
      }
    },
    "created_at": "2026-06-22T12:00:00Z",
    "last_updated_at": "2026-06-22T12:00:02Z"
  }
}
Executa uma consulta veicular usando a placa informada e os datasets selecionados. A consulta aceita placas no formato antigo e no padrão Mercosul. Pontuação, espaços e hífen são removidos automaticamente antes da validação.
{
  "code": 200,
  "message": "Consulta realizada com sucesso.",
  "result": {
    "id": "9fcb573b-7f62-4774-978b-07e89dfef5f2",
    "status": "completed",
    "target": "vehicle",
    "query": {
      "plate": "ABC0A00",
      "datasets": ["vehicle_basic_data"],
      "additional": {}
    },
    "cost": {
      "total": 0.12,
      "refunded": 0,
      "datasets": {
        "vehicle_basic_data": {
          "charged": 0.12,
          "refunded": 0
        }
      }
    },
    "timing": {
      "total": 1.84,
      "datasets": {
        "vehicle_basic_data": 1.84
      }
    },
    "errors": {},
    "datasets_status": {
      "vehicle_basic_data": "completed"
    },
    "result": {
      "vehicle_basic_data": {
        "plate": "ABC0A00",
        "state": "SP",
        "city": "São Paulo",
        "brand": "MARCA EXEMPLO",
        "model": "MODELO EXEMPLO",
        "manufacture_year": "2020",
        "model_year": "2021",
        "fuel": "FLEX",
        "color": "PRATA",
        "vehicle_type": "AUTOMÓVEL",
        "status": "EM CIRCULACAO"
      }
    },
    "created_at": "2026-06-22T12:00:00Z",
    "last_updated_at": "2026-06-22T12:00:02Z"
  }
}

Corpo da requisição

plate
string
required
Placa do veículo. Aceita formato antigo e Mercosul.
datasets
string[]
required
Lista de IDs dos datasets veiculares que serão consultados.
additional
object
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
mode
string
default:"async"
Modo da consulta.
Valores aceitos para mode:
ValorDescrição
asyncInicia a consulta e retorna um id para acompanhar o resultado depois.
syncAguarda a conclusão da consulta e retorna os dados diretamente na resposta.
x-ambient
string
Use sandbox para executar uma chamada de teste sem consumo de saldo.
Para detalhes sobre chamadas de teste, consulte Ambiente de teste.

Exemplo de corpo

{
  "plate": "ABC0A00",
  "mode": "async",
  "datasets": ["vehicle_basic_data"],
  "additional": {}
}
A placa acima é fictícia e serve apenas para demonstrar a estrutura da requisição. Em chamadas reais ou sandbox, informe uma placa válida para o ambiente utilizado.

Regras da placa

O campo plate aceita os dois padrões principais de placas brasileiras:
FormatoExemplo estruturalDescrição
AntigoABC1234Três letras seguidas de quatro números.
MercosulABC1D23Três letras, um número, uma letra e dois números.
A API normaliza o valor recebido antes da consulta, removendo hífen, espaços e pontuação.

Datasets veiculares

Antes de iniciar a consulta, liste os datasets disponíveis em Datasets e preços usando o tipo vehicle. Use apenas datasets com active: true.

Parâmetros adicionais por dataset

Alguns datasets podem exigir campos adicionais. Consulte additional_fields no endpoint de datasets e preços para saber quais campos devem ser enviados. Exemplo de envio de dados adicionais:
{
  "plate": "ABC0A00",
  "mode": "async",
  "datasets": ["vehicle_example_dataset"],
  "additional": {
    "vehicle_example_dataset": {
      "state": "SP"
    }
  }
}

Resposta

code
integer
required
Código da resposta da API.
message
string
required
Mensagem descritiva da resposta.
result
object
required
Objeto principal da consulta. A estrutura varia de acordo com o modo de execução.

Retorno síncrono

Quando mode é sync, a resposta pode retornar code: 200 com os dados completos da consulta.

Estrutura de result

CampoTipoDescrição
idstringIdentificador único da consulta.
statusstringStatus final da consulta. Normalmente completed.
targetstringTipo da consulta. Para esta rota, retorna vehicle.
queryobjectDados usados na consulta.
costobjectValores cobrados e estornados.
timingobjectTempo total e tempo individual por dataset.
errorsobjectErros por dataset, quando ocorrerem.
datasets_statusobjectStatus individual de cada dataset.
resultobjectResultado agrupado por dataset.
created_atstringData de criação da consulta em ISO 8601.
last_updated_atstringData da última atualização da consulta em ISO 8601.

Estrutura de result.query

CampoTipoDescrição
platestringPlaca consultada, normalizada sem pontuação.
datasetsarray<string>Datasets solicitados.
additionalobjectDados adicionais enviados por dataset.

Estrutura de result.cost

CampoTipoDescrição
totalnumberValor total debitado após regras de retorno e estorno.
refundednumberValor total estornado.
datasetsobjectDetalhamento de cobrança por dataset.

Estrutura de result.timing

CampoTipoDescrição
totalnumberTempo total da consulta em segundos.
datasetsobjectTempo individual de cada dataset em segundos.

Estrutura de result.errors

O campo errors retorna um objeto indexado pelo ID do dataset quando alguma base falha.
{
  "errors": {
    "vehicle_example_dataset": {
      "code": 42025,
      "message": "Não foi possível consultar o provedor da consulta."
    }
  }
}

Estrutura de result.datasets_status

Objeto com o status individual de cada dataset.
{
  "datasets_status": {
    "vehicle_basic_data": "completed",
    "vehicle_example_dataset": "failed"
  }
}

Estrutura de result.result

Objeto indexado pelo ID do dataset. Cada chave contém o retorno do dataset correspondente.
{
  "result": {
    "vehicle_basic_data": {
      "plate": "ABC0A00",
      "state": "SP",
      "brand": "MARCA EXEMPLO",
      "model": "MODELO EXEMPLO"
    }
  }
}
Campos descritos na estrutura do dataset podem não ser retornados em todas as consultas. Alguns dados dependem da disponibilidade da fonte e da placa consultada.

Retorno assíncrono

Quando mode é async, a resposta inicial retorna code: 202 e o processamento continua em segundo plano.

Estrutura de result

CampoTipoDescrição
idstringIdentificador da consulta assíncrona.
statusstringStatus atual da consulta.
status_valuesarray<string>Lista de status possíveis.
datasetsarray<string>Datasets solicitados na consulta.
Status possíveis:
StatusDescrição
queuedConsulta criada e aguardando processamento.
processingConsulta em processamento.
completedConsulta finalizada. Verifique o resultado, erros e status por dataset no endpoint de resultado.
failedConsulta finalizada com falha geral.
Para consultar o resultado final, use o id retornado no endpoint de resultado assíncrono com target: vehicle.

Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.
StatusQuando ocorre
200Consulta síncrona concluída com sucesso.
202Consulta assíncrona iniciada com sucesso.
400Requisição inválida, placa inválida, dataset ausente ou parâmetro incompatível.
401A chave da API está ausente, inválida ou não pôde ser autenticada.
403A credencial não possui escopo de consulta, o plano não permite acesso ou há bloqueio financeiro.

Fluxo recomendado

  1. Liste os datasets disponíveis em Datasets e preços usando target: vehicle.
  2. Selecione apenas datasets veiculares ativos.
  3. Envie a placa, os datasets e os campos adicionais necessários.
  4. Use mode: "async" para iniciar a consulta e acompanhar o resultado depois.
  5. Consulte o resultado em Resultado assíncrono usando target: vehicle.