\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 Model\n\nThis package stores a definition of our standard data model. It allows for a common format for geographic records across multiple databases and other packages.\n\n## Installation\n\n```bash\n$ npm install pelias-model\n```\n\n## Document\n\nThe `Document` model is a convenient way of modelling POI and admin records so that they are compatible with the Pelias import pipeline.\n\nUsing this model ensures that your import script will continue to work even when the underlying schema changes.\n\n```javascript\nvar Document = require('pelias-model').Document;\n\nvar poi = new Document( 'geoname', 'venue', 1003 )\n .setMeta( 'author', 'peter' )\n .setName( 'default', 'Hackney City Farm' )\n .setName( 'alt', 'Haggerston City Farm' )\n .setNameAlias( 'alt', 'Haggerston Farm' )\n .addParent( 'country', 'Great Britain', '1001', 'GreatB' )\n .addParent( 'neighbourhood', 'Shoreditch', '2002' )\n .setAddress( 'number', '10' )\n .setAddress( 'street', 'pelias place' )\n .setAddressAlias( 'street', 'pelias pl' )\n .addCategory( 'foo' )\n .addCategory( 'bar' )\n .removeCategory( 'foo' )\n .setPopulation(10)\n .setPopularity(3)\n .setAddendum('wikipedia', { slug: 'HackneyCityFarm' })\n .setAddendum('geonames', { foreignkey: 1 })\n .setCentroid({ lon: 0.5, lat: 50.1 })\n .setShape( geojsonObject /* any valid geojson object */ )\n .setBoundingBox( bboxObject /* see tests for bbox syntax */ );\n\nconsole.log( poi );\n```\n\n**Note** the `_meta` property is unenumerable, so you won't see it when you `console.log` or `JSON.stringify` the object, don't worry it's still there:\n\n```javascript\nvar poi = new Document( 'geoname', 'venue', 1003 );\npoi.setMeta( 'author', 'mapzen' );\n\nconsole.log( poi, poi.getMeta( 'author' ), poi._meta );\n```\n\n## NPM Module\n\nThe `pelias-model` npm module can be found here:\n\n[https://npmjs.org/package/pelias-model](https://npmjs.org/package/pelias-model)\n\n## Contributing\n\nPlease fork and pull request against upstream master on a feature branch.\n\nPretty please; provide unit tests and script fixtures in the `test` directory.\n\n### Running Unit Tests\n\n```bash\n$ npm test\n```\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\")