Items

Search for some items

get/api/search

Request

  • Base URL: https://api.panoramax.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.panoramax.xyz/api/search
  • Auth: none declared

Query parameters

limitinteger

Limit the number of results, Defaults to 10

idsstring[] nullable

Search for items with those IDs

collectionsstring[] nullable

Search for items belonging to those collections

bboxnumber[] nullable

Search for items inside this bounding box

place_positionstring

Geographical coordinates (lon,lat) of a place you'd like to have pictures of. Returned pictures are either 360° or looking in direction of wanted place.

place_distancestring

Distance range (in meters) to search pictures for a particular place (place_position). Default range is 3-15. Only used if place_position parameter is defined.

place_fov_toleranceinteger

Tolerance on how much the place should be centered in nearby pictures:

  • A lower value means place have to be at the very center of picture
  • A higher value means place could be more in picture sides

Value is expressed in degrees (from 2 to 180, defaults to 30°), and represents the acceptable field of view relative to picture heading. Only used if place_position parameter is defined.

Example values are:

  • <= 30° for place to be in the very center of picture
  • 60° for place to be in recognizable human field of view
  • 180° for place to be anywhere in a wide-angle picture

Note that this parameter is not taken in account for 360° pictures, as by definition a nearby place would be theorically always visible in it.

filterItemFilter (unresolved $ref)

CQL2 filter for the search

Allowed properties are:

  • field_of_view: field of view in degree.
  • semantics: filter on items based on their semantics. The attributes must either:
    • start with "semantics." and formated like "semantics.some_key"='some_value'.
    • be "semantics" and only with the IS NOT NULL operator, to search for any semantics.

To search for any values of a semantic tag, use `"semantics.some_key" IS NOT NULL`` (case matter here).

To search for items with any semantic tags, use "semantics" IS NOT NULL.

Note: for semantic:

  • it's important for the attribute to be quoted (") and the value to around simple quotes (') to avoid issues with CQL2 parsing.
  • for the moment only equality (=), list (IN) and "IS NOT NULL" filters are supported.
  • we do not support searching for multiple different tags at once with an AND operator (for example, "semantics.traffic_sign"='yes' AND "semantics.colour"='red' will not work). We suggest to filter data on your side, after retrieving by the main attribute depending on your interest.

Examples:

  • "semantics.osm|traffic_sign"='yes'
  • "semantics.osm|traffic_sign" IS NOT NULL'
  • "semantics" IS NOT NULL'
  • "semantics.osm|amenity" IN ('bench', 'whatever') OR "semantics.osm|traffic_sign"='yes'
  • field_of_view = 360

Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials/cql/cql_tutorial.html

fieldsItemSortByFields[] required

Define the sort order based on given property.

Sort order is defined based on preceding '+' (asc) or '-' (desc).

If there is no prefix, default is ascending order.

Available properties is:

  • "ts" (capture datetime of the picture)
  • "id" (id of the picture)

Note that, is no sortby parameter is provided, the default sort order is:

  • When searching using a bounding box (bbox), the distance to the center of this bounding box
  • When searching using a place (place_distance), the distance to this place
  • in other cases, by "ts" DESC.

This parameter MUST be urlencoded (%2B instead of '+')

datetimestring nullable

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.

Examples:

A date-time: "2018-02-12T23:20:50Z"
A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

Only items that have a temporal property (the capture datetime of the picture) that intersects the value of datetime are selected.

Response

ItemCollection required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.