Data Query — Nyqo API

Requisição

curl -X POST "https://api.nyqo.dev/api/v1/consultas" \
  -H "Authorization: Bearer nyq_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{"type":"cpf","value":"12345678901","format":"json"}'

Troque nyq_sua_chave_aqui pela sua chave do painel. Também aceito via header X-API-Key — nunca na query string.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`type`	`string`	sim	Tipo da consulta: nome, cpf, telefone ou placa.
`value`	`string`	sim	Valor da consulta, normalizado conforme o tipo informado.
`format`	`string`	não	json (padrão) para payload estruturado ou text para JSON com texto formatado.

Resposta

Campo	Tipo	Descrição
`success`	`boolean`	Indica se a consulta foi concluída com sucesso.
`type`	`string`	Tipo de consulta executado.
`value`	`string`	Valor consultado após normalização.
`data`	`object`	Payload estruturado sanitizado quando format=json.
`text`	`string`	Texto formatado quando format=text.

Exemplo de resposta real

{
	"success": true,
	"type": "cpf",
	"value": "12345678901",
	"data": {
	  "DadosBasicos": {
	    "nome": "Fulano de Tal"
	  }
	}
}

Levar essa referência para o seu agente/LLM

Copie a doc em Markdown — mesmo formato das skills e do llms.txt.

# Data Query

`POST https://api.nyqo.dev/api/v1/consultas`

Endpoint único de consultas de dados. Aceita POST JSON ou GET com type/value. Tipos suportados: nome, cpf, telefone e placa. Use format=json para payload estruturado ou format=text para texto formatado em JSON.

Categoria: Nyqo Buscas · Slug: `data-query`

## Autenticação

```http
Authorization: Bearer nyq_sua_chave_aqui
```

Também aceito: `X-API-Key: nyq_sua_chave_aqui`. Nunca via query string (`?api_key`).

## Parâmetros

| Nome | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `type` | `string` | sim | Tipo da consulta: nome, cpf, telefone ou placa. |
| `value` | `string` | sim | Valor da consulta, normalizado conforme o tipo informado. |
| `format` | `string` | não | json (padrão) para payload estruturado ou text para JSON com texto formatado. |

## Resposta

| Campo | Tipo | Descrição |
| --- | --- | --- |
| `success` | `boolean` | Indica se a consulta foi concluída com sucesso. |
| `type` | `string` | Tipo de consulta executado. |
| `value` | `string` | Valor consultado após normalização. |
| `data` | `object` | Payload estruturado sanitizado quando format=json. |
| `text` | `string` | Texto formatado quando format=text. |

## Exemplo (curl)

```bash
curl -X POST "https://api.nyqo.dev/api/v1/consultas" \
  -H "Authorization: Bearer nyq_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{"type":"cpf","value":"12345678901","format":"json"}'
```

## Exemplo de resposta

```json
{
	"success": true,
	"type": "cpf",
	"value": "12345678901",
	"data": {
	  "DadosBasicos": {
	    "nome": "Fulano de Tal"
	  }
	}
}
```

Erros comuns

· 401 unauthorized — sem chave ou chave inválida. Confira autenticação.
· 403 forbidden — plano sem esta rota ou chave fora do escopo. Veja planos.
· 429 rate_limited — quota estourada; aguarde Retry-After. Detalhes em rate limits.

Tabela completa em /docs — códigos de erro.

Estamos em manutenção

Requisição

Parâmetros

Resposta

Levar essa referência para o seu agente/LLM

Erros comuns