> ## Documentation Index
> Fetch the complete documentation index at: https://docs.judit.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Consumo da Judit API

> Como acompanhar e estimar o consumo da Judit API por requisições, com exemplos práticos para extrair relatórios de uso por período.

# 📘 Como consultar meu histórico de requisições realizadas pela API JUDIT

Este passo a passo irá te mostrar como consultar o histórico de requisições realizadas por meio da API JUDIT. Com isso, você poderá visualizar detalhes como:

* Tipo de busca realizada
* Período
* Presença de anexos
* Origem da requisição (monitoramento ou API)
* E inclusive inferir o custo de cada operação.

***

## 1. Como consultar o histórico via Postman (usando cURL)

Para realizar a requisição:

Copie o seguinte comando `cURL` e cole no **Postman** (modo *Raw* no Body e tipo `POST`):

```bash theme={null}
curl --location 'https://requests.production.judit.io/requests?page_size=1000&created_at_gte=<DATA INICIAL>&created_at_lte=<DATA FINAL>' \
--header 'api-key: INSIRA_SUA_API_KEY_AQUI' \
--header 'Content-Type: application/json' \
--data ''
```

Substitua `<DATA INICIAL>` e `<DATA FINAL>` no formato `YYYY-MM-DD`, por exemplo:

```
created_at_gte=2024-09-12&created_at_lte=2050-09-12
```

***

## 2. Como consultar o histórico via JavaScript (fetch)

Exemplo de código:

```js theme={null}
const url = 'https://requests.production.judit.io/requests?page_size=1000&created_at_gte=2024-09-12&created_at_lte=2050-09-12';
const options = {
  method: 'GET',
  headers: {
    'api-key': '<INSIRA_SUA_API_KEY_AQUI>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

***

## 3. Exemplo de resposta da API

Trecho de exemplo:

<Accordion title="Ver exemplo de resposta">
  ```json theme={null}
  {
    "page": 1,
    "page_data": [
      {
        "request_id": "0dcd4c1f-c9bf-4327-899e-0550a627feca",
        "search": {
          "on_demand": false,
          "search_type": "lawsuit_cnj",
          "search_key": "0000999-99.9999.9.99.9999",
          "response_type": "lawsuit",
          "search_params": {
            "public_search": false,
            "filter": {
              "party_names": [],
              "party_documents": []
            },
            "pagination": {}
          }
        },
        "with_attachments": true,
        "origin": "tracking",
        "status": "completed",
        "created_at": "2025-07-25T21:10:03.334Z",
        "updated_at": "2025-07-25T21:10:25.352Z"
      }
    ]
  }
  ```
</Accordion>

***

## 4. Explicação dos principais campos

| Campo                | Significado                                                                  |
| -------------------- | ---------------------------------------------------------------------------- |
| `origin`             | Pode ser `api` (requisição direta) ou `tracking` (monitoramento automático). |
| `response_type`      | Tipo de retorno: `lawsuit`, `entity`, `warrant`, `lawsuits`.                 |
| `search.search_type` | Tipo de busca: `cpf`, `cnpj`, `oab`, `name`, `lawsuit_cnj`.                  |
| `on_demand`          | Se `true`, indica consulta em tempo real no tribunal.                        |
| `with_attachments`   | Se `true`, foram incluídos autos processuais (impacta no custo).             |

***

## 🔍 Interpretação dos campos

### `origin`

Esse campo indica a **origem** da requisição, podendo assumir os seguintes valores:

* `api`: consulta realizada diretamente por meio da API.
* `tracking`: consulta realizada via monitoramento (recorrente).

### `response_type`

Define o tipo de documento que será retornado na busca. As possibilidades incluem:

* `lawsuit`: utilizado em consultas por NUP (Número Único do Processo).
* `lawsuits`: utilizado em buscas por CPF, CNPJ, OAB ou NAME, retornando uma lista de processos.
* `entity`: utilizado em busca cadastral (por CPF, CNPJ, etc).
* `warrant`: utilizado em busca por mandado de prisão.

***

## 🧪 Exemplo real e análise de precificação

```json theme={null}
{
  "request_id": "c2af614a-8296-4060-bf9a-3b087679c472",
  "search": {
    "on_demand": true,
    "search_type": "lawsuit_cnj",
    "search_key": "0000999-99.9999.9.99.9999",
    "response_type": "lawsuit",
    "search_params": {
      "public_search": false,
      "filter": {
        "party_names": [],
        "party_documents": []
      },
      "pagination": {}
    }
  },
  "with_attachments": true,
  "callback_url": "https://webhook.site/...",
  "origin": "tracking",
  "status": "completed",
  "created_at": "2025-07-25T21:10:03.334Z"
}
```

### 💰 Análise da precificação com base nos campos:

* `origin: tracking` → é uma consulta através de monitoramento, portanto cobrança **mensal**.
* `search_type: lawsuit_cnj` → o monitoramento é processual por número CNJ.
* `on_demand: true` → como se trata de monitoramento, esse valor sempre será true já que todo monitoramento é on-demand.
* `with_attachments: true` → autos processuais foram coletados, o que implica cobrança adicional.

***

## 🔸 Total estimado da requisição:

<Note>
  Os valores apresentados são meramente ilustrativos. Para informações comerciais reais, consulte nossa tabela oficial.
</Note>

* **Monitoramento processual**: R\$ 0,69/mês
* **Autos processuais**: R\$ 3,50 (cobrança única)

### ➡️ **Custo total estimado**: R\$ 4,19

***

## ℹ️ Pontos importantes

* A cobrança pode variar conforme o tipo de busca, tempo real (`on_demand`) e presença de anexos.
* Requisições via `tracking` são renovadas mensalmente enquanto o monitoramento estiver ativo.
* Requisições do tipo histórica (`cpf`, `cnpj`, etc.) têm cobrança única por consulta.

***