{"id":16276595,"url":"https://github.com/robertmyles/cepr","last_synced_at":"2025-03-20T01:32:16.936Z","repository":{"id":56936036,"uuid":"96032360","full_name":"RobertMyles/cepR","owner":"RobertMyles","description":"Um pacote R para buscar informações sobre CEPs, endereços, bairros e cidades. (An R package for accessing Brazilian postal code data) :email:","archived":false,"fork":false,"pushed_at":"2020-09-19T10:19:12.000Z","size":2518,"stargazers_count":28,"open_issues_count":2,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-06-11T19:12:12.237Z","etag":null,"topics":["brasil","buscacep","cep","postcodes","r"],"latest_commit_sha":null,"homepage":"https://robertmyles.github.io/cepR/.","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RobertMyles.png","metadata":{"files":{"readme":"README.Rmd","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":"2017-07-02T15:32:11.000Z","updated_at":"2023-08-01T22:52:27.000Z","dependencies_parsed_at":"2022-08-21T06:20:38.234Z","dependency_job_id":null,"html_url":"https://github.com/RobertMyles/cepR","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/RobertMyles%2FcepR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobertMyles%2FcepR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobertMyles%2FcepR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobertMyles%2FcepR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RobertMyles","download_url":"https://codeload.github.com/RobertMyles/cepR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219865980,"owners_count":16555922,"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":["brasil","buscacep","cep","postcodes","r"],"created_at":"2024-10-10T18:49:16.853Z","updated_at":"2024-10-10T18:49:17.397Z","avatar_url":"https://github.com/RobertMyles.png","language":"R","readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\"\n)\n```\n\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/cepR)](https://cran.r-project.org/package=cepR)\n[![CRAN_Download_Badge](http://cranlogs.r-pkg.org/badges/cepR)](https://CRAN.R-project.org/package=cepR)\n[![CRAN_Download_Badge](http://cranlogs.r-pkg.org/badges/grand-total/cepR)](https://CRAN.R-project.org/package=cepR)\n![R-CMD-check](https://github.com/RobertMyles/cepR/workflows/R/badge.svg)\n\n# cepR `r emo::ji(\"brazil\")`   \n\u003ca href=#uk\u003e(English below)\u003c/a\u003e\n\n**cepR** é um pacote para [R](https://www.r-project.org/) que acessa dados postais do Brasil tais como nomes de bairros, cidades, estados, logradouros, CEPs e outras informações de interesse como altitude, longitude e latitude. Os dados são do projeto [CEPaberto](https://cepaberto.com/) e para utilizar este pacote é preciso se cadastrar no site do [CEPaberto](https://cepaberto.com/users/register) e obter um *token* pessoal. Você pode contribuir para o projeto CEPaberto clicando na aba [\"Colaborar\"](https://cepaberto.com/ceps) do site. Para instalar o **cepR** é só seguir as instruções abaixo. Um banco de dados com endereços postais do estado de São Paulo está incluído no pacote e pode ser acessado com `data(\"sp\")`. Sugestões, *pull requests* e comentários são muito bem-vindos!\n\n## Instalação\n\nCRAN:\n```{r, eval = F}\ninstall.packages(\"cepR\")\n```\n\nGitHub:  \n```{r gh-installation, eval = FALSE}\n# install.packages(\"remotes\")\nremotes::install_github(\"RobertMyles/cepR\")\n```\n\n## Uso\n\nÉ possível buscar os nomes das cidades e municipios com `busca_estado()` \n\n```{r example, eval = FALSE}\nlibrary(cepR)\ntoken \u003c- \"XXXXXXXXXXX\" # seu token\nsp \u003c- busca_estado(estado = \"SP\", token = token)\n\nsp\n# A tibble: 863 x 2\n   estado                  municipio\n    \u003cchr\u003e                      \u003cchr\u003e\n 1     SP                 Adamantina\n 2     SP                     Adolfo\n 3     SP         Agisse (Rancharia)\n 4     SP                      Aguaí\n 5     SP             Águas da Prata\n 6     SP           Águas de Lindóia\n 7     SP     Águas de Santa Bárbara\n 8     SP         Águas de São Pedro\n 9     SP Água Vermelha (São Carlos)\n10     SP                     Agudos\n# ... with 853 more rows\n```\n\nPode-se também buscar os endereços por CEP. Por exemplo, o valor *default* do CEP é o da Praça da Sé:  \n\n```{r, eval = F}\n\u003e busca_cep(token = token)\n\n# A tibble: 1 x 10\n  estado    cidade bairro      cep              logradouro       latitude\n   \u003cchr\u003e     \u003cchr\u003e  \u003cchr\u003e    \u003cchr\u003e                   \u003cchr\u003e          \u003cchr\u003e\n1     SP São Paulo     Sé 01001000 Praça da Sé, lado ímpar -23.5479099981\n# ... with 4 more variables: longitude \u003cchr\u003e, altitude \u003cchr\u003e, ddd \u003cchr\u003e,\n#   cod_IBGE \u003cchr\u003e\n```\n\nTambém é possível buscar por múltiplos CEPs. É **importante** atentar para o limite de 1 pesquisa por segundo por token, portanto pesquisas com muitos itens podem demorar bastante. O valor *default* dos CEPs da função busca_multi são ambos na Praça da Sé: \n\n```{r, eval = FALSE}\n\u003e busca_multi(token = token)\n# A tibble: 2 x 10\n  estado cidade    bairro cep      logradouro  latitude longitude altitude   ddd cod_IBGE\n  \u003cchr\u003e  \u003cchr\u003e     \u003cchr\u003e  \u003cchr\u003e    \u003cchr\u003e          \u003cdbl\u003e     \u003cdbl\u003e    \u003cdbl\u003e \u003cdbl\u003e \u003cchr\u003e   \n1 SP     São Paulo Sé     01001000 Praça da Sé    -23.5     -46.6      760    11 3550308 \n2 SP     São Paulo Sé     01001001 Praça da Sé    -23.5     -46.6      760    11 3550308 \n```\n\n\nPara mais, veja o projeto CEPAberto.\n\n# \u003ca name=\"uk\"\u003ecepR\u003c/a\u003e  `r emo::ji(\"uk\")`  \n\n**cepR** is a package for accessing Brazilian address data: neighbourhood names, city and state names, actual addresses, postal codes, and other info such as altitude, longitude \u0026 latitude. The data come from the [CEPaberto](https://cepaberto.com/) project, and to use the package, you'll need a personal access token from the CEP Aberto site. Suggestions, pull requests, criticisms all welcome. You can install the package as shown in *Instalação* above. If you use it regularly, please consider donating to the CEPAberto project.\n\nThe package is aimed at a Brazilian audience, so if you don't speak Portuguese:  \n\n- bairro = neighbourhood;\n- cep = postal code;\n- logadouro = address;\n- município = municipality.   \n\nThe others aren't too hard to figure out `r emo::ji(\"monkey_face\")`. \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertmyles%2Fcepr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertmyles%2Fcepr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertmyles%2Fcepr/lists"}