Skip to contents

Returns the existing notes in the specified bounding box. The notes will be ordered by the date of their last change, the most recent one will be first.

Usage

osm_read_bbox_notes(
  bbox,
  limit = 100,
  closed = 7,
  format = c("R", "sf", "xml", "rss", "json", "gpx")
)

Arguments

bbox

Coordinates for the area to retrieve the notes from (left,bottom,right,top). Floating point numbers in degrees, expressing a valid bounding box, not larger than the configured size limit, 25 square degrees, not overlapping the dateline.

limit

Specifies the number of entries returned at max. A value between 1 and 10000 is valid. Default to 100.

closed

Specifies the number of days a note needs to be closed to no longer be returned. A value of 0 means only open notes are returned. A value of -1 means all notes are returned. Default to 7.

format

Format of the output. Can be "R" (default), "sf" "xml", "rss", "json" or "gpx".

Value

If format = "R", returns a data frame with one map note per row. If format = "sf", returns a sf object from sf.

format = "xml"

Returns a xml2::xml_document with the following format:

<?xml version="1.0" encoding="UTF-8"?>
<osm version="0.6" generator="OpenStreetMap server" copyright="OpenStreetMap and contributors" attribution="https://www.openstreetmap.org/copyright" license="https://opendatacommons.org/licenses/odbl/1-0/">
  <note lon="0.1000000" lat="51.0000000">
    <id>16659</id>
    <url>https://master.apis.dev.openstreetmap.org/api/0.6/notes/16659</url>
    <comment_url>https://master.apis.dev.openstreetmap.org/api/0.6/notes/16659/comment</comment_url>
    <close_url>https://master.apis.dev.openstreetmap.org/api/0.6/notes/16659/close</close_url>
    <date_created>2019-06-15 08:26:04 UTC</date_created>
    <status>open</status>
    <comments>
      <comment>
        <date>2019-06-15 08:26:04 UTC</date>
        <uid>1234</uid>
        <user>userName</user>
        <user_url>https://master.apis.dev.openstreetmap.org/user/userName</user_url>
        <action>opened</action>
        <text>ThisIsANote</text>
        <html>&lt;p&gt;ThisIsANote&lt;/p&gt;</html>
      </comment>
      ...
    </comments>
  </note>
  ...
</osm>

format = "json"

Returns a list with the following json structure:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {"type": "Point", "coordinates": [0.1000000, 51.0000000]},
      "properties": {
        "id": 16659,
        "url": "https://master.apis.dev.openstreetmap.org/api/0.6/notes/16659.json",
        "comment_url": "https://master.apis.dev.openstreetmap.org/api/0.6/notes/16659/comment.json",
        "close_url": "https://master.apis.dev.openstreetmap.org/api/0.6/notes/16659/close.json",
        "date_created": "2019-06-15 08:26:04 UTC",
        "status": "open",
        "comments": [
          {"date": "2019-06-15 08:26:04 UTC", "uid": 1234, "user": "userName", "user_url": "https://master.apis.dev.openstreetmap.org/user/userName", "action": "opened", "text": "ThisIsANote", "html": "<p>ThisIsANote</p>"},
          ...
        ]
      }
    }
  ]
}

format = "rss" & format = "gpx"

For format in "rss", and "gpx", a xml2::xml_document with the corresponding format.

Note

The comment properties (uid, user, user_url) will be omitted if the comment was anonymous.

See also

Other get notes' functions: osm_feed_notes(), osm_get_notes(), osm_search_notes()

Examples

notes <- osm_read_bbox_notes(bbox = c(3.7854767, 39.7837403, 4.3347931, 40.1011851), limit = 10)
## bbox as a character value also works (bbox = "3.7854767,39.7837403,4.3347931,40.1011851").
notes
#>          lon        lat      id
#> 1  4.1970076 39.8344992 4779758
#> 2  3.8391618 39.9769454 4777583
#> 3  4.2112465 39.8297083 4773637
#> 4  4.2164616 39.8285168 4773636
#> 5  4.2305992 39.8241914 4772388
#> 6  3.8331880 39.9946760 4744904
#> 7  4.0762542 39.8982309 4729248
#> 8  4.2371843 39.8169038 4724015
#> 9  4.2428997 39.8166616 4723970
#> 10 4.2457265 39.8169421 4723941
#>                                                        url
#> 1  https://api.openstreetmap.org/api/0.6/notes/4779758.xml
#> 2  https://api.openstreetmap.org/api/0.6/notes/4777583.xml
#> 3  https://api.openstreetmap.org/api/0.6/notes/4773637.xml
#> 4  https://api.openstreetmap.org/api/0.6/notes/4773636.xml
#> 5  https://api.openstreetmap.org/api/0.6/notes/4772388.xml
#> 6  https://api.openstreetmap.org/api/0.6/notes/4744904.xml
#> 7  https://api.openstreetmap.org/api/0.6/notes/4729248.xml
#> 8  https://api.openstreetmap.org/api/0.6/notes/4724015.xml
#> 9  https://api.openstreetmap.org/api/0.6/notes/4723970.xml
#> 10 https://api.openstreetmap.org/api/0.6/notes/4723941.xml
#>                                                        comment_url
#> 1  https://api.openstreetmap.org/api/0.6/notes/4779758/comment.xml
#> 2  https://api.openstreetmap.org/api/0.6/notes/4777583/comment.xml
#> 3  https://api.openstreetmap.org/api/0.6/notes/4773637/comment.xml
#> 4  https://api.openstreetmap.org/api/0.6/notes/4773636/comment.xml
#> 5  https://api.openstreetmap.org/api/0.6/notes/4772388/comment.xml
#> 6  https://api.openstreetmap.org/api/0.6/notes/4744904/comment.xml
#> 7  https://api.openstreetmap.org/api/0.6/notes/4729248/comment.xml
#> 8  https://api.openstreetmap.org/api/0.6/notes/4724015/comment.xml
#> 9  https://api.openstreetmap.org/api/0.6/notes/4723970/comment.xml
#> 10 https://api.openstreetmap.org/api/0.6/notes/4723941/comment.xml
#>                                                        close_url
#> 1  https://api.openstreetmap.org/api/0.6/notes/4779758/close.xml
#> 2  https://api.openstreetmap.org/api/0.6/notes/4777583/close.xml
#> 3  https://api.openstreetmap.org/api/0.6/notes/4773637/close.xml
#> 4  https://api.openstreetmap.org/api/0.6/notes/4773636/close.xml
#> 5  https://api.openstreetmap.org/api/0.6/notes/4772388/close.xml
#> 6  https://api.openstreetmap.org/api/0.6/notes/4744904/close.xml
#> 7  https://api.openstreetmap.org/api/0.6/notes/4729248/close.xml
#> 8  https://api.openstreetmap.org/api/0.6/notes/4724015/close.xml
#> 9  https://api.openstreetmap.org/api/0.6/notes/4723970/close.xml
#> 10 https://api.openstreetmap.org/api/0.6/notes/4723941/close.xml
#>           date_created status                                    comments
#> 1  2025-05-28 18:17:12   open  1 comment from 2025-05-28 by okwithmydecay
#> 2  2025-05-27 11:13:51   open          1 comment from 2025-05-27 by Stemp
#> 3  2025-05-24 16:35:30   open  1 comment from 2025-05-24 by okwithmydecay
#> 4  2025-05-24 16:35:28   open  1 comment from 2025-05-24 by okwithmydecay
#> 5  2025-05-23 16:21:10   open  1 comment from 2025-05-23 by okwithmydecay
#> 6  2025-05-06 09:41:41   open 1 comment from 2025-05-06 by anonymous user
#> 7  2025-04-26 17:42:48   open        1 comment from 2025-04-26 by DaveC46
#> 8  2025-04-23 09:41:55   open        1 comment from 2025-04-23 by DVDGC13
#> 9  2025-04-23 09:21:53   open        1 comment from 2025-04-23 by DVDGC13
#> 10 2025-04-23 09:07:19   open        1 comment from 2025-04-23 by DVDGC13