{ "openapi": "3.0.1", "info": { "title": "PNCP Scraper", "description": "Consulta pública de contratações e contratos no Portal Nacional de Contratações Públicas.", "version": "1.0", "x-build-id": "Xy0t78jG4eZ54MYNe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/national_scrim~pncp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-national_scrim-pncp-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/national_scrim~pncp-scraper/runs": { "post": { "operationId": "runs-sync-national_scrim-pncp-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/national_scrim~pncp-scraper/run-sync": { "post": { "operationId": "run-sync-national_scrim-pncp-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchMode": { "title": "Modo de consulta", "enum": [ "proposta", "publicacao", "atualizacao", "contratos" ], "type": "string", "description": "proposta = contratações com recebimento aberto (só dataFinal). publicacao/atualizacao exigem modalidadeId. contratos = contratos assinados por data de publicação.", "default": "proposta" }, "keyword": { "title": "Palavra-chave / objeto", "type": "string", "description": "A API oficial não tem busca textual. O Actor filtra objetoCompra / objetoContrato localmente (ex.: ambulância, merenda, software)." }, "uf": { "title": "UF", "type": "string", "description": "Sigla (SP) ou nome do estado. Enviada à API em proposta/publicacao/atualizacao." }, "municipio": { "title": "Município", "type": "string", "description": "Código IBGE de 7 dígitos (enviado à API) ou nome do município (filtro local)." }, "orgao": { "title": "Órgão (nome)", "type": "string", "description": "Filtro local na razão social do órgão (ex.: MUNICIPIO DE JUAZEIRO)." }, "cnpjOrgao": { "title": "CNPJ do órgão", "type": "string", "description": "14 dígitos. Enviado como cnpj (contratações) ou cnpjOrgao (contratos)." }, "cnpjFornecedor": { "title": "CNPJ do fornecedor", "type": "string", "description": "Só faz sentido no modo contratos. A API não expõe esse parâmetro — filtro local em niFornecedor." }, "modalidadeId": { "title": "Modalidade", "minimum": 1, "maximum": 13, "type": "integer", "description": "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": { "title": "Publicação — de", "type": "string", "description": "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": { "title": "Publicação — até", "type": "string", "description": "YYYY-MM-DD ou YYYYMMDD. Default: hoje (America/Sao_Paulo). Em proposta é o único parâmetro de data obrigatório da API." }, "maxItems": { "title": "Máximo de registros", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Limite rígido (teto 5.000). A API pagina com tamanhoPagina ≥ 10.", "default": 50 }, "includeItens": { "title": "Tentar buscar itens da compra", "type": "boolean", "description": "Os endpoints de itens (/compras/{ano}/{seq}/itens) costumam responder 404/5xx. Ligado = uma tentativa extra por registro; falha não derruba o Actor.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Opcional. A API de consulta do PNCP é pública e costuma responder sem proxy." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }