Skip to main content
GET
https://localapi.lazydata.com.br
/
v1
/
search
/
datasets
/
{target}
Datasets e preços
curl --request GET \
  --url https://localapi.lazydata.com.br/v1/search/datasets/{target} \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "message": "Datasets retornados com sucesso.",
  "result": {
    "target": "person",
    "currency": "BRL",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false,
        "description": "Informações cadastrais consolidadas do CPF consultado.",
        "source": "database",
        "additional_fields": {},
        "struct_type": "object",
        "struct": {
          "name": {
            "type": "string",
            "description": "Nome da pessoa consultada."
          },
          "birth_date": {
            "type": "date",
            "description": "Data de nascimento."
          },
          "tax_id": {
            "type": "string",
            "description": "CPF consultado."
          }
        },
        "time": 1.2
      }
    ]
  }
}
Retorna os datasets disponíveis para um tipo de consulta, já considerando o preço final aplicado para a conta autenticada. Use este endpoint para montar seletores de datasets, calcular estimativas de custo e entender quais campos cada dataset pode retornar. 
{
  "code": 200,
  "message": "Datasets retornados com sucesso.",
  "result": {
    "target": "person",
    "currency": "BRL",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false,
        "description": "Informações cadastrais consolidadas do CPF consultado.",
        "source": "database",
        "additional_fields": {},
        "struct_type": "object",
        "struct": {
          "name": {
            "type": "string",
            "description": "Nome da pessoa consultada."
          },
          "birth_date": {
            "type": "date",
            "description": "Data de nascimento."
          },
          "tax_id": {
            "type": "string",
            "description": "CPF consultado."
          }
        },
        "time": 1.2
      }
    ]
  }
}

​
Parâmetros

​
target
string
required
Tipo de consulta usado para listar os datasets disponíveis.
Valores aceitos para target:
ValorDescrição
personDatasets de pessoa física.
companyDatasets de pessoa jurídica.
processDatasets processuais.
vehicleDatasets veiculares.
Em páginas MDX manuais, o campo target é exibido como entrada de texto no playground. Para exibir um seletor nativo com valores fixos, use uma especificação OpenAPI com enum.

​
Resposta

​
code
integer
required
Código da resposta da API.
​
message
string
required
Mensagem descritiva da resposta.
​
result
object
required
Objeto principal com o tipo de consulta, moeda e lista de datasets disponíveis.

​
Estrutura de result

CampoTipoDescrição
targetstringTipo de consulta informado na rota.
currencystringMoeda usada nos preços retornados. Atualmente BRL.
datasetsarray<object>Lista de datasets disponíveis para o tipo de consulta.

​
Estrutura de result.datasets[]

CampoTipoDescrição
idstringIdentificador do dataset. Use este valor no campo datasets das consultas.
namestringNome amigável exibido no painel ou na sua interface.
pricenumberPreço final da consulta daquele dataset, já com regras comerciais aplicadas à conta autenticada.
activebooleanIndica se o dataset está disponível para uso. Datasets inativos não devem ser enviados em consultas.
debit_only_if_foundbooleanIndica se a cobrança deve ocorrer apenas quando houver retorno útil.
descriptionstringDescrição do dataset e do tipo de informação retornada.
sourcestringOrigem operacional do dataset, como database ou online.
additional_fieldsobjectCampos adicionais exigidos pelo dataset, quando houver.
struct_typestringTipo da estrutura de retorno esperada, como object, array ou outro formato definido pelo dataset.
structobjectDescrição dos campos que podem ser retornados pelo dataset.
timenumberTempo estimado de execução em segundos, quando disponível.
Campos descritos em struct podem não ser retornados em todas as consultas. Alguns retornos dependem da disponibilidade da fonte, do documento consultado e das regras específicas de cada dataset.

​
Campos adicionais

O campo additional_fields informa parâmetros extras que devem ser enviados no objeto additional durante uma consulta. Quando estiver vazio, o dataset não exige dados adicionais: 
{
  "additional_fields": {}
}
Quando houver campos adicionais, a estrutura indica o tipo, rótulo e obrigatoriedade: 
{
  "additional_fields": {
    "state": {
      "type": "string",
      "label": "UF",
      "required": true,
      "description": "Sigla da unidade federativa usada na consulta."
    }
  }
}
Campos comuns em additional_fields:
CampoTipoDescrição
typestringTipo esperado do valor.
labelstringNome amigável para exibição em interface.
requiredbooleanIndica se o campo é obrigatório.
descriptionstringExplicação sobre o valor esperado.

​
Estrutura de retorno do dataset

O campo struct descreve os dados que podem ser retornados por cada dataset. Exemplo: 
{
  "struct": {
    "name": {
      "type": "string",
      "description": "Nome da pessoa consultada."
    },
    "birth_date": {
      "type": "date",
      "description": "Data de nascimento."
    },
    "tax_id": {
      "type": "string",
      "description": "CPF consultado."
    }
  }
}
Campos comuns dentro de struct:
CampoTipoDescrição
typestringTipo esperado do campo retornado.
descriptionstringDescrição do campo.
labelstringNome amigável, quando disponível.
itemsobjectEstrutura de itens, quando o campo for uma lista.
propertiesobjectSubcampos, quando o campo for um objeto composto.

​
Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.
StatusQuando ocorre
200A listagem foi retornada com sucesso.
400O target informado não é um dos tipos aceitos.
401A chave da API está ausente, inválida ou não pôde ser autenticada.
403A credencial não possui escopo de consulta ou o plano da conta não permite acesso ao recurso.

​
Como usar o retorno

  1. Liste os datasets do tipo desejado usando target.
  2. Exiba apenas datasets com active: true.
  3. Use price para calcular a estimativa da consulta.
  4. Use id no campo datasets das requisições de consulta.
  5. Se additional_fields tiver campos obrigatórios, colete esses dados antes de executar a consulta.

​
Exemplo de uso em uma consulta

Após obter o dataset person_basic_data, envie o ID no campo datasets de uma consulta compatível: 
{
  "taxid": "00000000000",
  "mode": "async",
  "datasets": ["person_basic_data"],
  "additional": {}
}
O CPF acima é fictício e serve apenas para demonstrar a estrutura da requisição. Em consultas reais ou testes sandbox, informe documentos válidos conforme o ambiente utilizado.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
target
string
required

Tipo de consulta usado para listar os datasets disponíveis.

Response

200 - application/json

Response 200

​
code
integer
required

Código da resposta da API.

​
message
string
required

Mensagem descritiva da resposta.

​
result
object
required

Objeto principal com o tipo de consulta, moeda e lista de datasets disponíveis.