v1

latestOpenAPI 3.0.02026-07-14735112.5 KB

Insights API

Query Insight at Location

Execute a query for a given insight and location(s). Some Insights may require you to provide required options. ie., when querying occupation for White-Collar Workers, you can filter by opt={"data":{"category":[2469]}}

For examples of locations, please see Location API Documentation

get/data/insights/{insight_id:}/query

Path parameters

insight_id:string required

Insight ID. See https://developer.idealspot.com/data for full list.

Query parameters

versionstring required

(Required) Insight version. Insight versions are incremented when a response format changes in any way, including the addition of new groups. Old versions are retained, unmodified, for backwards compatibility.

location[]string required

(Required) Represents a buffer, region, or custom polygon specification. Accepts the Location model (as a Buffer, Region, or Custom Polygon) formatted as a JSON string. Multiple location query parameters are allowed. NOTE: When requesting multiple locations, you must include brackets(i.e. ?location[]=...&location[]=...). If not included, only the last location will be used. For more detail, see https://idealspot.gitlab.io/developer-docs/#location

Headers

X-RapidAPI-Keystring required

(Required) Rapid API Key. See https://rapidapi.com/idealspot-inc-idealspot-inc-default/api/idealspot-geodata

X-RapidAPI-Hoststring required