Pelias API Server
This is the API server for the Pelias project. It's the service that runs to process user HTTP requests and return results as GeoJSON by querying Elasticsearch.
See the Mapzen Search documentation.
The API ships with several convenience commands (runnable via
npm start: start the server
npm test: run unit tests
npm run ciao: run functional tests (this requires that the server be running)
npm run docs: generate API documentation
npm run coverage: generate code coverage reports
install as a service
The bash script
pelias-api contains instructions to start the API as a linux service. It has to be cp to /etc/init.d/pelias-api before launching it like this :
service pelias-api start
The API recognizes the following properties under the top-level
api key in your
pelias.json config file:
accessLog: (optional) The name of the format to use for access logs; may be any one of the predefined values in the
morganpackage. Defaults to
"common"; if set to
false, or an otherwise falsy value, disables access-logging entirely.
textAnalyzer: The name of the text analyzer used to parse the search query. This version of the API is overridden to use
"libpostal", replacing Addressit parser.
Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests and script
fixtures in the
You can run the unit test suite using the command:
$ npm test
We have another set of tests which are used to test the HTTP API layer, these tests send expected HTTP requests and then assert that the responses coming back have the correct geoJSON format and HTTP status codes.
You can run the HTTP test suite using the command:
$ npm run ciao
Note: some of the tests in this suite fail when no data is present in the index, there is a small set of test documents
./test/ciao_test_data which can be inserted in order to avoid these errors.
To inject dummy data in to your local index:
$ node test/ciao_test_data.js
You can confirm the dummy data has been inserted with the command:
$ curl localhost:9200/pelias/_count?pretty