{"id":17682528,"url":"https://github.com/vinibrsl/viacep","last_synced_at":"2025-05-12T21:26:08.417Z","repository":{"id":43659231,"uuid":"130475812","full_name":"vinibrsl/viacep","owner":"vinibrsl","description":"🇧🇷 Dependency-less zipcode/CEP lookup gem for Brazilian addresses","archived":false,"fork":false,"pushed_at":"2023-08-30T08:58:11.000Z","size":47,"stargazers_count":18,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-12T05:08:50.146Z","etag":null,"topics":["brasil","cep","gem","ruby","viacep","zipcode-lookup-gem"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vinibrsl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-21T13:23:20.000Z","updated_at":"2025-03-17T06:11:31.000Z","dependencies_parsed_at":"2024-10-24T11:57:05.955Z","dependency_job_id":"2d5e3caa-6d56-4877-9c94-4ce219443425","html_url":"https://github.com/vinibrsl/viacep","commit_stats":null,"previous_names":["vnbrs/viacep"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinibrsl%2Fviacep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinibrsl%2Fviacep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinibrsl%2Fviacep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinibrsl%2Fviacep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vinibrsl","download_url":"https://codeload.github.com/vinibrsl/viacep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253824289,"owners_count":21969993,"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","cep","gem","ruby","viacep","zipcode-lookup-gem"],"created_at":"2024-10-24T09:22:26.382Z","updated_at":"2025-05-12T21:26:08.367Z","avatar_url":"https://github.com/vinibrsl.png","language":"Ruby","readme":"\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/bc/BRA_orthographic.svg/270px-BRA_orthographic.svg.png\" align=\"right\" /\u003e\n\n# viacep ![Tests](https://github.com/vnbrs/viacep/workflows/Tests/badge.svg) [![GitHub license](https://img.shields.io/github/license/vnbrs/burocracia.cr.svg)](https://github.com/vnbrs/burocracia.cr/blob/master/LICENSE)\n\u003e Dependency-less zipcode lookup gem for Brazilian addresses with an easy-to-use API and useful features such as timeout.\n\n## Installing\n\nYou can easily install viacep through [RubyGems](https://rubygems.org/gems/viacep/):\n\n```shell\ngem install viacep\n=\u003e Rock on! 🚀\n```\n\nor add the following to your Gemfile:\n\n```shell\ngem \"viacep\"\n```\n\n## Usage\n\n```ruby\nrequire 'viacep'\n\n# with unformatted zipcodes... =)\nViaCep::Address.new('80210130')\n=\u003e #\u003cViaCep::Address:0x00007fe52a8a0568 @cep=\"80210-130\", @address=\"Rua José Ananias Mauad\", @neighborhood=\"Jardim Botânico\", @city=\"Curitiba\", @state=\"PR\", @ibge=\"4106902\", @gia=\"\"\u003e\n\n# with formatted zipcodes... =)\nViaCep::Address.new('13035-680')\n=\u003e #\u003cViaCep::Address:0x00007fe52a99e730 @cep=\"13035-680\", @address=\"Avenida João Jorge\", @neighborhood=\"Vila Industrial\", @city=\"Campinas\", @state=\"SP\", @ibge=\"3509502\", @gia=\"2446\"\u003e\n\n# or even an nonexistent zipcode... =(\nViaCep::Address.new('12345678')\n=\u003e exception thrown: ViaCep::ApiRequestError\n\n# and specifying a timeout in seconds... =)\nViaCep::Address.new('80210130', timeout: 0.2)\n=\u003e exception thrown: Timeout::Error (execution expired)\n```\n\n## Docs\nThe documentation is available on [RubyDoc](https://www.rubydoc.info/gems/viacep). Starting on [`ViaCep::Address`](https://www.rubydoc.info/gems/viacep/ViaCep/Address) might be a good start.\n\n## Contributing\n\n1. Create a fork (https://github.com/vnbrs/viacep/fork)\n2. Create a branch (git checkout -b my-new-feature)\n3. Make a commit  (git commit -am 'Add some feature')\n4. Push your code (git push origin my-new-feature)\n5. Create a Pull Request\n6. Thanks! 🤙🏼\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinibrsl%2Fviacep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvinibrsl%2Fviacep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinibrsl%2Fviacep/lists"}