API Documentation

The public API is quite simple and with no restrictions on this experimental phase. The API can be used without any guarantees and is open for requests and feedback via admin@menuinpictures.comadmin@menuinpictures.com

Several places columns are provided by https://nominatim.openstreetmap.org/https://nominatim.openstreetmap.org/

API v1

/api/v1/places
method: GET

Retrieves one array of last 50 places

Response:

[
  {
    "id": <ID>,
    "slug": <Slug name]>,
    "display_name": <Address>,
    "place_name": <Friendly name>,
    "type": <Restaurant type>,
    "created_at": <First submission date>
  },
  ...
]
        

/api/v1/places/page/:page (int)/:ammount (int)
method:GET
:page: integer >=1
:ammount: integer <=50

Retrieves one paginated array of the listed places, in which :page is relative to the current page to be retrieved, followed by the :ammount of entries in each page. The :page accepts numbers above 0, and the :ammount should not be above 50

Response:

[
  {
    "id": <ID>,
    "slug": <Slug name]>,
    "display_name": <Address>,
    "place_name": <Friendly name>,
    "type": <Restaurant type>,
    "created_at": <First submission date>
  },
  ...
]
        

/api/v1/menu/:slug (string)
Method = GET

Retrieves the latest menu entry for a given place :slug

Response:

{
    "id": <ID>,
    "places_id": <Place ID>,
    "accepted":1,
    "place_name": <Place Name>,
    "url": <Place URL>,
    "v_name": <Vanity name>,
    "v_url": <Vanitt URL>,
    "created_at": <Created date>,
    "images":
    [
        {
        "id": <ID>,
        "thumb": <Thumb path>,
        "url": <Full image>,
        "submissions_id": <Submission ID>
        },
        ...
    ]
    "place":
    {
        "id": <ID>,
        "slug": <Slug name]>,
        "display_name": <Address>,
        "type": <Restaurant type>,
        "created_at": <First submission date>
    }
}
        

/api/v1/menu/:slug (string)/all
method: GET
:slug: string place.slug

Retrieves all menu entries for a given place :slug, the first element in the array is the latest added entry

Response:

[
  {
    "id": <ID>,
    "places_id": <Place ID>,
    "accepted":1,
    "place_name": <Place Name>,
    "url": <Place URL>,
    "v_name": <Vanity name>,
    "v_url": <Vanitt URL>,
    "created_at": <Created date>,
    "images":
      [
        {
          "id": <ID>,
          "thumb": <Thumb path>,
          "url": <Full image>,
          "submissions_id": <Submission ID>
          },
          ...
      ],
    "place":
      {
        "id": <ID>,
        "slug": <Slug name]>,
        "display_name": <Address>,
        "type": <Restaurant type>,
        "created_at": <First submission date>
      }
    },
    ...
]