Skip to main content
GET
/
vibe
/
visual-appeal
Error
A valid request URL is required to generate request examples
{
  "result": {
    "score": 123,
    "description": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Your access token or API key. Pass as Authorization: Bearer <token>.

Query Parameters

​
lat
number
required

The latitude of the location in decimal degrees (WGS 84). Must be between -90 and 90.

Required range: -90 <= x <= 90
​
lon
number
required

The longitude of the location in decimal degrees (WGS 84). Must be between -180 and 180.

Required range: -180 <= x <= 180

Response

Successful Response

API response for a Visual Appeal lookup.

​
result
VisualAppealResult · object
required

The Visual Appeal result. A score of 0 means no data is available.

Example:
{
  "description": "Attractive streetscape: well-maintained homes, mature street trees, and tidy front yards create a cohesive aesthetic.",
  "score": 188
}