Skip to main content

Hostspot Locations

Retrieve information about hotspot locations with optional filtering and pagination capabilities.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Endpoints

GET /hostspot_locations/

Retrieves a paginated list of hotspot locations with optional filtering capabilities. You can filter by modification date and restrict results to locations with valid coordinates.

Parameters:

Parameter Type In Required Description
last_change__gte string query No Filter locations changed after specified datetime (ISO format: 2000-01-01, 2000-01-01 00:01:00, 2000-01-01 00:01:00+00:00)
limit integer query No Number of results to return per page
offset integer query No The initial index from which to return the results
have_coordinates boolean query No Only return locations that have coordinates set

Example Request:

GET /api/v1/hostspot_locations/?limit=20&have_coordinates=true&last_change__gte=2024-01-01

Example Response:

{
  "count": 150,
  "next": "https://gate.zequenze.com/api/v1/hostspot_locations/?limit=20&offset=20",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Downtown Coffee Shop",
      "address": "123 Main Street, City, State",
      "latitude": 40.7128,
      "longitude": -74.0060,
      "status": "active",
      "last_change": "2024-01-15T10:30:00Z",
      "created_at": "2023-12-01T14:20:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "University Library",
      "address": "456 Academic Ave, Campus",
      "latitude": 40.7589,
      "longitude": -73.9851,
      "status": "active",
      "last_change": "2024-01-10T16:45:00Z",
      "created_at": "2023-11-15T09:15:00Z",
      "updated_at": "2024-01-10T16:45:00Z"
    }
  ]
}
Status Description
200 Success - Returns paginated list of hotspot locations
401 Unauthorized - Invalid or missing authentication token
400 Bad Request - Invalid query parameters

Best Practices

  • Use the limit parameter to control page size and optimize performance (recommended: 20-100 items per page)
  • Implement the last_change__gte filter for incremental synchronization to only fetch recently modified locations
  • Set have_coordinates=true when you need locations with valid GPS coordinates for mapping applications
  • Handle pagination using the next and previous URLs provided in the response
  • Store the last_change timestamp from your last successful request for efficient data synchronization
  • Always include proper error handling for 401 responses to manage token expiration
Back to top