Skip to content

Location intelligence

GET /v1/aux-info

Supplementary underwriting attributes for a location: elevation, distance to coast and US property-crime score. Synchronous, one location per call.

Query parameters

Parameter Type Required Notes
location string CONDITIONAL Place name to geocode; required if coordinates omitted
latitude, longitude float CONDITIONAL Required together if location omitted
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/aux-info?latitude=39&longitude=-110"
[
  { "attribute": "Elevation", "value": 1392, "unit": "m" },
  { "attribute": "Distance to coast", "value": 891, "unit": "km" },
  { "attribute": "Property Crime Score", "value": 57, "unit": "/ 100" }
]

Supported attributes

Attribute Unit Coverage
Elevation m Land only
Distance to coast km –
Property crime score / 100 US only

Errors

Status Meaning
400 Missing required location parameters
401 Missing or invalid API key

Interactive batch reports

Generated batch reports use GET /v1/report/aux-info to load these attributes when a map marker opens. This proxy accepts marker coordinates only and uses a short-lived, job-scoped bearer token from the fragment of an authenticated batch status report_url. It never embeds or transmits the customer's API key.

The proxy token is issued only when the batch-job caller owns the completed job and has /v1/aux-info permission. An expired report must be reopened from a fresh completed batch status response to obtain another token.