{"id":13509456,"url":"https://github.com/prodis/correios-cep-elixir","last_synced_at":"2025-04-15T22:51:39.453Z","repository":{"id":57485800,"uuid":"157178828","full_name":"prodis/correios-cep-elixir","owner":"prodis","description":"Find Brazilian addresses by postal code, directly from Correios API. No HTML parsers.","archived":false,"fork":false,"pushed_at":"2020-10-03T16:54:15.000Z","size":104,"stargazers_count":38,"open_issues_count":4,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T02:12:21.041Z","etag":null,"topics":["cep","correios","correios-cep","elixir","elixir-lang","prodis","zipcode"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prodis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-12T08:16:38.000Z","updated_at":"2024-03-04T16:15:20.000Z","dependencies_parsed_at":"2022-09-11T14:40:56.852Z","dependency_job_id":null,"html_url":"https://github.com/prodis/correios-cep-elixir","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prodis%2Fcorreios-cep-elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prodis%2Fcorreios-cep-elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prodis%2Fcorreios-cep-elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prodis%2Fcorreios-cep-elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prodis","download_url":"https://codeload.github.com/prodis/correios-cep-elixir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248660095,"owners_count":21141240,"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":["cep","correios","correios-cep","elixir","elixir-lang","prodis","zipcode"],"created_at":"2024-08-01T02:01:08.021Z","updated_at":"2025-04-15T22:51:39.433Z","avatar_url":"https://github.com/prodis.png","language":"Elixir","funding_links":[],"categories":["Third Party APIs"],"sub_categories":[],"readme":"# Correios CEP\n\n[![Hex.pm](https://img.shields.io/hexpm/v/correios_cep.svg)](https://hex.pm/packages/correios_cep)\n[![Docs](https://img.shields.io/badge/hex-docs-542581.svg)](https://hexdocs.pm/correios_cep)\n[![Build Status](https://travis-ci.org/prodis/correios-cep-elixir.svg?branch=master)](https://travis-ci.org/prodis/correios-cep-elixir)\n[![Coverage Status](https://coveralls.io/repos/github/prodis/correios-cep-elixir/badge.svg?branch=master)](https://coveralls.io/github/prodis/correios-cep-elixir?branch=master)\n[![License](https://img.shields.io/hexpm/l/correios_cep.svg)](LICENSE)\n\n![Correios Logo](http://prodis.net.br/images/ruby/2015/correios_logo.png)\n\nFind Brazilian addresses by postal code, directly from Correios API. No HTML parsers.\n\n## DEPRECATION NOTE\n\n`Correios.CEP.Address.zipcode` was removed in the version `0.6.0`. Use `Correios.CEP.Address.postal_code` instead.\n\n## Installation\n\nThe package can be installed by adding `correios_cep` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:correios_cep, \"~\u003e 0.7.0\"}\n  ]\nend\n```\n\n## Usage\n\n```elixir\niex\u003e Correios.CEP.find_address(\"54250610\")\n{:ok,\n %Correios.CEP.Address{\n   street: \"Rua Fernando Amorim\",\n   neighborhood: \"Cavaleiro\",\n   complement: \"\",\n   city: \"Jaboatão dos Guararapes\",\n   state: \"PE\",\n   postal_code: \"54250610\"\n }}\n\niex\u003e Correios.CEP.find_address(\"00000-000\")\n{:error,\n %Correios.CEP.Error{\n   type: :postal_code_not_found,\n   message: \"Postal code not found\",\n   reason: \"CEP NAO ENCONTRADO\"\n }}\n\niex\u003e Correios.CEP.find_address!(\"54250-610\")\n%Correios.CEP.Address{\n  street: \"Rua Fernando Amorim\",\n  neighborhood: \"Cavaleiro\",\n  complement: \"\",\n  city: \"Jaboatão dos Guararapes\",\n  state: \"PE\",\n  postal_code: \"54250610\"\n}\n\niex\u003e Correios.CEP.find_address!(\"00000-000\")\n** (Correios.CEP.Error) Postal code not found\n```\n\n### Options\n\nThere are some supported options that can be added to the request, as timeouts, proxy and URL\nconfiguration.\n\nThe example below shows the use of `request_timeout` and `proxy` options:\n\n```elixir\niex\u003e Correios.CEP.find_address(\"54250610\", request_timeout: 3000, proxy: {\"localhost\", 8888})\n{:ok,\n %Correios.CEP.Address{\n   street: \"Rua Fernando Amorim\",\n   neighborhood: \"Cavaleiro\",\n   complement: \"\",\n   city: \"Jaboatão dos Guararapes\",\n   state: \"PE\",\n   postal_code: \"54250610\"\n }}\n```\n\nSee [`Correios.CEP.find_address/2`](https://hexdocs.pm/correios_cep/Correios.CEP.html#find_address/2)\ndocumentation to check the details of the available options.\n\n## Documentation\n\nThe full documentation is available at [https://hexdocs.pm/correios_cep](https://hexdocs.pm/correios_cep).\n\n## Contributing\n\nSee the [contributing guide](https://github.com/prodis/correios-cep-elixir/blob/master/CONTRIBUTING.md).\n\n## License\n\nCorreios CEP is released under the Apache 2.0 License. See the [LICENSE](https://github.com/prodis/correios-cep-elixir/blob/master/LICENSE) file.\n\nCopyright © 2018-2020 Fernando Hamasaki de Amorim\n\n## Author\n\n[Fernando Hamasaki de Amorim (prodis)](https://github.com/prodis)\n\n![Prodis Logo](https://camo.githubusercontent.com/c01a3ebca1c000d7586a998bb07316c8cb784ce5/687474703a2f2f70726f6469732e6e65742e62722f696d616765732f70726f6469735f3135302e676966)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprodis%2Fcorreios-cep-elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprodis%2Fcorreios-cep-elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprodis%2Fcorreios-cep-elixir/lists"}