\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 OpenAddresses importer\n\n\n## Overview\n\nThe OpenAddresses importer is used to process data from [OpenAddresses](http://openaddresses.io/)\nfor import into the Pelias geocoder.\n\n## Requirements\n\nNode.js is required. See [Pelias software requirements](https://github.com/pelias/documentation/blob/master/requirements.md) for supported versions.\n\n## Installation\n\n> For instructions on setting up Pelias as a whole, see our [getting started guide](https://github.com/pelias/documentation/blob/master/getting_started_install.md). Further instructions here pertain to the OpenAddresses importer only\n\n```bash\ngit clone https://github.com/pelias/openaddresses\ncd openaddresses\nnpm install\n```\n\n## Data Download\nUse the `imports.openaddresses.files` configuration option to limit the download to just the OpenAddresses files of interest.\nRefer to the [OpenAddresses data listing]( http://results.openaddresses.io/?runs=all#runs) for file names.\n\n```bash\nnpm run download\n```\n\n## Usage\n```bash\n# show full command line options\nnode import.js --help\n\n# run an import\nnpm start\n```\n\n## Admin Lookup\nOpenAddresses records do not contain information about which city, state (or\nother region like province), or country that they belong to. Pelias has the\nability to compute these values from [Who's on First](http://whosonfirst.mapzen.com/) 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## Configuration\nThis importer can be configured in [pelias-config](https://github.com/pelias/config), in the `imports.openaddresses`\nhash. A sample configuration file might look like this:\n\n```javascript\n{\n \"esclient\": {\n \"hosts\": [\n {\n \"env\": \"development\",\n \"protocol\": \"http\",\n \"host\": \"localhost\",\n \"port\": 9200\n }\n ]\n },\n \"logger\": {\n \"level\": \"debug\"\n },\n \"imports\": {\n \"whosonfirst\": {\n \"datapath\": \"/mnt/data/whosonfirst/\",\n \"importPostalcodes\": false,\n \"importVenues\": false\n },\n \"openaddresses\": {\n \"datapath\": \"/mnt/data/openaddresses/\",\n \"files\": [ \"us/ny/city_of_new_york.csv\" ]\n }\n }\n}\n```\n\nThe following configuration options are supported by this importer.\n\n### `imports.openaddresses.datapath`\n\n* Required: yes\n* Default: ``\n\nThe absolute path to a directory where OpenAddresses data is located. The download command will also automatically place downloaded files in this directory.\n\n### `imports.openaddresses.files`\n\n* Required: no\n* Default: `[]`\n\nAn array of OpenAddresses files to be downloaded (full list can be found on the\n[OpenAddresses results site](http://results.openaddresses.io/?runs=all#runs)).\nIf no files are specified, the full planet data files (11GB+) will be\ndownloaded.\n\n### `imports.openaddresses.missingFilesAreFatal`\n\n* Required: no\n* Default: `false`\n\nIf set to true, any missing files will immediately halt the importer with an\nerror. Otherwise, the importer will continue processing with a warning. The\ndata downloader will also continue if any download errors were encountered with this set to false.\n\n### `imports.openaddresses.dataHost`\n\n* Required: no\n* Default: `https://data.openaddresses.io`\n\nThe location from which to download OpenAddresses data from. By default, the\nprimary OpenAddresses servers will be used. This can be overrriden to allow\ndownloading customized data. Paths are supported (for example,\n`https://yourhost.com/path/to/your/data`), but must not end with a trailing\nslash.\n\nS3 buckets are supported. Files will be downloaded using aws-cli.\n\nFor example: `s3://data.openaddresses.io`.\n\nNote: When using s3, you might need authentcation (IAM instance role, env vars, etc.)\n\n### `imports.openaddresses.s3Options`\n\n* Required: no\n\nIf `imports.openaddresses.dataHost` is an s3 bucket, this will add options to the command.\nFor example: `--profile my-profile`\n\nThis is useful, for example, when downloading from `s3://data.openaddresses.io`,\nas they require the requester to pay for data transfer.\nYou can then use the following option: `--request-payer`\n\n### `imports.openaddresses.token`\n* Required: no\n* Default: Shared token for the pelias project\n\nSince openaddresses moved from [results.openaddresses.io](https://results.openaddresses.io) to [batch.openaddresses.io](https://batch.openaddresses.io), you need a token to access the data. There is a default shared token for the Pelias project, but if you want to use it seriously, create your own account and token on [batch.openaddresses.io. ](https://batch.openaddresses.io) to avoid possible throttling/bandwidth limit or (temporary) suspension.\n\n\n## Parallel Importing\n\nBecause OpenAddresses consists of many small files, this importer can be configured to run several instances in parallel that coordinate to import all the data.\n\nTo use this functionality, replace calls to `npm start` with\n\n```bash\nnpm run parallel 3 # replace 3 with your desired level of paralellism\n```\n\nGenerally, a parallelism of 2 or 3 is suitable for most tasks.\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\")