{"id":15510632,"url":"https://github.com/kortirso/open_street_map","last_synced_at":"2025-04-12T12:44:47.657Z","repository":{"id":62430197,"uuid":"150890675","full_name":"kortirso/open_street_map","owner":"kortirso","description":"Elixir package for OpenStreetMap API integration","archived":false,"fork":false,"pushed_at":"2024-06-05T03:49:26.000Z","size":39,"stargazers_count":17,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T16:55:58.187Z","etag":null,"topics":["elixir","elixir-library","geocoding","openstreetmap","openstreetmap-api"],"latest_commit_sha":null,"homepage":null,"language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kortirso.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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-09-29T18:10:22.000Z","updated_at":"2024-06-05T03:49:29.000Z","dependencies_parsed_at":"2024-06-04T18:37:01.716Z","dependency_job_id":"e7ed38b8-ebf8-4cae-8f13-c1a201d8c31b","html_url":"https://github.com/kortirso/open_street_map","commit_stats":{"total_commits":36,"total_committers":5,"mean_commits":7.2,"dds":"0.11111111111111116","last_synced_commit":"f7728ed0844349510d148331190539c34b1f4814"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fopen_street_map","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fopen_street_map/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fopen_street_map/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fopen_street_map/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kortirso","download_url":"https://codeload.github.com/kortirso/open_street_map/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248570296,"owners_count":21126401,"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","elixir-library","geocoding","openstreetmap","openstreetmap-api"],"created_at":"2024-10-02T09:49:59.209Z","updated_at":"2025-04-12T12:44:47.633Z","avatar_url":"https://github.com/kortirso.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenStreetMap\n\nIntegration of OpenStreetMap api from [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim)\n\n## Installation\n\nIf [available in Hex](https://hex.pm/docs/publish), the package can be installed\nby adding `open_street_map` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:open_street_map, \"0.9.10\"}\n  ]\nend\n```\n\n## Usage\n\n### Search\n\nRequest for search objects is #search.\n\n```elixir\n  OpenStreetMap.search([q: \"135 pilkington avenue, birmingham\", format: \"json\", addressdetails: \"1\", accept_language: \"en\"])\n```\n    q - query, required\n    format - one of the [xml|json|jsonv2], default - xml\n    viewbox - The preferred area to find search results like \u003cx1\u003e,\u003cy1\u003e,\u003cx2\u003e,\u003cy2\u003e\n    bounded - Restrict the results to only items contained with the viewbox, one of the [0|1]\n    addressdetails - Include a breakdown of the address into elements, one of the [0|1]\n    exclude_place_ids - If you do not want certain openstreetmap objects to appear in the search result, give a comma separated list of the place_id's you want to skip\n    limit - Limit the number of returned results, integer\n    extratags - Include additional information in the result if available, one of the [0|1]\n    namedetails - Include a list of alternative names in the results, one of the [0|1]\n    accept_language - Preferred language order for showing search results, default - en\n    email - If you are making large numbers of request please include a valid email address\n    hostname - allow overwriting the host name for users who have their own Nominatim installation, default - https://nominatim.openstreetmap.org/\n    user_agent - User-Agent identifying the application, default - hex/open_street_map/random\n\n#### Responces\n\n```elixir\n  {:ok,\n    [\n      %{\n        \"address\" =\u003e %{\n          \"city\" =\u003e \"Birmingham\",\n          \"country\" =\u003e \"United Kingdom\",\n          \"country_code\" =\u003e \"gb\",\n          \"county\" =\u003e \"West Midlands Combined Authority\",\n          \"house_number\" =\u003e \"135\",\n          \"postcode\" =\u003e \"B72 1LH\",\n          \"road\" =\u003e \"Pilkington Avenue\",\n          \"state\" =\u003e \"England\",\n          \"state_district\" =\u003e \"West Midlands\",\n          \"town\" =\u003e \"Sutton Coldfield\"\n        },\n        \"boundingbox\" =\u003e [\"52.5487473\", \"52.5488481\", \"-1.816513\", \"-1.8163464\"],\n        \"class\" =\u003e \"building\",\n        \"display_name\" =\u003e \"135, Pilkington Avenue, Sutton Coldfield, Birmingham, West Midlands Combined Authority, West Midlands, England, B72 1LH, United Kingdom\",\n        \"importance\" =\u003e 0.411,\n        \"lat\" =\u003e \"52.5487921\",\n        \"licence\" =\u003e \"Data © OpenStreetMap contributors, ODbL 1.0. https://osm.org/copyright\",\n        \"lon\" =\u003e \"-1.8164308339635\",\n        \"osm_id\" =\u003e \"90394480\",\n        \"osm_type\" =\u003e \"way\",\n        \"place_id\" =\u003e \"95707153\",\n        \"type\" =\u003e \"yes\"\n      }\n    ]\n  }\n```\n\n### Reverse\n\nRequest for objects by coordinates is #reverse.\n\n```elixir\n  OpenStreetMap.reverse([format: \"json\", lat: \"52.594417\", lon: \"39.493115\", accept_language: \"en\"])\n```\n    lat - Latitude, required\n    lon - Longitude, required\n    format - one of the [xml|json|jsonv2], default - xml\n    zoom - Level of detail required where 0 is country and 18 is house/building, one of the [0-18]\n    addressdetails - Include a breakdown of the address into elements, one of the [0|1]\n    extratags - Include additional information in the result if available, one of the [0|1]\n    namedetails - Include a list of alternative names in the results, one of the [0|1]\n    accept_language - Preferred language order for showing search results, default - en\n    email - If you are making large numbers of request please include a valid email address\n    hostname - allow overwriting the host name for users who have their own Nominatim installation, default - https://nominatim.openstreetmap.org/\n    user_agent - User-Agent identifying the application, default - hex/open_street_map/random\n\n#### Responces\n\n```elixir\n  {:ok,\n    %{\n      \"address\" =\u003e %{\n        \"city\" =\u003e \"Lipetsk\",\n        \"city_district\" =\u003e \"Советский округ\",\n        \"country\" =\u003e \"Russia\",\n        \"country_code\" =\u003e \"ru\",\n        \"house_number\" =\u003e \"4\",\n        \"postcode\" =\u003e \"398000\",\n        \"residential\" =\u003e \"микрорайон Елецкий\",\n        \"road\" =\u003e \"улица Хренникова\",\n        \"state\" =\u003e \"Lipetsk Oblast\",\n        \"suburb\" =\u003e \"Lipetsk\"\n      },\n      \"boundingbox\" =\u003e [\"52.5943024\", \"52.5946223\", \"39.4929211\", \"39.4933486\"],\n      \"display_name\" =\u003e \"4, улица Хренникова, микрорайон Елецкий, Сырский рудник, Советский округ, Lipetsk, Lipetsk Oblast, Central Federal District, 398000, Russia\",\n      \"lat\" =\u003e \"52.5944624\",\n      \"licence\" =\u003e \"Data © OpenStreetMap contributors, ODbL 1.0. https://osm.org/copyright\",\n      \"lon\" =\u003e \"39.4931348495468\",\n      \"osm_id\" =\u003e \"367091730\",\n      \"osm_type\" =\u003e \"way\",\n      \"place_id\" =\u003e \"157477838\"\n    }\n  }\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/kortirso/open_street_map.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n## Disclaimer\n\nUse this package at your own peril and risk, the author tried to simplify the use of [Nominatim service](https://wiki.openstreetmap.org/wiki/Nominatim) for integration into Phoenix web applications.\n\n## Documentation\n\nDocumentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)\nand published on [HexDocs](https://hexdocs.pm). Once published, the docs can\nbe found at [https://hexdocs.pm/open_street_map](https://hexdocs.pm/open_street_map).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkortirso%2Fopen_street_map","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkortirso%2Fopen_street_map","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkortirso%2Fopen_street_map/lists"}