{ "openapi": "3.0.1", "info": { "title": "Brazil Government Transparency - Public Spending", "description": "Extract Brazilian government data: public spending, contracts, agreements.", "version": "1.0", "x-build-id": "MSjqsfvGoaUxdvdgc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~brazil-government-transparency/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-brazil-government-transparency", "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/viralanalyzer~brazil-government-transparency/runs": { "post": { "operationId": "runs-sync-viralanalyzer-brazil-government-transparency", "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/viralanalyzer~brazil-government-transparency/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-brazil-government-transparency", "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", "required": [ "dataType" ], "properties": { "dataType": { "title": "Data Type", "enum": [ "contratacoes", "contratos", "atas", "despesas", "servidores", "licitacoes", "convenios", "sancoes" ], "type": "string", "description": "Type of government data to extract. PNCP types (no auth needed): contratacoes, contratos, atas. Portal da Transparência types (API key required): despesas, servidores, licitacoes, convenios, sancoes.", "default": "contratacoes" }, "dateFrom": { "title": "Date From", "type": "string", "description": "Start date for the query (format: YYYYMMDD for PNCP or DD/MM/YYYY for Portal). Example: 20260101", "default": "20260101" }, "dateTo": { "title": "Date To", "type": "string", "description": "End date for the query. Example: 20260215", "default": "20260215" }, "uf": { "title": "State (UF)", "type": "string", "description": "Filter by Brazilian state (2-letter code). Leave empty for all states. Example: SP, RJ, MG" }, "cnpj": { "title": "CNPJ", "type": "string", "description": "Filter by entity CNPJ (only digits). Example: 00394460000141" }, "codigoOrgao": { "title": "Agency Code", "type": "string", "description": "Filter by government agency code (used for Portal da Transparência endpoints like despesas, licitacoes, contratos). Example: 26000 (Ministério da Educação)" }, "keyword": { "title": "Keyword Search", "type": "string", "description": "Filter results containing this keyword in the object/description field. Applied client-side after fetching data." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of results to return (1–10000). Higher values use more compute time.", "default": 100 }, "apiKey": { "title": "Portal da Transparência API Key", "type": "string", "description": "API key for Portal da Transparência (required for despesas, servidores, licitacoes, convenios, sancoes). Get your free key at: https://portaldatransparencia.gov.br/api-de-dados/cadastrar-email" }, "ano": { "title": "Year", "minimum": 2000, "maximum": 2030, "type": "integer", "description": "Year filter (used for despesas, servidores). Example: 2025" }, "modalidade": { "title": "Procurement Modality", "type": "integer", "description": "Filter by procurement modality code (PNCP contratacoes). 1=Leilão, 2=Diálogo Competitivo, 3=Concurso, 4=Concorrência, 5=Tomada de Preços, 6=Pregão Eletrônico, 7=Pregão Presencial, 8=Dispensa, 9=Inexigibilidade, 12=Credenciamento, 13=Pré-qualificação" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy configuration for requests." } } }, "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 } } } } } } } } } }