Tileset Search

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

Overview

The Tilesets search endpoint provides a simple interface for querying tilesets.

It supports the following types of filtering:

• Collection filtering: Filter by livemaps or venues

Endpoint: GET /v3.0/tilesets/search

Response Format

Success Response

Status Code: 200 OK

Response Structure:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1234567890,
            "livemap": 456,
            "uuid": "some-uuid",
            "venue": 789
        }
    ]
}

Tileset Object Fields:

• id (integer): Unique identifier for the tileset
• uuid (string): Unique UUID identifier for the tileset (used for tile generation)
• livemap (integer): ID of the livemap this tileset belongs to
• venue (integer): ID of the venue this tileset is associated with

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

Error Responses

This endpoint does not return specific error responses, except for the 401 Unauthorized error. If no tilesets match the criteria, an empty results array is returned.

Query Parameters

Filtering by Collection

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

livemap (integer, optional)

Filter tilesets that belong to a specific livemap.

Example:

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

venue (integer, optional)

Filter tilesets that are associated with a specific venue.

Example:

GET /v3.0/tilesets/search?venue=789

You can combine both parameters to find a specific tileset:

GET /v3.0/tilesets/search?livemap=456&venue=789

Sorting

Results are sorted by id in ascending order.

Pagination

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