Nominatim acknowledgement text

[stgeorges]

Hello, I a developer of project called Gismo. It's an open source and free GIS plugin for commercial Rhino3d software. This is Gismo's main repository: https://github.com/stgeorges/gismo

Yesterday, one of Gismo's developers added an option of using the Nominatim API to query latitude, longitude coordinates for a given address. This is the source code of that script: https://github.com/stgeorges/gismo/blob/master/src/Gismo_Address%20To%20Location.py

Since then I checked Nominatim wiki page, and also Usage policy page, but I couldn't find an answer to my question. Just to be clear on the usage limits: I do not think the upper mentioned script will ever reach 1 request per second. It's more likely a couple of requests per day at most. Right now, there may be a couple of requests per week.

This is my issue, though: I would like to add a certain acknowledge text to Gismo's license file. Something similar to this:

Gismo uses Nominatim service to query latitude, longitude data for the given address.

Nominatim service is used in "Address to Location" component.

Data obrained through Nominatim service is provided under the ODbL license: https://openstreetmap.org/copyright

Please refer to the following page for more information: http://nominatim.openstreetmap.org

I was wondering whether or not, there is some precise text, which I need to follow, in order to give credit to Nominatim?

I would welcome any kind of reply.

[mtmail]

Thank you for being so pro-active when it comes to the license!

Nominatim usage itself doesn't require attribution, it's more or less just a tool to search OSM data (though nice if you mention the tool by name). The important part is the "data © OpenStreetMap contributors", listing the data license (ODbL) and link to https://openstreetmap.org/copyright, which I think you already do.

Looking at your code I have two comments:

• please set the email parameter (https://wiki.openstreetmap.org/wiki/Nominatim#Parameters). If you don't feel comfortable putting an email address into the source code you can also set it to the github URL.
• it's better to construct the full URL using a library. Concatenating strings causes trouble with URI-Escaping, spaces (' ' vs '+'), unicode. Python example: http://docs.python-requests.org/en/master/

  import requests
  url = "http://nominatim.openstreetmap.org/search"
  data = {
  'format': ...,
  'limit': ...,
  ...
  }
  response = requests.get(url, params=data)
  if (response.status_code == 200): ...
  elif
  print "error requesting from: "+response.url # that's the full URL including parameters

[stgeorges]

Thank you for the detailed reply @mtmail !! We'll do as you've told us. And use the github link for the email parameter. Once again, thank you for the help!