\n\nWhat is Pelias?\n \nPelias is a search engine for places worldwide, powered by open data. It turns addresses and place names into geographic coordinates, and turns geographic coordinates into places and addresses. With Pelias, you’re able to turn your users’ place searches into actionable geodata and transform your geodata into real places.\n
\nWe think open data, open source, and open strategy win over proprietary solutions at any part of the stack and we want to ensure the services we offer are in line with that vision. We believe that an open geocoder improves over the long-term only if the community can incorporate truly representative local knowledge.\n\n\n# Pelias Geonames importer\n\nThis Node.js package imports data from [Geonames](http://geonames.org/) into\n[Pelias](http://pelias.io). It includes utilities for downloading and cleaning up the data before\nimport.\n\n## Requirements\n\n- Node.js. See [Pelias Software requirements](https://github.com/pelias/documentation/blob/master/requirements.md) for supported versions.\n\n### Installation\n\n```bash\ngit clone https://github.com/pelias/geonames\ncd geonames\nnpm install\n```\n\n### Configuration\nThe importer can be configured from your local [pelias-config](https://github.com/pelias/config)\n(defaults to `~/pelias.json`) in the `imports.geonames` object:\n\n```json\n{\n\t\"imports\": {\n\t\t\"geonames\": {\n\t\t\t\"datapath\": \"/path/to/geonames/data\",\n\t\t\t\"countryCode\": \"MX\",\n\t\t\t\"sourceURL\": \"http://example.com/geonames/\"\n\t\t}\n\t}\n}\n```\n\nThe following are all *optional*:\n\n * `datapath`: the path to geonames data. Defaults to a directory inside the importer.\n * `countryCode`: the two digit ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1)) country code\n for the country for which data will be downloaded and imported. Use `ALL` for all countries.\n * `sourceURL`: allows for specification of an alternate url prefix for downloads.\n\t Will be appended with your specified countryCode and `.zip`.\n\t If the field is undefined or an empty string then the code defaults to the official Geonames dumps.\n\n#### Admin Lookup\nPelias has the ability to compute the admin hierarchy (county, region, country, etc)\nfrom [Who's on First](https://whosonfirst.org) data.\nFor more info on how admin lookup works, see the documentation for\n[pelias/wof-admin-lookup](https://github.com/pelias/wof-admin-lookup). By default,\nadminLookup is enabled. To disable, set `imports.adminLookup.enabled` to `false` in Pelias config.\n\n**Note:** Admin lookup requires loading around 5GB of data into memory.\n\n### Usage\n\nA list of supported countries and their codes can be viewed with `npm run countryCodes`\n\n```bash\n$> npm run countryCodes\n┌─────┬──────────────────────────────────────────────┬──────────────────────┬───────────┬───────────┐\n│ ISO │ Country │ Capital │ Continent │ geonameid │\n│ AD │ Andorra │ Andorra la Vella │ EU │ │\n│ AE │ United Arab Emirates │ Abu Dhabi │ AS │ 290557 │\n│ AF │ Afghanistan │ Kabul │ AS │ 1149361 │\n│ AG │ Antigua and Barbuda │ St. John's │ NA │ 3576396 │\n```\n\n#### Download the data\nThe data corresponding to the countryCode in the pelias config file will be downloaded.\n`npm run download`\n\n#### Import the downloaded data\n\n`npm start`\n\n### Updating Metadata\n\nThe metadata is not shipped with the repo, however, during normal usage running `npm install` will also trigger a script that updates the metadata.\n\n__However__ this hook will not trigger in non-interactive sessions such as many shell scripts. To explicitly download the metadata or refresh it (it changes very infrequently, perhaps every few months), run:\n\n```\nnpm run download_metadata\n```\n\nThe metadata _is_ packaged in our Docker images, so using an up to date docker image should guarantee recent enough metadata.\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/pelias/design/master/logo/pelias_github/Github_markdown_hero.png\"){kind=logo}
\n![](\"https://img.shields.io/github/license/pelias/api?style=flat&color=orange\")
![](\"https://img.shields.io/docker/pulls/pelias/api?style=flat&color=informational\")
![](\"https://img.shields.io/gitter/room/pelias/pelias?style=flat&color=yellow\")