{"id":27352617,"url":"https://github.com/augusto-herrmann/divulgacandcontas-doc","last_synced_at":"2025-04-12T20:59:40.743Z","repository":{"id":56508138,"uuid":"309258319","full_name":"augusto-herrmann/divulgacandcontas-doc","owner":"augusto-herrmann","description":"Documentação não oficial da API DivulgaCandContas do TSE","archived":false,"fork":false,"pushed_at":"2022-10-24T20:42:08.000Z","size":34,"stargazers_count":33,"open_issues_count":0,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-12T20:59:37.219Z","etag":null,"topics":["documentacao","eleicoes2020","rest-api","tse"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/augusto-herrmann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-02T04:33:10.000Z","updated_at":"2025-04-11T02:40:01.000Z","dependencies_parsed_at":"2022-08-15T20:01:02.764Z","dependency_job_id":null,"html_url":"https://github.com/augusto-herrmann/divulgacandcontas-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augusto-herrmann%2Fdivulgacandcontas-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augusto-herrmann%2Fdivulgacandcontas-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augusto-herrmann%2Fdivulgacandcontas-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augusto-herrmann%2Fdivulgacandcontas-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/augusto-herrmann","download_url":"https://codeload.github.com/augusto-herrmann/divulgacandcontas-doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631699,"owners_count":21136561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentacao","eleicoes2020","rest-api","tse"],"created_at":"2025-04-12T20:59:40.256Z","updated_at":"2025-04-12T20:59:40.736Z","avatar_url":"https://github.com/augusto-herrmann.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentação não oficial da API DivulgaCandContas\n\nO Tribunal Superior Eleitoral disponibiliza os dados sobre candidaturas em\neleições de três formas:\n\n1. Para consulta pela web, no sistema\n   [DivulgaCandContas](https://divulgacandcontas.tse.jus.br/divulga/);\n2. Para download, em arquivos CSV, pelo\n   [repositório de dados eleitorais](https://www.tse.jus.br/eleicoes/estatisticas/repositorio-de-dados-eleitorais-1/repositorio-de-dados-eleitorais);\n3. Por uma API do tipo REST.\n\nA API é usada pelo sistema que faz a consulta pela web. Entretanto, ela não\nestá documentada. Tentativas de obter a documentação oficial junto ao TSE não\nlograram êxito. Por isso, decidimos começar a criar uma documentação não\noficial para ajudar a quem mais esteja tentando utilizá-la.\n\n## Como usar\n\nPara usar a API, consulte a documentação no formato\n[OpenAPI 3.0.1](https://spec.openapis.org/oas/v3.0.1). Para mais informações\nsobre o padrão Open API, consulte o site [openapis.org]](https://www.openapis.org/).\n\nA documentação está no arquivo\n[divulgacandcontas-swagger.yaml](divulgacandcontas-swagger.yaml). Além disso,\no arquivo [divulgacandcontas.http](divulgacandcontas.http) possui alguns\nexemplos de consultas prontas para uso.\n\n**Mas atenção:** antes de usar a API, tome alguns cuidados:\n* confira se a sua necessidade de dados pode ser satisfeita pelos downloads\n  de dados disponíveis no\n  [repositório de dados eleitorais](https://www.tse.jus.br/eleicoes/estatisticas/repositorio-de-dados-eleitorais-1/repositorio-de-dados-eleitorais)\n  do TSE. Use a API apenas se os dados não estiverem disponíveis lá (por\n  exemplo, os planos de governo dos candidatos, como nos [exemplos](examples))\n  ou você está querendo informações atualizadas apenas por um recorte dos\n  dados (ex.: candidatos de um município específico).\n* Se decidir usar a API, coloque um intervalo de tempo entre as consultas,\n  para não sobrecarregar os servidores do TSE. Dessa maneira evitamos que ela\n  seja retirada do ar e reduz o risco do seu IP ser bloqueado na API.\n\n### Experimentando com chamadas à API\n\nPara experimentar com a definição da API no formato Open API, copie o conteúdo\ndo arquivo [divulgacandcontas-swagger.yaml](divulgacandcontas-swagger.yaml) e\ncole-o em [editor.swagger.io](https://editor.swagger.io/). Será criada uma\ninterface web para que você possa preencher os parâmetros e experimentar com\nas consultas.\n\nTodavia, a API do TSE possui um problema que impedirá as consultas de\nfuncionar pelo navegador: a API não suporta\n*[Cross Origin Resource Sharing](https://pt.wikipedia.org/wiki/Cross-origin_resource_sharing)*\n(CORS), o que faz com que o navegador bloqueie chamadas à API a partir de\noutros domínios (como o editor Swagger, por exemplo). Aparece a seguinte\nmensagem de erro:\n\n\u003e TypeError: NetworkError when attempting to fetch resource.\n\nUma possível solução, para quem usa Firefox, é instalar a extensão\n[CORS Everywhere](https://addons.mozilla.org/en-US/firefox/addon/cors-everywhere/)\ne configurar o \"*activation whitelist*\" para\n`/^https:\\/\\/editor(?:-next)?.swagger.io\\//i`.\nAtive a extensão na aba do editor de Swagger para que as chamadas à API passem\na funcionar no Firefox.\n\nVocê pode encontrar exemplos de scripts para acessar essa API no diretório\n[`examples`](examples/).\n\n## Como contribuir\n\nEssa documentação está em construção e contém apenas uma pequena fração do\nque está disponível na API. Caso você encontre alguma outra chamada à API que\nseja útil para você, não hesite em enviar o *pull request* com a sua\ncomplementação.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugusto-herrmann%2Fdivulgacandcontas-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faugusto-herrmann%2Fdivulgacandcontas-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugusto-herrmann%2Fdivulgacandcontas-doc/lists"}