{ "openapi": "3.0.1", "info": { "title": "Brazil Public Tenders (PNCP)", "description": "Brazilian public tenders and contracts from the official PNCP API: buyer, modality, object, estimated and contract values, dates, state. Date, state, keyword filters. LGPD-safe.", "version": "0.1", "x-build-id": "86OsQhx3UoeqBYTlz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/homelabmobile~brazil-pncp-tenders/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-homelabmobile-brazil-pncp-tenders", "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/homelabmobile~brazil-pncp-tenders/runs": { "post": { "operationId": "runs-sync-homelabmobile-brazil-pncp-tenders", "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/homelabmobile~brazil-pncp-tenders/run-sync": { "post": { "operationId": "run-sync-homelabmobile-brazil-pncp-tenders", "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": { "dataset": { "title": "What to fetch", "enum": [ "tenders", "contracts" ], "type": "string", "description": "\"tenders\" = procurement notices (licitações, dispensas, etc.) published on PNCP in the date window. \"contracts\" = signed contracts published in the date window, with supplier and value. Default: tenders.", "default": "tenders" }, "daysBack": { "title": "Days back", "minimum": 0, "maximum": 365, "type": "integer", "description": "Relative date window: records published from this many days before today (Brasília time) up to today. 0 = today only. Ignored when dateFrom is set. Example: 3.", "default": 3 }, "dateFrom": { "title": "Date from", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional explicit start of the publication date window, YYYY-MM-DD (e.g. 2026-10-01). Overrides daysBack." }, "dateTo": { "title": "Date to", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional explicit end of the publication date window, YYYY-MM-DD (e.g. 2026-10-07). Default: today (Brasília time). The window may span at most 365 days." }, "modalities": { "title": "Procurement modalities (tenders only)", "type": "array", "description": "PNCP modality codes to include when dataset is \"tenders\". The API pages each modality separately, so fewer codes = faster runs. Codes: 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, 7 Pregão presencial, 8 Dispensa de licitação, 9 Inexigibilidade, 10 Manifestação de interesse, 11 Pré-qualificação, 12 Credenciamento, 13 Leilão presencial. Default: [6, 4, 8, 9].", "items": { "type": "integer", "minimum": 1, "maximum": 14 }, "default": [ 6, 4, 8, 9 ] }, "state": { "title": "State (UF)", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Optional two-letter Brazilian state code of the buying body, e.g. SP, RJ, MG. Leave empty for the whole country. Tenders are filtered by the API; contracts are filtered after download (the contracts API has no state parameter, so state-filtered contract runs read more pages)." }, "keyword": { "title": "Keyword", "type": "string", "description": "Optional word or phrase that must appear in the object description or complementary information. Case- and accent-insensitive, e.g. \"computador\" or \"ambulância\". Several alternatives can be separated by | (e.g. \"notebook|computador\"). Filtering happens after download, so rare keywords read more pages." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many results. You are charged per result, so this caps the cost of a run.", "default": 100 }, "maxPages": { "title": "Maximum API pages", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Safety cap on PNCP API pages read in this run (each page is up to 50 records). Matters mainly with keyword or state filters on contracts. Default 200.", "default": 200 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }