> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenStreetMap

> How to set up the OpenStreetMap connector, plus the actions that are available.

![OpenStreetMap](https://stackone-logos.com/api/openstreetmap/filled/svg)

v2.1.0[See changelog](https://docs.stackone.com/connectors/openstreetmap/changelog.md)

[85 actions](#actions) · 2 auth methods

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/openstreetmap/guides/connector-profile/oauth-2-0.md)
>
> OpenStreetMap requires OAuth 2.0 for all editing operations (create/update/delete elements, changesets, notes, GPS trace...

> [card] [No Authentication (public APIs only) · Connector Profile](https://docs.stackone.com/connectors/openstreetmap/guides/connector-profile/no-authentication-public-apis-only.md)
>
> Connect without credentials to use OpenStreetMap's public APIs only: Nominatim geocoding (search/reverse/lookup/details/...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/openstreetmap/guides/link-account/oauth-2-0.md)

> [card] [No Authentication (public APIs only) · Link Account](https://docs.stackone.com/connectors/openstreetmap/guides/link-account/no-authentication-public-apis-only.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

No Authentication (public APIs only)

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

consume\_messages

read\_gpx

read\_prefs

send\_messages

write\_api

write\_changeset\_comments

write\_gpx

write\_notes

write\_prefs

write\_redactions

No scopes found

85 actions

ActionDescriptionRequired scopes

Get Api Versions`openstreetmap_get_api_versions`

List API versions supported by the server

Get Capabilities`openstreetmap_get_capabilities`

Get server capabilities and limits (max bbox, changeset element cap, timeouts)

Get Permissions`openstreetmap_get_permissions`

List OAuth permissions granted to the current token

Get Map Data`openstreetmap_get_map_data`

Fetch all nodes/ways/relations within a bounding box

Create Changeset`openstreetmap_create_changeset`

Open a new changeset (returns its ID)

`write_api`

Get Changeset`openstreetmap_get_changeset`

Read a changeset's metadata (optionally with discussion)

Update Changeset`openstreetmap_update_changeset`

Update the tags of an open changeset

`write_api`

Close Changeset`openstreetmap_close_changeset`

Close an open changeset

`write_api`

Download Changeset`openstreetmap_download_changeset`

Download the changes in a changeset as an OsmChange document

Upload Changeset`openstreetmap_upload_changeset`

Upload an OsmChange diff to a changeset atomically (all-or-nothing)

`write_api`

List Changesets`openstreetmap_list_changesets`

Query changesets by bbox, user, time, and open/closed state

Comment Changeset`openstreetmap_comment_changeset`

Add a comment to a closed changeset's discussion

`write_changeset_comments`

Subscribe Changeset`openstreetmap_subscribe_changeset`

Subscribe to a changeset's discussion notifications

`write_api`

Unsubscribe Changeset`openstreetmap_unsubscribe_changeset`

Unsubscribe from a changeset's discussion

`write_api`

Unhide Changeset Comment`openstreetmap_unhide_changeset_comment`

Unhide a previously hidden changeset comment (moderator)

`write_changeset_comments`

Hide Changeset Comment`openstreetmap_hide_changeset_comment`

Hide a changeset comment (moderator)

`write_changeset_comments`

Create Node`openstreetmap_create_node`

Create a new node in an open changeset

`write_api`

Get Node`openstreetmap_get_node`

Read the current version of a node

Update Node`openstreetmap_update_node`

Update a node (optimistic-lock on version)

`write_api`

Delete Node`openstreetmap_delete_node`

Delete a node

`write_api`

Get Node History`openstreetmap_get_node_history`

Fetch all versions of a node

Get Node Version`openstreetmap_get_node_version`

Fetch a specific version of a node

Get Nodes`openstreetmap_get_nodes`

Multi-fetch nodes by ID list

Get Node Relations`openstreetmap_get_node_relations`

List relations that reference this node

Get Node Ways`openstreetmap_get_node_ways`

List ways that use this node

Redact Node Version`openstreetmap_redact_node_version`

Redact/un-redact a node version (moderator)

`write_redactions`

Create Way`openstreetmap_create_way`

Create a new way (references node IDs, max 2000)

`write_api`

Get Way`openstreetmap_get_way`

Read the current version of a way

Update Way`openstreetmap_update_way`

Update a way (optimistic-lock on version)

`write_api`

Delete Way`openstreetmap_delete_way`

Delete a way

`write_api`

Get Way History`openstreetmap_get_way_history`

Fetch all versions of a way

Get Way Version`openstreetmap_get_way_version`

Fetch a specific version of a way

Get Ways`openstreetmap_get_ways`

Multi-fetch ways by ID list

Get Way Relations`openstreetmap_get_way_relations`

List relations that reference this way

Get Way Full`openstreetmap_get_way_full`

Fetch a way plus all its member nodes

Redact Way Version`openstreetmap_redact_way_version`

Redact/un-redact a way version (moderator)

`write_redactions`

Create Relation`openstreetmap_create_relation`

Create a new relation (references member elements)

`write_api`

Get Relation`openstreetmap_get_relation`

Read the current version of a relation

Update Relation`openstreetmap_update_relation`

Update a relation (optimistic-lock on version)

`write_api`

Delete Relation`openstreetmap_delete_relation`

Delete a relation

`write_api`

Get Relation History`openstreetmap_get_relation_history`

Fetch all versions of a relation

Get Relation Version`openstreetmap_get_relation_version`

Fetch a specific version of a relation

Get Relations`openstreetmap_get_relations`

Multi-fetch relations by ID list

Get Relation Relations`openstreetmap_get_relation_relations`

List relations that reference this relation

Get Relation Full`openstreetmap_get_relation_full`

Fetch a relation plus all referenced members

Redact Relation Version`openstreetmap_redact_relation_version`

Redact/un-redact a relation version (moderator)

`write_redactions`

Get Trackpoints`openstreetmap_get_trackpoints`

Fetch raw public GPS trackpoints within a bounding box (paged, 5000/page)

Create Gpx Trace`openstreetmap_create_gpx_trace`

Upload a new GPX trace file

`write_gpx`

Get Gpx Trace Details`openstreetmap_get_gpx_trace_details`

Read a GPS trace's metadata

`read_gpx`

Get Gpx Trace Data`openstreetmap_get_gpx_trace_data`

Download the raw GPS trace data file

`read_gpx`

Update Gpx Trace`openstreetmap_update_gpx_trace`

Update a GPS trace's metadata (owner only)

`write_gpx`

Delete Gpx Trace`openstreetmap_delete_gpx_trace`

Delete a GPS trace (owner only)

`write_gpx`

List Own Gpx Traces`openstreetmap_list_own_gpx_traces`

List the authenticated user's own GPS traces

`read_gpx`

Get User`openstreetmap_get_user`

Read a user's public profile by numeric ID

Get Users`openstreetmap_get_users`

Multi-fetch user details by ID list

Get Current User`openstreetmap_get_current_user`

Read the authenticated user's own profile details

`read_prefs`

Get User Preferences`openstreetmap_get_user_preferences`

Read all of the authenticated user's preferences

`read_prefs`

Replace User Preferences`openstreetmap_replace_user_preferences`

Replace the authenticated user's entire preference set

`write_prefs`

Get User Preference`openstreetmap_get_user_preference`

Read a single preference value by key

`read_prefs`

Delete User Preference`openstreetmap_delete_user_preference`

Delete a single preference by key

`write_prefs`

List Notes`openstreetmap_list_notes`

Fetch map notes within a bounding box

Get Note`openstreetmap_get_note`

Read a single note and its comment thread

Create Note`openstreetmap_create_note`

Create a new map note (anonymous allowed; write\_notes if authenticated)

`write_notes`

Comment Note`openstreetmap_comment_note`

Add a comment to an open note (auth required)

`write_notes`

Close Note`openstreetmap_close_note`

Close (resolve) a note

`write_notes`

Reopen Note`openstreetmap_reopen_note`

Reopen a closed note

`write_notes`

Subscribe Note`openstreetmap_subscribe_note`

Subscribe to a note's updates

`write_notes`

Unsubscribe Note`openstreetmap_unsubscribe_note`

Unsubscribe from a note's updates

`write_notes`

Hide Note`openstreetmap_hide_note`

Hide (delete) a note (moderator)

`write_notes`

Search Notes`openstreetmap_search_notes`

Search notes by text, author, and date

Get Notes Feed`openstreetmap_get_notes_feed`

RSS feed of note activity (optionally by bbox)

List Inbox Messages`openstreetmap_list_inbox_messages`

List the authenticated user's received private messages

`consume_messages`

List Outbox Messages`openstreetmap_list_outbox_messages`

List the authenticated user's sent private messages

`consume_messages`

Send Message`openstreetmap_send_message`

Send a private message to another user

`send_messages`

Get Message`openstreetmap_get_message`

Read a single private message (marks it read)

`consume_messages`

Update Message Status`openstreetmap_update_message_status`

Update a message's read/unread flag

`consume_messages`

Delete Message`openstreetmap_delete_message`

Delete a private message

`consume_messages`

Geocode Search`openstreetmap_geocode_search`

Forward geocode: find places by free-form or structured address/name

Reverse Geocode`openstreetmap_reverse_geocode`

Reverse geocode: build an address from a lat/lon coordinate

Lookup Osm Objects`openstreetmap_lookup_osm_objects`

Look up address details for known OSM objects by ID

Get Place Details`openstreetmap_get_place_details`

Show full internal details of a single place

Nominatim Status`openstreetmap_nominatim_status`

Report whether the Nominatim service/database is up

Run Overpass Query`openstreetmap_run_overpass_query`

Execute an Overpass QL query and return matching OSM data

Overpass Status`openstreetmap_overpass_status`

Report current rate-limit slots and quota for the caller's IP

Kill Overpass Queries`openstreetmap_kill_overpass_queries`

Terminate the caller's currently running Overpass queries


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.