Skip to content

Humans API

Manage user profiles, locations, and tracking filters.

Get User

GET /api/humans/{id}

Response

{
  "status": "ok",
  "human": {
    "id": "123456789",
    "name": "username",
    "type": "discord:user",
    "enabled": true,
    "latitude": 51.5,
    "longitude": -0.1,
    "area": "[\"Downtown\"]"
  }
}

Set Location

POST /api/humans/{id}/setLocation
Content-Type: application/json

{
  "latitude": 51.5074,
  "longitude": -0.1278
}

Response

{
  "status": "ok"
}

Validate Location

Check if a location falls within any configured geofence areas.

POST /api/humans/validateLocation
Content-Type: application/json

{
  "latitude": 51.5074,
  "longitude": -0.1278
}

Response

{
  "status": "ok",
  "areas": ["Downtown", "City Centre"],
  "valid": true
}

Get Tracking Filters

GET /api/humans/{id}/tracking

Response

Returns all active tracking filters for the user, grouped by type (pokemon, raid, quest, etc.).

Set Tracking Filter

POST /api/humans/{id}/tracking
Content-Type: application/json

{
  "type": "pokemon",
  "pokemon_id": 25,
  "min_iv": 90,
  "distance": 1000
}

Remove Tracking Filter

DELETE /api/humans/{id}/tracking/{trackingId}