Skip to main content

Scorecard API Reference

Address Scorecard#

The Address Scorecard API takes Address as the required parameter and level as optional parameter, and returns either gridTrends or pincodeTrends depending upon the level provided.

Send a POST request to https://console.datasutram.com/api/scorecard/address to get Address Scorecard using Address. The request body has the following parameters:

ParameterRequirement
addressrequired
leveloptional

Request

{
"address":"Naubari, Uttar Pradesh 282001"
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"district": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
77.94581455509763,
27.13698295889651
],
[
77.9460798299204,
27.137201032801613
],
[
77.9473690899116,
27.138278304600135
],
[
77.94844089383224,
27.139155409794455
],
[
77.94936291296813,
27.139936976410524
],
...more items
]
]
},
"address": "Naubari, Uttar Pradesh 282001",
"pincodeTrends": {
"affluence": "4103134.764",
"affluence_country_level": "very_high",
"affluence_state_level": "very_high",
"airport_count": "0",
"airport_count_density": "0.0",
"apartment_complex_count": "171",
"apartment_complex_count_density": "0.25",
"area": "180.5",
"high_density_market_area_%": "15.37",
"high_density_office_area_%": "11.58",
...more items
},
"gridTrends": {
"affluence": "800000.0",
"income_group": "MIG",
"market_presence": "Yes",
"market_concentration": "6.0",
"office_presence": "Yes",
"office_concentration":"8.0",
"branded_area": "Yes",
"footfall": "50",
"hospitality_count": "0",
... more items
}
}

OR

Request

{
"address":"Naubari, Uttar Pradesh 282001",
"level":"grid"
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Point",
"coordinates": [
27.10945129,
78.04206848
]
},
"address": "Naubari, Uttar Pradesh 282001",
"gridTrends": {
"affluence": "800000.0",
"income_group": "MIG",
"market_presence": "Yes",
"market_concentration": "6.0",
"office_presence": "Yes",
"office_concentration":"8.0",
"branded_area": "Yes",
"footfall": "50",
"hospitality_count": "0",
... more items
}
}

OR

Request

{
"address":"Naubari, Uttar Pradesh 282001",
"level":"pincode"
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"district": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
77.94581455509763,
27.13698295889651
],
[
77.9460798299204,
27.137201032801613
],
[
77.9473690899116,
27.138278304600135
],
[
77.94844089383224,
27.139155409794455
],
[
77.94936291296813,
27.139936976410524
],
...more items
]
]
},
"address": "Naubari, Uttar Pradesh 282001",
"pincodeTrends": {
"affluence": "4103134.764",
"affluence_country_level": "very_high",
"affluence_state_level": "very_high",
"airport_count": "0",
"airport_count_density": "0.0",
"apartment_complex_count": "171",
"apartment_complex_count_density": "0.25",
"area": "180.5",
"high_density_market_area_%": "15.37",
"high_density_office_area_%": "11.58",
...more items
}
}

Coordinate Scorecard#

The Coordinate Scorecard API takes latitude and longitude as the required parameter and level as optional parameter, and returns either gridtrends or pincodeTrends depending upon the level provided.

Send a POST request to https://console.datasutram.com/api/scorecard/coordinate to get Coordinates Scorecard using latitude and longitude. The request body has the following parameters:

ParameterRequirement
latrequired
lngrequired
leveloptional

Request

{
"lat":27.1165523,
"lng":78.0415092
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"district": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
77.94581455509763,
27.13698295889651
],
[
77.9460798299204,
27.137201032801613
],
[
77.9473690899116,
27.138278304600135
],
[
77.94844089383224,
27.139155409794455
],
[
77.94936291296813,
27.139936976410524
],
...more items
]
]
},
"address": "Naubari, Uttar Pradesh 282001",
"pincodeTrends": {
"affluence": "4103134.764",
"affluence_country_level": "very_high",
"affluence_state_level": "very_high",
"airport_count": "0",
"airport_count_density": "0.0",
"apartment_complex_count": "171",
"apartment_complex_count_density": "0.25",
"area": "180.5",
"high_density_market_area_%": "15.37",
"high_density_office_area_%": "11.58",
...more items
},
"gridTrends": {
"affluence": "800000.0",
"income_group": "MIG",
"market_presence": "Yes",
"market_concentration": "6.0",
"office_presence": "Yes",
"office_concentration":"8.0",
"branded_area": "Yes",
"footfall": "50",
"hospitality_count": "0",
... more items
}
}

OR

Request

{
"lat":27.1165523,
"lng":78.0415092,
"level":"grid"
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Point",
"coordinates": [
27.11631775,
78.04206848
]
},
"address": "Naubari, Uttar Pradesh 282001",
"gridTrends": {
"affluence": "800000.0",
"income_group": "MIG",
"market_presence": "Yes",
"market_concentration": "6.0",
"office_presence": "Yes",
"office_concentration":"8.0",
"branded_area": "Yes",
"footfall": "50",
"hospitality_count": "0",
... more items
}
}

OR

Request

{
"lat":27.1165523,
"lng":78.0415092,
"level":"pincode"
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"district": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
77.94581455509763,
27.13698295889651
],
[
77.9460798299204,
27.137201032801613
],
[
77.9473690899116,
27.138278304600135
],
[
77.94844089383224,
27.139155409794455
],
[
77.94936291296813,
27.139936976410524
],
...more items
]
]
},
"address": "Naubari, Uttar Pradesh 282001",
"pincodeTrends": {
"affluence": "4103134.764",
"affluence_country_level": "very_high",
"affluence_state_level": "very_high",
"airport_count": "0",
"airport_count_density": "0.0",
"apartment_complex_count": "171",
"apartment_complex_count_density": "0.25",
"area": "180.5",
"high_density_market_area_%": "15.37",
"high_density_office_area_%": "11.58",
...more items
}
}

Pincode Scorecard#

The Pincode Scorecard API takes Pincode as the required parameter, and returns pincodeTrends along with locationDetails and geometry of the pincode.

Send a POST request to https://console.datasutram.com/api/scorecard/pincode to get Pincode Scorecard using Pincode. The request body has the following parameters:

ParameterRequirement
pincoderequired
{
"pincode":"282001"
}

Response

{
"dataSource": "datasutram",
"locationDetails": {
"pincode": "282001",
"taluka": "agra",
"city": "agra",
"district": "agra",
"state": "uttar pradesh",
"pincodeCategory": "urban"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
77.94581455509763,
27.13698295889651
],
[
77.9460798299204,
27.137201032801613
],
[
77.9473690899116,
27.138278304600135
],
[
77.94844089383224,
27.139155409794455
],
... more items
]
]
},
"pincodeTrends": {
"affluence": "4103134.764",
"affluence_country_level": "very_high",
"affluence_state_level": "very_high",
"airport_count": "0",
"airport_count_density": "0.0",
"apartment_complex_count": "171",
"apartment_complex_count_density": "0.25",
"area": "180.5",
"high_density_market_area_%": "15.37",
"high_density_office_area_%": "11.58",
... more items
}
}