GetDemographics - Demographics • Data8 Web Services API Documentation

GetDemographics

Gets geo-demographic information from a postcode.

Description

Finds geo-demographic profiling information from a postcode.

Supply a single postcode to retrieve a full demographic profile based on life stage (youngest - oldest) and wealth (poorest to richest). A name and full description of the profile that the supplied postcode falls in is also supplied.

Please note that profiles are created based on an aggregate of information available about each area, and there are always variations in the people living in each postcode which means that a particular individual might not always match the indicated profile.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/Demographics/GetDemographics.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/Demographics/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/demographics.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
postcode	postcode The postcode to get the geo-demographic profile for
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.

Results

This method returns an object containing the following fields:

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `Success` field is `true`, the other results described below can be used to get the results of the method. If `Success` is `false`, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the `ErrorMessage` field, and any other results should be ignored.
SonarCode	SonarCode The unique code for the profile that the postcode falls in to
Title	Title A human-readable name for the profile
PercentageOfHouseholds	PercentageOfHouseholds The percentage of households in the UK that fall into this same profile
Lifestage	Lifestage A rating from A to F to indicate the life stage of people living in this postcode. A indicates Young Singles and F indicates Retired
WealthQuartile	WealthQuartile An indicator of the affluence of people living in this postcode. 1 indicates Affluent and 4 indicates Struggling
WealthRanking	WealthRanking Latest Version A more detailed indicator of the wealth of people living in this postcode. While the `WealthQuartile` value is calculated at census output area (average of 11 postcodes), this value is calculated at individual postcode level. Postcodes are ranked in wealth between 1 (wealthiest) and 20 (poorest). Because of the difference in area across which the `WealthQuartile` and `WealthRanking` values are calculated, there can be discrepancies between the two. Where there are wealthy and poorer areas close together, the `WealthQuartile` is essentially an average of the different `WealthRanking` values within that area, so it is possible to have a poor (ranking 20) postcode within a generally wealthy (quartile 1) area. 2016 Version An indicator of the wealth of people living in this postcode. 1 indicates the wealthiest people and 100 indicates the poorest
Description	Description A human-readable description of the type of area that the postcode tends to cover

Credit Usage

Each request to this method consumes 1 Demographics credit.

Sample Code

Request Format

{
  "postcode": "CH2 4NE",
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "SonarCode": "C43",
  "Title": "Post War Council",
  "PercentageOfHouseholds": "1.67%",
  "Lifestage": "C",
  "WealthQuartile": 4,
  "WealthRanking": 20,
  "Description": "These neighbourhoods are concentrated within the industrial North and North-East of Britain. A very high proportion of the properties are post war local authority owned terraced properties. These estates were built to house the blue collar workers in our manufacturing heartlands in the fifties and sixties. The majority of properties are rented from the council but a few of the homes are now in owner occupation as the tenants have exercised the right to buy. The population in these areas is now mixed as younger families have replaced many of the older inhabitants, although some older residents still remain. Many are in social grades D and E and there is a very high proportion of residents not in employment. On all measures of deprivation these areas score well above the national average."
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/Demographics/GetDemographics.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
postcode	postcode
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 5 Try It Now!