OpenStreetMap

https://wiki.openstreetmap.org
Admin
OpenStreetMap is a collaborative project that creates and distributes free, editable geographic data...
Tokens:4,176,143
Snippets:45,219
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### WSGI Application Setup (Python/Flask)

Source: https://wiki.openstreetmap.org/wiki/Using_the_dev_server

Guide for deploying WSGI applications, specifically demonstrating a Flask example. This involves creating a '.wsgi' file in 'wsgi-bin' that imports and runs the Flask application. Modifying 'sys.path' might be necessary to locate the application module.

```python
import sys

# Adjust sys.path to find your application module
sys.path[0:0] = ['/path/to/your/python/app/module']

# Import your Flask application instance
from my_application import site

# Assign the WSGI application object
application = site.app
```

--------------------------------

### Example Usage

Source: https://wiki.openstreetmap.org/w/api_action=help&recursivesubmodules=1

Examples demonstrating how to use the MediaWiki Query API for common tasks.

```APIDOC
## Example Usage

### Fetch site info and revisions of Main Page

This example demonstrates how to fetch site information and revisions for a specific page.

#### Method
GET

#### Endpoint
`/api.php`

#### Query Parameters
- **action** (string) - Required - `query`
- **prop** (string) - Required - `revisions`
- **meta** (string) - Required - `siteinfo`
- **titles** (string) - Required - `Main Page`
- **rvprop** (string) - Optional - `user|comment`
- **continue** (string) - Optional - (Used for pagination)

#### Request Example
```
api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue=
```

### Fetch revisions of pages beginning with `API/`

This example shows how to retrieve revisions for pages whose titles start with a specific prefix.

#### Method
GET

#### Endpoint
`/api.php`

#### Query Parameters
- **action** (string) - Required - `query`
- **generator** (string) - Required - `allpages`
- **gapprefix** (string) - Required - `API/`
- **prop** (string) - Required - `revisions`
- **continue** (string) - Optional - (Used for pagination)

#### Request Example
```
api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue=
```
```

--------------------------------

### MediaWiki API: Merge Page History (GET Request Example)

Source: https://wiki.openstreetmap.org/w/api_action=help&modules=mergehistory

This example demonstrates how to merge the entire history of one page into another using the MediaWiki API's mergehistory module via a GET request. It includes parameters for source and destination pages, a reason for the merge, and a CSRF token. Note that this module ideally accepts POST requests, but GET examples are provided for demonstration.

```plaintext
https://wiki.openstreetmap.org/w/api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason
```

--------------------------------

### Usage Examples (wget and curl)

Source: https://wiki.openstreetmap.org/wiki/Osmxapi

Examples of how to use wget and curl to query Xapi and save the results.

```APIDOC
## Usage Examples

### Description
Examples of how to use common command-line tools like `wget` and `curl` to query Xapi and save the results.

### Using wget

- **Command**:
  ```bash
  wget --timeout=0 http://www.informationfreeway.org/api/0.6/node[amenity=hospital] -O data.osm
  ```
- **Notes**:
  - `--timeout=0` disables the timeout, recommended for potentially long queries.
  - `-O data.osm` saves the output to a file named `data.osm`.

### Using curl

- **Command**:
  ```bash
  curl --location --globoff "http://www.informationfreeway.org/api/0.6/node[amenity=hospital]" -o data.osm
  ```
- **Notes**:
  - `--location` follows redirects.
  - `--globoff` prevents `curl` from interpreting brackets `[]` as command-line options.
  - `-o data.osm` saves the output to a file named `data.osm`.

### User Agent String

- It is recommended to set a meaningful User-Agent string when scripting queries to help understand usage patterns. For example:
  ```bash
  curl --user-agent "MyXapiClient/1.0" ...
  ```
```

--------------------------------

### Potlatch 1 Editor Setup

Source: https://wiki.openstreetmap.org/wiki/Fugro

Instructions for adding the Fugro aerial imagery layer to Potlatch 1 using a custom URL.

```APIDOC
## Potlatch 1 Editor Setup

### Description
This guide explains how to add the Fugro aerial imagery layer to the Potlatch 1 editor by specifying a custom TMS URL.

### Method
Manual Configuration

### Endpoint
`http://fugro.openstreetmap.dk/fugro2005/!/!/!.jpg`

### Steps
1. Open Potlatch 1.
2. Click the 'Options' button (located in the bottom left corner, often represented by a box with a checkmark).
3. In the options menu, find the 'Custom' field.
4. Enter the following URL: `http://fugro.openstreetmap.dk/fugro2005/!/!/!.jpg`.
```

--------------------------------

### GET /user/blocks/active.json Endpoint Example

Source: https://wiki.openstreetmap.org/wiki/API_v0

This snippet shows an example GET request to the /user/blocks/active.json endpoint, which retrieves information about active user blocks. The response is in JSON format and includes metadata about the API version, copyright, and a list of user blocks with their details.

```json
GET /user/blocks/active.json

```

```json
{
	"version":"0.6",
	"generator":"OpenStreetMap server",
	"copyright":"OpenStreetMap and contributors",
	"attribution":"http://www.openstreetmap.org/copyright",
	"license":"http://opendatacommons.org/licenses/odbl/1-0/",
	"user_blocks":[
		{
			"id":101,
			"created_at":"2025-02-22T02:11:55Z",
			"updated_at":"2025-02-22T02:11:55Z",
			"ends_at":"2025-02-22T03:11:55Z",
			"needs_view":true,
			"user":{"uid":5,"user":"fakemod1"},
			"creator":{"uid":115,"user":"fakemod2"}
		},
		{
			"id":100,
			"created_at":"2025-02-22T02:11:10Z",
			"updated_at":"2025-02-22T02:11:10Z",
			"ends_at":"2025-02-22T02:11:10Z",
			"needs_view":true,
			"user":{"uid":5,"user":"fakemod1"},
			"creator":{"uid":115,"user":"fakemod2"}
		},
		...
	]
}

```

--------------------------------

### Sample SPARQL Query for OSM Place Objects

Source: https://wiki.openstreetmap.org/wiki/Sophox

A basic example of a SPARQL query to retrieve OSM objects tagged as 'place'. This query demonstrates how to interact with OSM data using SPARQL, a SQL-like query language. It is intended for users to get started with Sophox's querying capabilities.

```sparql
# A sample query to list all OSM objects with a place tag.

```

--------------------------------

### Template Usage Example for Map Features

Source: https://wiki.openstreetmap.org/wiki/Template%3AGeneric%3AMap_Features%3Aplace

Demonstrates the basic structure and parameters for using the 'place' template in wiki pages. It shows how to specify a language, define section headers, and add key-value pairs with descriptions and rendering hints.

```WikiText
==Usage==
All parameters are optional. By default, text is in English. 
English writers shall write their comments in the template itself (avoiding double edition). 
Other languages are translated in template arguments, not in the template itself.

Set 
|lang = <your_language_code>:
to make all key and value links point to translated pages (note the : at the end).

Example:
|lang = DE:

== Section header ==
|name=        (section header line)
|description= (displayed between the two tables; optional)

== One key/value row ==
|place:key=   |city:value=   |city:desc=   |city:render=   |city:photo=

You can use
|city:value:alt=[[<any other link>]]
as alternatives for :key and :value links, for example to link to the english pages.
```

--------------------------------

### Wiki Infobox Template Example

Source: https://wiki.openstreetmap.org/wiki/Talk%3AWiki/Archive_8

Demonstrates the structure of a wiki infobox template used for displaying key-value pairs. This snippet shows a minimal example of the 'KeyDescription' template with a 'key' and 'description' field, intended for testing infobox rendering.

```WikiText
{{KeyDescription
| key           = hgv:national network
| description   = test test test test test test test test test test test test test test test test test test test test test test test test test test test test test test 
}}
```

--------------------------------

### Generate unique links starting from a title

Source: https://wiki.openstreetmap.org/w/api_action=help&recursivesubmodules=1

Uses a generator to retrieve unique linked titles starting from a specified title. This is an efficient way to get distinct links.

```api
api.php?action=query&generator=alllinks&galunique=&galfrom=B
```
Tokens:
Raw