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", "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), "xml", "rss", "json" or "gpx".

Value

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

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.0087087 39.9832614 4284593
#> 2  4.0040635 39.9816121 4284592
#> 3  4.0036994 39.9800265 4284590
#> 4  4.0009603 39.9713972 4284586
#> 5  3.9991461 39.9691093 4284582
#> 6  3.9982414 39.9689456 4284581
#> 7  4.2892993 39.8778725 4281486
#> 8  4.0783739 39.8992958 4275714
#> 9  4.0178272 39.9305598 4275713
#> 10 3.9376020 39.9389737 4275712
#>                                                        url
#> 1  https://api.openstreetmap.org/api/0.6/notes/4284593.xml
#> 2  https://api.openstreetmap.org/api/0.6/notes/4284592.xml
#> 3  https://api.openstreetmap.org/api/0.6/notes/4284590.xml
#> 4  https://api.openstreetmap.org/api/0.6/notes/4284586.xml
#> 5  https://api.openstreetmap.org/api/0.6/notes/4284582.xml
#> 6  https://api.openstreetmap.org/api/0.6/notes/4284581.xml
#> 7  https://api.openstreetmap.org/api/0.6/notes/4281486.xml
#> 8  https://api.openstreetmap.org/api/0.6/notes/4275714.xml
#> 9  https://api.openstreetmap.org/api/0.6/notes/4275713.xml
#> 10 https://api.openstreetmap.org/api/0.6/notes/4275712.xml
#>                                                        comment_url
#> 1  https://api.openstreetmap.org/api/0.6/notes/4284593/comment.xml
#> 2  https://api.openstreetmap.org/api/0.6/notes/4284592/comment.xml
#> 3  https://api.openstreetmap.org/api/0.6/notes/4284590/comment.xml
#> 4  https://api.openstreetmap.org/api/0.6/notes/4284586/comment.xml
#> 5  https://api.openstreetmap.org/api/0.6/notes/4284582/comment.xml
#> 6  https://api.openstreetmap.org/api/0.6/notes/4284581/comment.xml
#> 7  https://api.openstreetmap.org/api/0.6/notes/4281486/comment.xml
#> 8  https://api.openstreetmap.org/api/0.6/notes/4275714/comment.xml
#> 9  https://api.openstreetmap.org/api/0.6/notes/4275713/comment.xml
#> 10 https://api.openstreetmap.org/api/0.6/notes/4275712/comment.xml
#>                                                        close_url
#> 1  https://api.openstreetmap.org/api/0.6/notes/4284593/close.xml
#> 2  https://api.openstreetmap.org/api/0.6/notes/4284592/close.xml
#> 3  https://api.openstreetmap.org/api/0.6/notes/4284590/close.xml
#> 4  https://api.openstreetmap.org/api/0.6/notes/4284586/close.xml
#> 5  https://api.openstreetmap.org/api/0.6/notes/4284582/close.xml
#> 6  https://api.openstreetmap.org/api/0.6/notes/4284581/close.xml
#> 7  https://api.openstreetmap.org/api/0.6/notes/4281486/close.xml
#> 8  https://api.openstreetmap.org/api/0.6/notes/4275714/close.xml
#> 9  https://api.openstreetmap.org/api/0.6/notes/4275713/close.xml
#> 10 https://api.openstreetmap.org/api/0.6/notes/4275712/close.xml
#>           date_created status                           comments
#> 1  2024-06-09 06:07:42   open 1 comment from 2024-06-09 by edvac
#> 2  2024-06-09 05:59:58   open 1 comment from 2024-06-09 by edvac
#> 3  2024-06-09 05:55:12   open 1 comment from 2024-06-09 by edvac
#> 4  2024-06-09 05:42:14   open 1 comment from 2024-06-09 by edvac
#> 5  2024-06-09 05:37:58   open 1 comment from 2024-06-09 by edvac
#> 6  2024-06-09 05:36:03   open 1 comment from 2024-06-09 by edvac
#> 7  2024-06-06 18:51:03   open 1 comment from 2024-06-06 by edvac
#> 8  2024-06-02 13:02:35   open 1 comment from 2024-06-02 by edvac
#> 9  2024-06-02 13:02:34   open 1 comment from 2024-06-02 by edvac
#> 10 2024-06-02 13:02:33   open 1 comment from 2024-06-02 by edvac