{"id":19261148,"url":"https://github.com/ericklima-ca/get_geocode","last_synced_at":"2025-02-23T18:27:52.954Z","repository":{"id":62429793,"uuid":"419970400","full_name":"ericklima-ca/get_geocode","owner":"ericklima-ca","description":"API to get geodata from CEP (brazilian) or full address (Nominatim).","archived":false,"fork":false,"pushed_at":"2023-09-08T21:46:57.000Z","size":61,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T22:07:53.229Z","etag":null,"topics":["elixir","erlang-otp","geocode","geocoding-api"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/get_geocode/api-reference.html","language":"Elixir","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/ericklima-ca.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-22T04:54:46.000Z","updated_at":"2021-11-21T20:06:19.000Z","dependencies_parsed_at":"2024-11-09T19:26:25.894Z","dependency_job_id":"d64c2980-dbf5-4306-9ced-59fb549969b6","html_url":"https://github.com/ericklima-ca/get_geocode","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklima-ca%2Fget_geocode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklima-ca%2Fget_geocode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklima-ca%2Fget_geocode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklima-ca%2Fget_geocode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ericklima-ca","download_url":"https://codeload.github.com/ericklima-ca/get_geocode/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240358177,"owners_count":19788854,"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":["elixir","erlang-otp","geocode","geocoding-api"],"created_at":"2024-11-09T19:24:51.632Z","updated_at":"2025-02-23T18:27:52.922Z","avatar_url":"https://github.com/ericklima-ca.png","language":"Elixir","readme":"# GetGeocode\n\n![workflow](https://github.com/ericklima-ca/get_geocode/actions/workflows/elixir.yml/badge.svg)\n[![Hex.pm](https://img.shields.io/hexpm/v/get_geocode)](https://hex.pm/packages/get_geocode)\n\n## Installation\n\nThe package can be installed by adding `get_geocode` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:get_geocode, \"~\u003e 0.0.3\"}\n  ]\nend\n```\nThe docs can be found at [https://hexdocs.pm/get_geocode](https://hexdocs.pm/get_geocode).\n\n## Examples of usage\n\nThe main function is `GetGeocode.get/1`, and accepts full address, CEP (brazilian format)\nor coordinates in a tuple, lik `{lat, lng}`.\n\nThe result is a tuple with `{:ok, %GetGeocode.Geocode{}}`.\n\n### The `GetGeocode.Geocode` struct\n``` elixir\n%GetGeocode.Geocode{\ncity: nil,\ncoords: %GetGeocode.Coords{lat: nil, lng: nil},\nfull_details: nil,\nneighborhood: nil,\npostalcode: nil,\nstate: nil,\nstreet: nil\n}\n```\n\n----\nGetting data from **address**\n``` elixir\niex\u003e GetGeocode.get \"Avenida Torquato, Manaus\"\n{:ok,\n %GetGeocode.Geocode{\n   city: \"Manaus\",\n   coords: %GetGeocode.Coords{lat: \"-3.025279\", lng: \"-60.021089\"},\n   full_details: \"Avenida Torquato Tapajós, Colonia Terra Nova, Manaus, Região Geográfica Imediata de Manaus, Região Geográfica Intermediária de Manaus, Amazonas, Região Norte, 69000-000, Brasil\",\n   neighborhood: \"Colonia Terra Nova\",\n   postalcode: \"69000-000\",\n   state: \"Amazonas\",\n   street: \"Avenida Torquato Tapajós\"\n }}\n ```\n ----\n Getting data from **CEP**\n ``` elixir\n iex\u003e GetGeocode.get \"69035350\" \n{:ok,\n %GetGeocode.Geocode{\n   city: \"Manaus\",\n   coords: %GetGeocode.Coords{lat: \"-3.1037338\", lng: \"-60.0667086\"},\n   full_details: \"Avenida Coronel Cyrilo Neves, Compensa, Manaus, Região Geográfica Imediata de Manaus, Região Geográfica Intermediária de Manaus, Amazonas, Região Norte, 69000-000, Brasil\",\n   neighborhood: \"Compensa\",\n   postalcode: \"69035-350\",\n   state: \"AM\",\n   street: \"Avenida Coronel Cyrillo Neves\"\n }}\n ```\n----\nGetting data from **coordinates**\n\n``` elixir\niex\u003e GetGeocode.get {-3.1037338, -60.0667086}\n{:ok,\n %GetGeocode.Geocode{\n   city: \"Manaus\",\n   coords: %GetGeocode.Coords{lat: \"-3.1043466\", lng: \"-60.0672105\"},\n   full_details: \"Avenida Coronel Cyrilo Neves, Compensa, Manaus, Região Geográfica Imediata de Manaus, Região Geográfica Intermediária de Manaus, Amazonas, Região Norte, 69000-000, Brasil\",\n   neighborhood: \"Compensa\",\n   postalcode: \"69000-000\",\n   state: \"Amazonas\",\n   street: \"Avenida Coronel Cyrilo Neves\"\n }}\n ```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericklima-ca%2Fget_geocode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fericklima-ca%2Fget_geocode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericklima-ca%2Fget_geocode/lists"}