Skip to main content

Venue Search

Note: This documentation covers Venue Search specific features. For common concepts like response format, pagination, and general query parameters, see the Getting Started Guide.

Overview​

The Venues search endpoint provides a search interface for querying venues.

It supports the following types of filtering:

  • Text search: Full-text search on venue names
  • Collection filtering: Filter by livemaps or users

Endpoint: GET /v3.0/venues/search

Response Format​

Success Response​

Status Code: 200 OK

Response Structure:

{
    "count": 23,
    "next": "https://api.getwemap.com/v3.0/venues/search?limit=20&query=venue",
    "previous": null,
    "results": [
        {
            "created": "2023-12-31T08:45:37.330834Z",
            "name": "Venue name",
            "id": 1234567890,
            "updated": "2023-12-31T08:52:37.330834Z",
            "user": 4567
        },
    // ... more venues
    ]
}

Note: For general response format details (count, next, previous, results fields), see the Getting Started Guide.

Error Responses​

400 Bad Request​

Returned when:

  • No search criteria are provided (at least one criterion is required)

Query Parameters​

Text Search​

query (string, optional)​

Full-text search on the venue's name.

Searched Fields:

  • Venue name

Example:

GET /v3.0/venues/search?query=station

Filtering by Collection​

These parameters allow you to filter venues by the collections or objects they are linked to: livemaps or users. All of them are specified by their ID.

livemap (integer, optional)​

Filter venues that belong to a specific livemap.

Example:

GET /v3.0/venues/search?livemap=456

user (integer, optional)​

Filter venues created by a specific user.

Example:

GET /v3.0/venues/search?user=42

Sorting​

Results are sorted by relevance score (default sorting). Relevance considers:

  • Text match quality: Better matches to your search query are ranked higher

Pagination​

For pagination parameters (limit and offset), see the Getting Started Guide.