# PNCP Scraper (`national_scrim/pncp-scraper`) Actor

Consulta pública de contratações e contratos no Portal Nacional de Contratações Públicas.

- **URL**: https://apify.com/national\_scrim/pncp-scraper.md
- **Developed by:** [Bruno-Arantir](https://apify.com/national_scrim) (community)
- **Categories:**
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.00 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## PNCP Scraper

**Official Brazilian public-procurement API → structured contracting and contract records.**

Colete contratações e contratos publicados no [Portal Nacional de Contratações Públicas](https://pncp.gov.br) — a fonte única da Lei 14.133/2021 — sem HTML scraping e sem login.

- Lê a **API oficial de consulta** (`pncp.gov.br/api/consulta/v1`), a mesma documentada no Swagger do portal.
- Filtra por objeto (local), UF, município/IBGE, CNPJ do órgão, modalidade e janela de publicação.
- Devolve id PNCP, órgão, UF, objeto, valores, modalidade, datas, situação e link do edital/contrato.
- HTTP barato (fetch JSON) — boa margem PPE. Proxy opcional: a API costuma ser aberta.
- Dedup por `numeroControlePNCP` e teto rígido de `maxItems` (5.000).
- Página HTML de challenge/CAPTCHA **encerra o run** (fail closed). Sem bypass.

### Fontes oficiais (verificado em 2026-09-05)

Swagger UI: [pncp.gov.br/api/consulta/swagger-ui/index.html](https://pncp.gov.br/api/consulta/swagger-ui/index.html)\
OpenAPI: `GET https://pncp.gov.br/api/consulta/v3/api-docs`\
Base: `https://pncp.gov.br/api/consulta/v1`

| Endpoint | O que lista | Parâmetros obrigatórios |
| --- | --- | --- |
| `GET /contratacoes/proposta` | Contratações com recebimento de proposta aberto | `dataFinal` (`YYYYMMDD`), `pagina` |
| `GET /contratacoes/publicacao` | Contratações por data de publicação | `dataInicial`, `dataFinal`, `codigoModalidadeContratacao`, `pagina` |
| `GET /contratacoes/atualizacao` | Contratações por data de atualização global | iguais à publicação |
| `GET /contratos` | Contratos por data de publicação | `dataInicial`, `dataFinal`, `pagina` |
| `GET /orgaos/{cnpj}/compras/{ano}/{sequencial}` | Detalhe de uma compra | path |

Filtros opcionais nas contratações: `uf`, `codigoMunicipioIbge`, `cnpj` (órgão), `codigoModalidadeContratacao` (já opcional em proposta).

`tamanhoPagina` **mínimo 10** (a API devolve 400 abaixo disso). Não há parâmetro de palavra-chave — o Actor aplica `keyword` / nome de órgão / nome de município no JSON recebido.

Portal: `https://pncp.gov.br/app/editais/{cnpj}/{ano}/{sequencial}` e `https://pncp.gov.br/app/contratos/{cnpj}/{ano}/{sequencial}`.

#### Itens da compra

`GET /api/consulta/v1/orgaos/{cnpj}/compras/{ano}/{seq}/itens` → 404\
`GET /api/pncp/v1/orgaos/{cnpj}/compras/{ano}/{seq}/itens` → 5xx recorrente

O Actor **não depende** de itens para ter sucesso. `includeItens=true` tenta uma vez e segue só com o objeto se falhar.

Há também APIs em [compras.dados.gov.br](https://compras.dados.gov.br) (ComprasNet legado). Este Actor usa o PNCP, que é o cadastro nacional vigente.

### Amostra de saída

Estrutura real da API de consulta (campos nulos quando o portal não publica o valor):

```json
{
  "id": "13915632000127-1-000207/2025",
  "recordType": "contratacao",
  "orgao": "MUNICIPIO DE JUAZEIRO",
  "orgaoCnpj": "13915632000127",
  "uf": "BA",
  "municipio": "Juazeiro",
  "objeto": "Credenciamento de prestadores de serviços de saúde…",
  "valorEstimado": 570018.24,
  "modalidade": "Credenciamento",
  "situacao": "Divulgada no PNCP",
  "linkPncp": "https://pncp.gov.br/app/editais/13915632000127/2025/207"
}
```

Exemplo ilustrativo de formato — rode o Actor para dados atuais.

### Configuração

| Campo | Default | Descrição |
| --- | --- | --- |
| `searchMode` | proposta | proposta / publicacao / atualizacao / contratos |
| `keyword` | — | Filtro local no objeto |
| `uf` | — | Sigla ou nome; vai na query da API |
| `municipio` | — | IBGE 7 dígitos ou nome |
| `orgao` | — | Filtro local na razão social |
| `cnpjOrgao` | — | Query `cnpj` / `cnpjOrgao` |
| `cnpjFornecedor` | — | Só contratos; filtro local |
| `modalidadeId` | — | Obrigatório em publicacao/atualizacao (6 = pregão eletrônico) |
| `publicationDateFrom` / `To` | até = hoje | `YYYY-MM-DD` ou `YYYYMMDD` |
| `maxItems` | 50 | Teto 5.000 |
| `includeItens` | false | Tentativa extra, fail-soft |
| `proxyConfiguration` | — | Opcional |

### PPE

Evento `dataset-item`: **US$ 2,00 / 1.000 registros** sugerido.

### LGPD

Editais, valores e razões sociais de órgãos e fornecedores são **dados públicos** de contratação. Não coletamos documentos internos nem cadastros autenticados.

### Desenvolvimento

```bash
cd actors/pncp-scraper
npm install && npm test && npm run build
apify run
```

# Actor input Schema

## `searchMode` (type: `string`):

proposta = contratações com recebimento aberto (só dataFinal). publicacao/atualizacao exigem modalidadeId. contratos = contratos assinados por data de publicação.

## `keyword` (type: `string`):

A API oficial não tem busca textual. O Actor filtra objetoCompra / objetoContrato localmente (ex.: ambulância, merenda, software).

## `uf` (type: `string`):

Sigla (SP) ou nome do estado. Enviada à API em proposta/publicacao/atualizacao.

## `municipio` (type: `string`):

Código IBGE de 7 dígitos (enviado à API) ou nome do município (filtro local).

## `orgao` (type: `string`):

Filtro local na razão social do órgão (ex.: MUNICIPIO DE JUAZEIRO).

## `cnpjOrgao` (type: `string`):

14 dígitos. Enviado como cnpj (contratações) ou cnpjOrgao (contratos).

## `cnpjFornecedor` (type: `string`):

Só faz sentido no modo contratos. A API não expõe esse parâmetro — filtro local em niFornecedor.

## `modalidadeId` (type: `integer`):

Obrigatório em publicacao e atualizacao. Códigos PNCP: 1 Leilão eletrônico, 2 Diálogo competitivo, 3 Concurso, 4 Concorrência eletrônica, 5 Concorrência presencial, 6 Pregão eletrônico (mais comum), 7 Pregão presencial, 8 Dispensa, 9 Inexigibilidade, 10 Manifestação de interesse, 11 Pré-qualificação, 12 Credenciamento, 13 Leilão presencial. Opcional em proposta.

## `publicationDateFrom` (type: `string`):

YYYY-MM-DD ou YYYYMMDD. Em proposta só existe dataFinal na API; esta data vira filtro local se informada. Nos outros modos, default = 3 dias antes de “até”.

## `publicationDateTo` (type: `string`):

YYYY-MM-DD ou YYYYMMDD. Default: hoje (America/Sao\_Paulo). Em proposta é o único parâmetro de data obrigatório da API.

## `maxItems` (type: `integer`):

Limite rígido (teto 5.000). A API pagina com tamanhoPagina ≥ 10.

## `includeItens` (type: `boolean`):

Os endpoints de itens (/compras/{ano}/{seq}/itens) costumam responder 404/5xx. Ligado = uma tentativa extra por registro; falha não derruba o Actor.

## `proxyConfiguration` (type: `object`):

Opcional. A API de consulta do PNCP é pública e costuma responder sem proxy.

## Actor input object example

```json
{
  "searchMode": "proposta",
  "keyword": "saúde",
  "uf": "BA",
  "maxItems": 20,
  "includeItens": false
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "keyword": "saúde",
    "uf": "BA",
    "maxItems": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("national_scrim/pncp-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "keyword": "saúde",
    "uf": "BA",
    "maxItems": 20,
}

# Run the Actor and wait for it to finish
run = client.actor("national_scrim/pncp-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "keyword": "saúde",
  "uf": "BA",
  "maxItems": 20
}' |
apify call national_scrim/pncp-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,national_scrim/pncp-scraper"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/xxpv43CQoY60UXlHL/builds/Xy0t78jG4eZ54MYNe/openapi.json