\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 Point-in-Polygon Service\n\n## Overview\n\nThis service provides Who's on First-based point-in-polygon lookup functionality.\n\n## Requirements\n\nNode.js is required.\n\nSee [Pelias software requirements](https://github.com/pelias/documentation/blob/master/requirements.md) for required and recommended versions.\n\n## Installation\n\n```bash\n$ git clone git@github.com:pelias/pip-service.git\n$ cd pip-service\n$ npm install\n```\n\n[](https://nodei.co/npm/pelias-pip-service)\n\n## NPM Module\n\nThe `pelias-pip-service` npm module can be found here:\n\n[https://npmjs.org/package/pelias-pip-service](https://npmjs.org/package/pelias-pip-service)\n\n#### Usage\n\nTo start the PiP service, use the start script `./bin/start`, or use `npm start`.\n\nIt will look for Who's on First data in the place configured in `pelias.json`.\n\nRequests are made to the endpoint in the format: `http://localhost:3102//`.\n\nFor example: `http://localhost:3102/-106.937/34.060`\n\n#### Downloading data\n\nBecause [pelias/whosonfirst](https://github.com/pelias/whosonfirst) is a dependency of this package, its downloader can be used:\n\n`npm run download`\n\nThis will download Who's on First data using the same [configuration options](https://github.com/pelias/whosonfirst#downloading-the-data) from `pelias.json` as the whosonfirst downloader.\nThat means it will automatically put the data in the place the service will expect to load it from.\n\n##### Privacy Concerns\n\nThe service supports the [DNT](https://en.wikipedia.org/wiki/Do_Not_Track) header by looking for one of the following headers:\n\n- `DNT`\n- `dnt`\n- `do_not_track`\n\nWhen any of these headers are supplied in the request (with any value), the request log will output `/[removed]/[removed]` instead of the longitude/latitude values.\n\n#### Configuration via Environment Variables\n\nThe service supports additional environment variables that affect its operation:\n\n| Environment Variable | Default | Description |\n| -------------------- | ------- | ----------- |\n| `HOST` | `undefined` | The network address that the PiP service will bind to. Defaults to whatever the current Node.js default is, which is currently to listen on `0.0.0.0` (all interfaces). See the [Node.js Net documentation](https://nodejs.org/api/net.html#net_server_listen_port_host_backlog_callback) for more information. |\n| `PORT` | `3102` | The TCP port that the PiP service will use for incoming network connections |\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/pelias/design/master/logo/pelias_github/Github_markdown_hero.png\"){kind=logo}
\n![](\"https://github.com/pelias/pip-service/workflows/Continuous%20Integration/badge.svg\"){kind=icon}
\n![](\"https://img.shields.io/github/license/pelias/pip-service?style=flat&color=orange\")
![](\"https://img.shields.io/docker/pulls/pelias/pip-service?style=flat&color=informational\")
![](\"https://img.shields.io/gitter/room/pelias/pelias?style=flat&color=yellow\")