Skip to content

Sustainability Index

Sustainability Index API returns the index score for the specified {Viewport} within the specified {Location}.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/maps/index/sustainability

Path Parameters

Name                       Description Type Examples
*{billing_plan} Billing plan to be applied to the call. string ondemand
*{account_id} Provided identifier of the account. string

Header Parameters

Name                          Description Type Examples                         
*x-api-key Provided API key {x_api_key} that allows authentication. string
*Authorization Provided token {jwt_bearer} that allows authorization. string Bearer {jwt_bearer}

Query Parameters

Name                         Description Type Examples                 Examples
*{Viewport} Viewport identifier. Viewport Viewport
*{Location} Location identifier. Geospatial Area
GeometryID
Circle
*from Start date of timeframe. date 2020-01-01
*to End date of timeframe. date 2020-12-31
ⓝ poi_industry Filter by POI Industry. string Dictionary
Example 
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/maps/index/sustainability?country=italy&state=toscana&county=prato&from=2025-01-01&to=2025-10-31&sw_lat=43.06888777416961&sw_lng=8.4375&se_lat=43.06888777416961&se_lng=11.25&ne_lat=45.08903556483103&ne_lng=11.25&nw_lat=45.08903556483103&nw_lng=8.4375' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Sustainability Index data has been successfully returned.

Body

MapsIndex

Field Description Type
tiles Map quads index scores for requested {Viewport} and {Location}. array[MapsIndexDateScore]
MapsIndexDateScore
Field Description Type
*score Index score of corresponding quadkey. decimal
*quadkey Identifier of the map quad. Quadkey
Quadkey
Field Description Type Examples
*tile Map quad identifier in Bing Maps Tile System standard format. string 1202231311
*wkt Map quad expressed in WKT standard format. string POLYGON ((10.8984375 43.83452678223682, 11.25 43.83452678223682, 11.25 44.087585028245165, 10.8984375 44.087585028245165, 10.8984375 43.83452678223682))
Example 
{
    "tiles": [
        {
            "score": 77.57,
            "quadkey": {
                "tile": "1202231311",
                "wkt": "POLYGON ((10.8984375 43.83452678223682, 11.25 43.83452678223682, 11.25 44.087585028245165, 10.8984375 44.087585028245165, 10.8984375 43.83452678223682))"
            }
        },
        {
            "score": 88.79,
            "quadkey": {
                "tile": "1202231133",
                "wkt": "POLYGON ((10.8984375 44.087585028245165, 11.25 44.087585028245165, 11.25 44.339565248097124, 10.8984375 44.339565248097124, 10.8984375 44.087585028245165))"
            }
        },
        {
            "score": 84.0,
            "quadkey": {
                "tile": "1202231313",
                "wkt": "POLYGON ((10.8984375 43.58039085560784, 11.25 43.58039085560784, 11.25 43.83452678223682, 10.8984375 43.83452678223682, 10.8984375 43.58039085560784))"
            }
        }
    ]
}