Get Area

Retrieve detailed information for a specific area.

Retrieve detailed information and Truth Score breakdown for a specific area.

Get Area

Returns the full details and dimension breakdown for a specific area.

GET/v1/areas/{area_id}

Name	Type	Required	Description
`area_id`	string	required	The area's unique identifier (slug)Example: `sandton`
`include`	string	optional	Additional data to include (history, nearby)Example: `history,nearby`

{

"id": string,// Area identifier

"name": string,// Area display name

"province": string,// Province name

"municipality": string,// Municipality name

"truth_score": number,// Overall score (0-10)

"dimensions": object,// Score breakdown by dimension

"coordinates": object,// Lat/lng center point

"updated_at": string// Last update timestamp

}

Example Request

curl -X GET "https://api.placeiq.co/v1/areas/sandton?include=nearby" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

JSON

{
  "id": "sandton",
  "name": "Sandton",
  "province": "Gauteng",
  "municipality": "City of Johannesburg",
  "truth_score": 8.4,
  "dimensions": {
    "safety": {
      "score": 7.2,
      "weight": 0.25,
      "sources": ["saps_crime", "security_companies"]
    },
    "infrastructure": {
      "score": 9.1,
      "weight": 0.20,
      "sources": ["eskom", "water_board", "fibre_providers"]
    },
    "service_delivery": {
      "score": 7.8,
      "weight": 0.15,
      "sources": ["municipal_data"]
    },
    "market": {
      "score": 9.5,
      "weight": 0.15,
      "sources": ["property24", "lightstone"]
    },
    "amenities": {
      "score": 8.8,
      "weight": 0.10,
      "sources": ["schools_gov", "hospitals"]
    },
    "environment": {
      "score": 7.5,
      "weight": 0.10,
      "sources": ["air_quality"]
    },
    "sentiment": {
      "score": 8.2,
      "weight": 0.05,
      "sources": ["resident_surveys"]
    }
  },
  "coordinates": {
    "lat": -26.1076,
    "lng": 28.0567
  },
  "nearby": [
    { "id": "rosebank", "name": "Rosebank", "truth_score": 8.1 },
    { "id": "hyde-park", "name": "Hyde Park", "truth_score": 8.6 }
  ],
  "updated_at": "2026-02-22T08:00:00Z"
}

Error Responses

Returns 404 Not Found if the area doesn't exist:

JSON

{
  "error": {
    "code": "area_not_found",
    "message": "Area 'invalid-area' does not exist",
    "status": 404
  }
}