{ "openapi": "3.0.1", "info": { "title": "PNCP Licitações Alerts: New Brazilian Tenders by UF", "description": "Get new Brazilian public procurement notices and licitações from PNCP (Portal Nacional de Contratações Públicas) by state (UF), modality or keyword, with a monitoring mode that only returns and bills for notices new since your last run.", "version": "1.0", "x-build-id": "aT9AMgeV0LFqUdy4e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~br-pncp-new-tender-alerts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-br-pncp-new-tender-alerts", "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/accountable_eel~br-pncp-new-tender-alerts/runs": { "post": { "operationId": "runs-sync-accountable_eel-br-pncp-new-tender-alerts", "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/accountable_eel~br-pncp-new-tender-alerts/run-sync": { "post": { "operationId": "run-sync-accountable_eel-br-pncp-new-tender-alerts", "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": { "states": { "title": "Brazilian States (UF)", "type": "array", "description": "One 2-letter Brazilian state code per line (e.g. SP, RJ, MG, RS, PR). Leave empty to search across all Brazilian states. Accepted formats: SP, RJ, MG. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "keywords": { "title": "Search keywords", "type": "array", "description": "Optional. Keywords or phrases matched against the tender description (objetoCompra) and buyer name (e.g. 'software', 'segurança', 'reforma'). Matched case-insensitively. Leave empty to return all notices.", "items": { "type": "string" } }, "modalidades": { "title": "Modalidades de contratação", "type": "array", "description": "One PNCP procurement modality code per run, as a list with a single number (only the first code is used; run again for another modality). Default is [6] (Pregão - Eletrônico). Other common modalities: 8 (Dispensa de Licitação), 4 (Concorrência - Eletrônica), 1 (Leilão - Eletrônico), 9 (Inexigibilidade)." }, "sinceDays": { "title": "Published in the last N days", "type": "integer", "description": "How far back to search by publication date (dataPublicacaoPncp). Default is 7 days.", "default": 7 }, "maxItems": { "title": "Max notices per run", "type": "integer", "description": "Maximum number of notices to return (up to 500). Caps how many notices you get and pay for in one run.", "default": 20 }, "onlyNewSinceLastRun": { "title": "Only return notices new since the last run (monitoring)", "type": "boolean", "description": "When checked, only notices with a PNCP control number not seen in previous runs are returned and billed. Perfect for scheduled alerts. Off: all matching notices are returned every time.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Optional. Name this search's monitoring memory so you can run multiple independent alerts. Leave empty to auto-derive from your search settings.", "default": "" }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "searchSummary", "truncated", "monitorStatus", "notices", "numeroControlePNCP", "title", "description", "buyerName", "buyerCnpj", "buyerUnit", "state", "municipality", "modalidade", "modalidadeId", "disputeMode", "documentType", "tenderStatus", "estimatedValueBrl", "publishedAt", "proposalOpeningAt", "proposalClosingAt", "legalFramework", "originSystemUrl", "noticeUrl", "isNew", "firstSeenAt" ], "enumTitles": [ "Search run", "More results available", "Monitoring status", "All notices", "PNCP Control Number", "Tender Title / Object", "Complementary Info", "Contracting Body", "Contracting Body CNPJ", "Administrative Unit", "State (UF)", "Municipality", "Modality", "Modality Code", "Dispute Mode", "Document Type", "Procurement Status", "Estimated Value (BRL)", "Published On", "Proposal Opening", "Submission Deadline", "Legal Framework", "Source Portal URL", "PNCP Notice URL", "Is New Since Last Run", "First Seen At" ] }, "default": [ "searchSummary", "truncated", "monitorStatus", "notices", "numeroControlePNCP", "title", "description", "buyerName", "buyerCnpj", "buyerUnit", "state", "municipality", "modalidade", "modalidadeId", "disputeMode", "documentType", "tenderStatus", "estimatedValueBrl", "publishedAt", "proposalOpeningAt", "proposalClosingAt", "legalFramework", "originSystemUrl", "noticeUrl", "isNew", "firstSeenAt" ] }, "expandRows": { "title": "One row per notice (recommended) — turn off for one row per search instead", "type": "boolean", "description": "When on, each notice found gets its own row instead of being grouped under its search. You're still only charged once per search, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 1, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 1 } } }, "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 } } } } } } } } } }