Skip to main content

Python wrapper for the OSM API

Project description

Build Coverage Version Downloads License

Python wrapper for the OSM API


Install `osmapi from PyPi <>`__ by using pip:

pip install osmapi


The documentation is generated using pdoc and can be viewed online.

The build the documentation locally, you can use

pdoc --html osmapi.OsmApi # create HTML file

This project uses GitHub Pages to publish its documentation. To update the online documentation, you need to re-generate the documentation with the above command and update the gh-pages branch of this repository.


Read from OpenStreetMap

import osmapi
api = osmapi.OsmApi()
print api.NodeGet(123)
# {u'changeset': 532907, u'uid': 14298,
# u'timestamp': u'2007-09-29T09:19:17Z',
# u'lon': 10.790009299999999, u'visible': True,
# u'version': 1, u'user': u'Mede',
# u'lat': 59.9503044, u'tag': {}, u'id': 123}


import osmapi
api = osmapi.OsmApi(api="", username = "you", password = "***")
api = osmapi.OsmApi(username = "you", passwordfile = "/etc/mypasswords")
api = osmapi.OsmApi(passwordfile = "/etc/mypasswords") # username will be first line username

Note: The password file should have the format user:password

Write to OpenStreetMap

import osmapi
api = osmapi.OsmApi(api="", username = u"metaodi", password = u"*******")
api.ChangesetCreate({u"comment": u"My first test"})
print api.NodeCreate({u"lon":1, u"lat":1, u"tag": {}})
# {u'changeset': 532907, u'lon': 1, u'version': 1, u'lat': 1, u'tag': {}, u'id': 164684}


Scripted imports and automated edits should only be carried out by those with experience and understanding of the way the OpenStreetMap community creates maps, and only with careful planning and consultation with the local community.

See the Import/Guidelines and Automated Edits/Code of Conduct for more information.


If you want to help with the development of osmapi, you should clone this repository and install the requirements:

pip install -r requirements.txt
pip install -r test-requirements.txt

After that, it is recommended to install the flake8 pre-commit-hook:

flake8 --install-hook


To run the tests use the following command:

nosetests --verbose

By using tox you can even run the tests against different versions of python (2.7, 3.3, 3.4, 3.5 and 3.6):



To create a new release, follow these steps (please respect Semantic Versioning):

  1. Adapt the version number in osmapi/

  2. Update the CHANGELOG with the version

  3. Create a pull request to merge develop into master (make sure the tests pass!)

  4. Create a new release/tag on GitHub (on the master branch)

  5. The publication on PyPI happens via Travis CI on every tagged commit


This project was orginally developed by Etienne Chove. This repository is a copy of the original code from SVN (, with the goal to enable easy contribution via GitHub and release of this package via PyPI.

See also the OSM wiki:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osmapi-1.0.2.tar.gz (16.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page