v1

latestOpenAPI 3.0.3AGPLv32026-07-17448054.1 KB
Search

Search for places

Query the database for entries/places according to the search criteria and order the top matching results by their total rating in descending order.

The default result contains up to 100 entries. Use the limit parameter to customize the desired amount. The server may decide to deliver less results than requested up to some internal upper limit (currently 2000).

If the review status list is empty or missing only visible places (created, confirmed) are returned.

get/search

Query parameters

bboxstring
Example:42.27,-7.97,52.58,38.25

Bounding Box

org_tagstring

A single hash tag that is moderated by an organization.

Results will be filtered according to the current clearance status. Unclear revisions of entries will either be removed or replaced by older, already cleared revisions. Unclear revisions of entries are expected to only exist temporarily for a short time frame until a newer version has been cleared.

If the provided hash tag is not moderated by any organization the results will not be filtered by clearance status.

Only a single tag can be specified, because filtering according to clearance by multiple organizations could produce ambiguous and conflicting results.

Only when used in search requests: The hash tag will be included in the query as a mandatory search criteria like any other tag. Omitting this parameter and instead appending the moderated hash tag as a regular tag to the tags parameter will also return unfiltered search results, i.e. current revisions of entries independent of their clearance status.

categoriesstring

Comma-separated list of category identifiers. We currently use the following two:

  • Initiative (non-commercial): 2cd00bebec0c48ba9db761da48678134
  • Company (commercial): 77b3c33a92554bcf8e8c2c86cedd6f6f
textstring
idsstring

Comma-separated list of identifiers

Example:7cee99c287094a94acbdcf29ffff2e85,0884c4e86e404072b6874b99b7e32640,ed8a2aef20054102b20950b1b78eb581
tagsstring

Comma-separated list of tags

Example:organic,non-profit
statusstring

Comma-separated list of multiple review status names

Example:created,confirmed
limitinteger
Example:100

Maximum number of items to return or implicit/unlimited if unspecified.

Response

Successful response

Example response

{
  "visible": [
    {
      "id": "7cee99c287094a94acbdcf29ffff2e85",
      "status": "rejected",
      "lat": 37.2,
      "lng": 120.7,
      "tags": [
        "organic",
        "non-profit"
      ]
    }
  ],
  "invisible": [
    {
      "id": "7cee99c287094a94acbdcf29ffff2e85",
      "status": "rejected",
      "lat": 37.2,
      "lng": 120.7,
      "tags": [
        "organic",
        "non-profit"
      ]
    }
  ]
}
All 44 operations