Skip to main content

Search API - Getting Started

The search endpoints provide interfaces for querying various resources (events, lists, pinpoints, livemaps, venues, users, and tilesets) with various filtering, sorting, and pagination options.

Response Format​

All search endpoints follow the same response structure.

Success Response​

Status Code: 200 OK

Response Structure:

{
  "count": 25,
  "next": "https://api.getwemap.com/v3.0/{object-type}/search?limit=20&offset=20&query=example",
  "previous": null,
  "results": [
    {
      // ... object data
    },
    // ... more objects
  ]
}

Response Fields:

  • count: Total number of results matching the query
  • next: URL to the next page (null if on last page)
  • previous: URL to the previous page (null if on first page)
  • results: Array of objects with complete data

Error Responses​

400 Bad Request​

Returned when:

  • No search criteria are provided (at least one criterion is required, except sort_by_name in some endpoints)
  • Invalid parameter format (date format, bounding box parameters, tag format, etc.)

Example:

{
  "error": "At least one criterion is required."
}

Pagination​

All search endpoints support pagination using the same parameters.

limit (integer, optional)​

Number of results per page. Default: 20.

Example:

GET /v3.0/{endpoint}/search?limit=50

offset (integer, optional)​

Number of results to skip. Default: 0.

Example:

GET /v3.0/{endpoint}/search?limit=20&offset=40