Hostspot Access Points

RetrieveThe informationHotspot aboutAccess Points API provides endpoints for retrieving and managing WiFi hotspot access pointspoint information. This API is designed for network administrators and applications that need to monitor, locate, and track changes to wireless access points across their locations.infrastructure.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Hotspot Access Points API enables you to retrieve comprehensive information about WiFi access points in your network infrastructure. This API is particularly useful for:

Network monitoring applications that need to track the status and location of access points Asset management systems that maintain inventories of network hardware Location-based services that require precise positioning data from access points with GPS coordinates Change tracking systems that monitor network infrastructure modifications over time

The API supports filtering by location coordinates and change timestamps, making it easy to build applications that can map network coverage areas or detect recent network changes. The paginated response format ensures efficient data retrieval even for large networks with hundreds or thousands of access points.

Key concepts to understand:

Coordinates filtering: Access points may or may not have GPS coordinates set - use the have_coordinates parameter to filter based on location data availability Change tracking: The last_change__gte parameter allows you to retrieve only access points modified since a specific date/time Pagination: Results are paginated using limit/offset parameters for efficient data handling

---

Endpoints

GET /hostspot_access_points/

Description: Retrieves a paginated list of hotspot access points with optional filtering capabilities. Use thisThis endpoint allows you to getfetch access point information aboutbased on location availability, recent changes, and supports pagination for handling large datasets efficiently.

Use Cases:

Generate network coverage maps by filtering access points that have GPS coordinates Monitor network changes by retrieving access points modified since a specific timestamp Build network inventory dashboards with paginated access point listings Create automated reports of wireless accessinfrastructure points,status their locations,

Full andURL configurationExample:

details.

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=50&offset=0&last_change__gte=2024-01-01T00:00:00Z

Parameters:

Parameter	Type	In	Required	Description
last_change__gte	string	query	No	Filter access points by last changemodification date (greater than or equal). Accepts ISO format: 2000-01-01,01, 2000-01-01 00:01:00,00, or 2000-01-01 00:01:00+00:0000)
limit	integer	query	No	Number of results to return per page (default paginationvaries limitby applies)server configuration)
offset	integer	query	No	The initial index from which to return theresults results(used for pagination)
have_coordinates	boolean	query	No	When true,true, returns only returns access points that havewith GPS coordinates setset; when false, returns only those without coordinates

ExamplecURL Request:Example:

curl -X GET "https://gate.zequenze.com/api/v1/hostspot_access_points/?limit=50&have_coordinates=true&last_change__gte=2024-01-01limit=25&offset=0" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 125,156,
  "next": "https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=5025&offset=50"25",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "AP-Main-Lobby"Floor1-East",
      "mac_address": "00:1B:44:11:3A:B7"1A:2B:3C:4D:5E",
      "ip_address": "192.168.1.100"101",
      "ssid": "CompanyWiFi",
      "status": "online",
      "location": {
        "name": "Main Building Lobby",
        "latitude": 40.7128,
        "longitude": -74.0060,
        "floor": 1,
        "Groundbuilding": Floor""Main }Office",
        "status"description": "active"East Wing Conference Room"
      },
      "signal_strength": -45,42,
      "connected_clients"channel": 12,6,
      "frequency": "2.4GHz",
      "connected_devices": 23,
      "max_capacity": 50,
      "last_change": "2024-01-15T10:15T14:30:00Z",
      "created_at": "2023-12-01T09:00:00Z",
      "firmware_version": "1.2.3",
      "model": "Cisco AIR-AP2802I",
      "firmware_version": "8.10.185.0"WifiPro-300"
    },
    {
      "id": 2,
      "name": "AP-Conference-Room-A"Floor2-West",
      "mac_address": "00:1B:44:22:4B:C8"1A:2B:3C:4D:5F",
      "ip_address": "192.168.1.101"102",
      "ssid": "CompanyWiFi",
      "status": "online",
      "location": {
        "name": "Conference Room A",
        "latitude": 40.7130,7129,
        "longitude": -74.0058,0061,
        "floor": 2,
        "2ndbuilding": Floor""Main }Office",
        "status"description": "active"West Wing Marketing Department"
      },
      "signal_strength": -38,
      "connected_clients"channel": 5,11,
      "frequency": "5GHz",
      "connected_devices": 15,
      "max_capacity": 50,
      "last_change": "2024-01-14T16:45:00Z",
      "model"created_at": "Cisco AIR-AP2802I"2023-12-01T09:15:00Z",
      "firmware_version": "8.10.185.0"1.2.3",
      "model": "WifiPro-300"
    }
  ]
}

Response Status Codes:

Status	Description
200	SuccessfullySuccess retrieved- Returns paginated list of access points list

400 Bad request - invalid parameters 401 Unauthorized - invalidInvalid or missing Bearer token 403400 ForbiddenBad Request - insufficientInvalid permissionsquery parameters (e.g., malformed date format) 500 Internal serverServer Error - Server-side processing error

---

Common Use Cases

Use Case 1: Network Coverage Mapping

Retrieve all access points with GPS coordinates to create visual network coverage maps. Use have_coordinates=true to ensure you only get access points that can be plotted on a map.

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=100

Use Case 2: Change Detection and Monitoring

Monitor recent network changes by fetching access points modified since your last check. This is useful for automated monitoring systems that need to detect configuration changes or new installations.

https://gate.zequenze.com/api/v1/hostspot_access_points/?last_change__gte=2024-01-15T00:00:00Z

Use Case 3: Paginated Network Inventory

Build comprehensive network inventory systems that can handle large numbers of access points efficiently using pagination. Start with a reasonable limit and iterate through results.

https://gate.zequenze.com/api/v1/hostspot_access_points/?limit=50&offset=0

Use Case 4: Location-Specific Asset Management

Identify access points that lack GPS coordinates for maintenance or audit purposes by using have_coordinates=false.

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=false

---

Best Practices

• PaginationUse appropriate pagination: Set reasonable limit values (25-100) to balance performance and reduce API calls. Very large limits may cause timeouts.

Implement change tracking: Use the limitlast_change__gte parameter with stored timestamps to efficiently detect and offsetsync parametersonly tomodified handleaccess largepoints datasetsrather efficiently.than Startfetching withall smallerdata pagerepeatedly.

sizes (e.g., 50-100) to test response times

DateHandle Filteringcoordinates filtering carefully: When building location-based features, always use have_coordinates=true to avoid processing access points without position data.

Cache results appropriately: Access point data typically doesn't change frequently, so implement caching with reasonable TTL values (5-15 minutes) to reduce API load.

Error handling for date formats: When using last_change__gte, includeensure timezonedates informationare in ISO formatformat. forThe accurateAPI filteringaccepts acrossmultiple differentformats timebut zonesISO 8601 (YYYY-MM-DDTHH:MM:SSZ) is recommended.

LocationMonitor Filtering:rate Use have_coordinates=true when you need access points with precise location data for mapping or GPS-based applications

Rate Limitinglimits: Implement appropriateexponential delaysbackoff betweenand requestsrespect any rate limiting headers returned by the API to avoid overwhelmingservice theinterruptions. API, especially when retrieving large datasets

ErrorProcess Handlingpagination completely: Always check the HTTP status code and handle pagination end conditions by monitoring the next field in responses

and Caching:continue Considerfetching cachinguntil resultsall pages are retrieved for access points that don't change frequently, using the last_change field to determine when to refresh cachedcomplete data sets.

---