{ "openapi": "3.0.1", "info": { "title": "PNCP Brazilian Public Procurement Scraper", "description": "Search Brazilian government tenders (licitações) from PNCP — the official Portal Nacional de Contratações Públicas. Public open-data API, no auth, no ToS risk.", "version": "1.0", "x-build-id": "3txlj1jJ0BBJLrZLO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aryrabelo~pncp-procurement-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aryrabelo-pncp-procurement-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/aryrabelo~pncp-procurement-scraper/runs": { "post": { "operationId": "runs-sync-aryrabelo-pncp-procurement-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/aryrabelo~pncp-procurement-scraper/run-sync": { "post": { "operationId": "run-sync-aryrabelo-pncp-procurement-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": { "queryType": { "title": "Query type", "enum": [ "publicacao", "proposta" ], "type": "string", "description": "publicacao = tenders by publication date range. proposta = tenders currently OPEN for proposals (up to dataFinal).", "default": "publicacao" }, "dataInicial": { "title": "Start date (publicacao only)", "type": "string", "description": "YYYY-MM-DD. Defaults to 7 days ago. Ignored for 'proposta'." }, "dataFinal": { "title": "End date", "type": "string", "description": "YYYY-MM-DD. Defaults to today." }, "modalidades": { "title": "Modalidade codes", "type": "array", "description": "PNCP modalidade codes. Required for 'publicacao'. 6=Pregão Eletrônico, 8=Dispensa, 4=Concorrência Eletrônica, 9=Inexigibilidade, 12=Credenciamento. Defaults to [6, 8].", "default": [ 6, 8 ] }, "uf": { "title": "State (UF)", "type": "string", "description": "Two-letter Brazilian state code to filter by (e.g. SP, RJ, MG). Optional." }, "codigoMunicipioIbge": { "title": "IBGE municipality code", "pattern": "^[0-9]{7}$", "type": "string", "description": "7-digit IBGE code. Look up at servicodados.ibge.gov.br/api/v1/localidades/municipios?nome=YOURCITY. Santarém-PA = 1506807." }, "cnpj": { "title": "Órgão CNPJ", "type": "string", "description": "14-digit CNPJ of the contracting agency to filter by. Optional." }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only tenders whose objeto contains ANY of these terms (accent/case-insensitive). Optional.", "items": { "type": "string" } }, "includeItems": { "title": "Include line items", "type": "boolean", "description": "Also fetch each tender's line items (products/services). Multiplies request count — leave off for large runs.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Stop after this many tender records. Protects your spend.", "default": 1000 } } }, "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 } } } } } } } } } }