{ "openapi": "3.0.1", "info": { "title": "PNCP Brazil Tender Scraper", "description": "Extract Brazilian public procurement notices from the Portal Nacional de Contratacoes Publicas: PNCP control number, purchase object, contracting body, modality, dispute mode, estimated value. Export data, run via API, schedule and monitor runs, or integrate with other tools.", "version": "0.0", "x-build-id": "K2RCi2sG6BkxPPFHW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/publicmoney~pncp-brazil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-publicmoney-pncp-brazil-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/publicmoney~pncp-brazil-scraper/runs": { "post": { "operationId": "runs-sync-publicmoney-pncp-brazil-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/publicmoney~pncp-brazil-scraper/run-sync": { "post": { "operationId": "run-sync-publicmoney-pncp-brazil-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": { "mode": { "title": "🏷️ Mode", "enum": [ "open", "published" ], "type": "string", "description": "open = tenders whose proposal window is still open. published = everything published in the date window (PNCP requires a modality code per request in this mode). Examples: 'open', 'published'.", "default": "open" }, "publishedWithinDays": { "title": "📅 Published within (days)", "minimum": 1, "type": "integer", "description": "Return notices published in the last N days. Ignored when Published from is set. Examples: 1, 7, 28. Default is 7.", "default": 7 }, "publishedFrom": { "title": "📅 Published from", "type": "string", "description": "Date in YYYY-MM-DD form. Overrides Published within. Examples: '2024-08-20', '2024-08-21'." }, "publishedTo": { "title": "📅 Published to", "type": "string", "description": "Date in YYYY-MM-DD form. Leave empty for today. Examples: '2024-08-20', '2024-08-21'." }, "modalities": { "title": "🏷️ Modality codes", "type": "array", "description": "PNCP modalidade codes, numeric. Published mode needs one request per code, so leaving this empty walks codes 1 to 13. Each item carries its own modality name in the output (for example 12 = Credenciamento).", "default": [], "items": { "type": "string" } }, "keyword": { "title": "🔍 Keyword", "type": "string", "description": "Client-side filter on purchase object, body name and process number. Examples: 'Credenciamento', 'infectologista'." }, "maxItems": { "title": "🔢 Max items", "minimum": 0, "type": "integer", "description": "Maximum number of notices to return. 0 returns everything matched. Examples: 1, 500, 2000. Default is 500.", "default": 500 }, "schemaOrg": { "title": "🔗 Add schema.org block", "type": "boolean", "description": "Appends a `schemaOrg` object to the end of every record, mapping it to schema.org (Demand for tenders, MonetaryGrant for grants, Invoice for payments). The record's own fields are not changed. Off by default. Charged once per run, not per record.", "default": false } } }, "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 } } } } } } } } } }