{ "openapi": "3.0.1", "info": { "title": "Brazil Elections — TSE Candidatos e Bens (1994–2024)", "description": "Histórico eleitoral do Brasil de 1994 a 2024. 2,9M candidatos, 5M registros de bens, 16 eleições. Consulte por nome, partido, município, estado ou ranking.\n\n\nBrazilian electoral history from 1994 to 2024. Query by name, party, municipality, state or ranking.", "version": "1.0", "x-build-id": "aYbzlxYvPhxLOtuNP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jenko_systems~brazil-elections-tse/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jenko_systems-brazil-elections-tse", "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/jenko_systems~brazil-elections-tse/runs": { "post": { "operationId": "runs-sync-jenko_systems-brazil-elections-tse", "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/jenko_systems~brazil-elections-tse/run-sync": { "post": { "operationId": "run-sync-jenko_systems-brazil-elections-tse", "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": [ "mode" ], "properties": { "mode": { "title": "Query mode", "enum": [ "candidato", "partido", "municipio", "estado", "bens", "ranking", "estatisticas" ], "type": "string", "description": "Choose the query mode. Each mode returns different data about Brazilian elections.", "default": "ranking" }, "ano": { "title": "Election year", "minimum": 1994, "maximum": 2026, "type": "integer", "description": "Election year. Municipal: 1996,2000,2004,2008,2012,2016,2020,2024. General: 1994,1998,2002,2006,2010,2014,2018,2022.", "default": 2024 }, "nome": { "title": "Candidate name", "type": "string", "description": "Partial name search. Ex: Lula, Bolsonaro, Maria Silva." }, "partido": { "title": "Party (sigla)", "type": "string", "description": "Ex: PT, PL, MDB, PSDB, PP, PSD, UNIÃO." }, "municipio": { "title": "Municipality", "type": "string", "description": "Partial name search. Ex: São Paulo, Campinas, Fortaleza." }, "uf": { "title": "State (UF)", "type": "string", "description": "Ex: SP, MG, RJ, BA, RS, PR." }, "cargo": { "title": "Office / Cargo", "type": "string", "description": "Ex: PREFEITO, VEREADOR, GOVERNADOR, SENADOR, DEPUTADO FEDERAL." }, "situacao": { "title": "Election result", "type": "string", "description": "Ex: ELEITO, NÃO ELEITO, SUPLENTE." }, "tipo_ranking": { "title": "Ranking type", "enum": [ "mais_ricos", "eleitos_por_partido", "candidatos_por_partido" ], "type": "string", "description": "Type of ranking to generate.", "default": "mais_ricos" }, "top_n": { "title": "Top N results (rankings)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of results to return in ranking mode.", "default": 20 }, "max_resultados": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of results to return.", "default": 100 } } }, "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 } } } } } } } } } }