Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/query-overpass
Query the OpenStreetMap Overpass API.
https://github.com/derhuerst/query-overpass
api openstreetmap osm overpass
Last synced: 2 months ago
JSON representation
Query the OpenStreetMap Overpass API.
- Host: GitHub
- URL: https://github.com/derhuerst/query-overpass
- Owner: derhuerst
- License: isc
- Created: 2017-07-25T12:27:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-03T19:46:11.000Z (over 2 years ago)
- Last Synced: 2024-10-14T01:32:28.958Z (2 months ago)
- Topics: api, openstreetmap, osm, overpass
- Language: JavaScript
- Homepage: https://github.com/derhuerst/query-overpass
- Size: 23.4 KB
- Stars: 21
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# query-overpass
**Query the [OpenStreetMap](https://www.openstreetmap.org/) [Overpass](https://overpass-api.de) API.** Yet another implementation, because it
- is isomorphic (works in the browser)
- is lightweight (doesn't contain any sophisticated parser)
- uses [`p-retry`](https://github.com/sindresorhus/p-retry) to resend requests
Other alternatives for you to evaluate:
- [`query-overpass`](https://github.com/perliedman/query-overpass) and a fork [`@sriharithalla/query-overpass`](https://github.com/SrihariThalla/query-overpass)
- [`idris-overpass`](https://github.com/idris-maps/idris-overpass) and [`idris-overpass-browser`](https://github.com/idris-maps/idris-overpass-browser)
[](https://www.npmjs.com/package/@derhuerst/query-overpass)
[](https://github.com/sponsors/derhuerst)
[](https://twitter.com/derhuerst)
## Installing
```shell
npm install @derhuerst/query-overpass
```
## Usage
Pass in a string of [Overpass QL](http://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL). Returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/promise) that will resolve with an array of elements.
```js
const queryOverpass = require('@derhuerst/query-overpass')
queryOverpass(`
[out:json][timeout:25];
node(3378340880);
out body;
`)
.then(console.log)
.catch(console.error)
```
```js
[ {
type: 'node',
id: 3378340880,
lat: 52.5145076,
lon: 13.35011,
tags: {
artist: 'Friedrich Drake',
artwork_type: 'statue',
colour: 'gold',
height: '66.9',
image: 'https://upload.wikimedia.org/wikipedia/commons/2/2a/Victoria_Goldelse_Siegessaeule_Berlin.jpg',
min_height: '58.6',
name: 'Viktoria',
'name:de': 'Siegessäule',
'name:ru': 'Колонна победы',
'name:zh': '勝利女神柱',
reg_name: 'Goldelse',
tourism: 'artwork',
wheelchair: 'no'
}
} ]
```
*Note:* The Overpass API *does not* support [extended Overpass Turbo queries](https://wiki.openstreetmap.org/wiki/Overpass_turbo/Extended_Overpass_Turbo_Queries), as they are an [Overpass Turbo](https://overpass-turbo.eu)-specific feature.
To use make requests from a web site, enable [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) using the `fetchMode` option:
```js
queryOverpass(query, {fetchMode: 'cors'})
```
To use `@derhuerst/query-overpass` with a custom Overpass API endpoint, use the `endpoint` option:
```js
queryOverpass(query, {endpoint: 'https://overpass.example.org'})
```
## Related
- [`osm-build-query`](https://github.com/csbrandt/osm-build-query) – Build a query for the OSM Overpass API that retrieves all elements within the bounding feature.
- [`osm-flatten-relation`](https://github.com/derhuerst/osm-flatten-relation) – Resolve an OpenStreetMap relation recursively.
## Contributing
If you have a question or have difficulties using `query-overpass`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/query-overpass/issues).