{
"openapi": "3.0.1",
"info": {
"title": "PNCP Brazil Public Procurement Scraper (Licitações)",
"description": "Search and monitor Brazilian public tenders (licitações) from PNCP, the official national procurement portal. Filter by keyword, state, city, agency, type and value.",
"version": "0.1",
"x-build-id": "dX7AyHO0oeHk4uebv"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/dados_publicos_br~pncp-licitacoes/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-dados_publicos_br-pncp-licitacoes",
"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/dados_publicos_br~pncp-licitacoes/runs": {
"post": {
"operationId": "runs-sync-dados_publicos_br-pncp-licitacoes",
"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/dados_publicos_br~pncp-licitacoes/run-sync": {
"post": {
"operationId": "run-sync-dados_publicos_br-pncp-licitacoes",
"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": {
"modo": {
"title": "Mode / Modo",
"enum": [
"abertas",
"publicadas"
],
"type": "string",
"description": "abertas: tenders currently accepting proposals, closing up to the end date.
publicadas: everything published in PNCP between the start and end dates (any status).",
"default": "abertas"
},
"palavrasChave": {
"title": "Keywords / Palavras-chave",
"type": "array",
"description": "Matched against the tender object (objeto). Accent- and case-insensitive. Leave empty to get everything.",
"items": {
"type": "string"
}
},
"modoPalavrasChave": {
"title": "Keyword match",
"enum": [
"any",
"all"
],
"type": "string",
"description": "How multiple keywords are combined.",
"default": "any"
},
"palavrasExcluidas": {
"title": "Excluded keywords / Palavras excluídas",
"type": "array",
"description": "Tenders whose object contains any of these are skipped (e.g. \"locação\", \"manutenção\").",
"items": {
"type": "string"
}
},
"ufs": {
"title": "States / UFs",
"type": "array",
"description": "Leave empty for the whole country.",
"items": {
"type": "string",
"enum": [
"AC",
"AL",
"AM",
"AP",
"BA",
"CE",
"DF",
"ES",
"GO",
"MA",
"MG",
"MS",
"MT",
"PA",
"PB",
"PE",
"PI",
"PR",
"RJ",
"RN",
"RO",
"RR",
"RS",
"SC",
"SE",
"SP",
"TO"
]
}
},
"modalidades": {
"title": "Procurement types / Modalidades",
"type": "array",
"description": "Leave empty for all types.",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19"
],
"enumTitles": [
"Leilão - Eletrônico",
"Diálogo Competitivo",
"Concurso",
"Concorrência - Eletrônica",
"Concorrência - Presencial",
"Pregão - Eletrônico",
"Pregão - Presencial",
"Dispensa",
"Inexigibilidade",
"Manifestação de Interesse",
"Pré-qualificação",
"Credenciamento",
"Leilão - Presencial",
"Inaplicabilidade da Licitação",
"Chamada pública",
"Concorrência - Eletrônica Internacional",
"Concorrência - Presencial Internacional",
"Pregão - Eletrônico Internacional",
"Pregão - Presencial Internacional"
]
}
},
"dataInicial": {
"title": "Start date / Data inicial",
"type": "string",
"description": "Only for mode publicadas. Default: yesterday. Ranges longer than 365 days are split automatically."
},
"dataFinal": {
"title": "End date / Data final",
"type": "string",
"description": "abertas: proposals closing up to this date (default: today + 30 days).
publicadas: published up to this date (default: today)."
},
"valorMinimo": {
"title": "Minimum estimated value (BRL)",
"minimum": 0,
"type": "integer",
"description": "Skips tenders with a lower or unknown estimated value."
},
"valorMaximo": {
"title": "Maximum estimated value (BRL)",
"minimum": 0,
"type": "integer",
"description": "Skips tenders with a higher estimated value."
},
"codigoMunicipioIbge": {
"title": "City IBGE code / Código IBGE do município",
"type": "string",
"description": "7-digit IBGE code, e.g. 3550308 for São Paulo."
},
"cnpjOrgao": {
"title": "Agency CNPJ / CNPJ do órgão",
"type": "string",
"description": "Only tenders from this public body."
},
"incluirCanceladas": {
"title": "Include cancelled / Incluir canceladas",
"type": "boolean",
"description": "Include tenders that were revoked, annulled or suspended (revogadas, anuladas, suspensas). Off by default.",
"default": false
},
"maxResultados": {
"title": "Max results",
"minimum": 1,
"type": "integer",
"description": "Stops after this many tenders. You are only charged for results delivered.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}