https://github.com/perliedman/query-overpass

Make queries to OpenStreetMap's overpass API and output as GeoJSON
https://github.com/perliedman/query-overpass

Last synced: 9 days ago
JSON representation

Make queries to OpenStreetMap's overpass API and output as GeoJSON

• Host: GitHub
• URL: https://github.com/perliedman/query-overpass
• Owner: perliedman
• License: isc
• Created: 2014-07-25T06:09:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-03-28T09:28:59.000Z (over 1 year ago)
• Last Synced: 2024-04-14T09:40:40.189Z (7 months ago)
• Language: JavaScript
• Size: 148 KB
• Stars: 153
• Watchers: 12
• Forks: 34
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - perliedman/query-overpass - Make queries to OpenStreetMap's overpass API and output as GeoJSON (others)

README

        
[![Greenkeeper badge](https://badges.greenkeeper.io/perliedman/query-overpass.svg)](https://greenkeeper.io/)

# query-overpass [![NPM version](https://badge.fury.io/js/query-overpass.svg)](http://badge.fury.io/js/query-overpass) [![Build Status](https://travis-ci.org/perliedman/query-overpass.svg?branch=master)](https://travis-ci.org/perliedman/query-overpass)

Make queries to [OpenStreetMap](http://www.openstreetmap.org/)'s [overpass API](http://wiki.openstreetmap.org/wiki/Overpass_API) and output as [GeoJSON](http://geojson.org/).

## cli

install:

```bash

$ npm install -g query-overpass

```

use (Bash):

```bash

$ echo 'node(57.7,11.9,57.8,12.0)[amenity=bar];out;' | query-overpass

```

use (Windows cmd):

```bat

$ echo node(57.7,11.9,57.8,12.0)[amenity=bar];out; | query-overpass

```

Optionally, a file containing the query can be passed as the first argument:

```bash

$ query-overpass query.ql

```

Goes well together with other command line tools, like for example [geojsonio-cli](https://github.com/mapbox/geojsonio-cli):

```bash

$ npm install -g geojsonio-cli

$ echo 'node(57.7,11.9,57.8,12.0)[amenity=bar];out;' | query-overpass | geojsonio

```

You can also provide the URL where the Overpass API is located:

```bash

$ query-overpass --overpass-url http://my.overpass-provider.org/

```

The default is to use `https://overpass-api.de/api/interpreter`.

You can also flatten each GeoJSON feature, making it more easily processable by other software and tools

```bash

$ query-overpass --flat-properties

```

The default behaviour, without adding `--flat-properties` is to use `false` to be consistent with previous version.

## usage

Installation is easy with npm:

```bash

$ npm install query-overpass

```

## api

query-overpass exports a single function:

### query_overpass(query, callback, options)

Performs the provided query and calls the callback when done. The callback is of the form

```javascript

callback(error, data)

```

Where error is an object containing `message` and `statusCode` if an error occured, or `undefined` if

no error occured. `data` will be the query response as an GeoJSON object.

The options supported at the moment are

* `overpassUrl`, which will default to `'https://overpass-api.de/api/interpreter'` unless specified.

* `flatProperties` which will default to `false`.