Country of birth (detailed)

England

Wales

gethttps://crystalroof.co.uk/customer-api/demographics-and-migration/country-of-birth-detailed/postcode/v1/{location}

Description

This method returns Census 2021 estimates that classify usual residents by their country of birth.

The country of birth is the country in which a person was born. The countries of birth are split into 84 categories including total.

The estimates are as at Census Day, 21 March 2021.

Parameters

Name	Description
location path string	Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format. Examples Postcode with or without space. This argument is case-insensitive. Value
area_type query enum	Area types used in Census 2021. The method returns results based on the inclusion of the postcode/coordinate/UPRN within the designated geographical area. For instance, when using 'oa' as a parameter, the returned results will be for the Output Area that contains the specified postcode/coordinate/UPRN. lad - Local Authority District. There are a total of 296 districts in England made up of 36 metropolitan boroughs, 32 London boroughs, 164 two-tier non-metropolitan districts and 62 unitary authorities, City of London district and Isles of Scilly district. In Wales, there are 22 local authorities, which are named principal areas.. region - nine regions of England (London, the North East, North West, Yorkshire, East Midlands, West Midlands, South East, East of England and the South West) and Wales as a whole. country - constituent countries of the UK: England, Scotland, Wales and Northern Ireland. Value
api_key query enum	Your API key. `DEMO` key allows you to test the method in the `W6 0` postcode sector, or in the `[[51.492, -0.25], [51.502, -0.225]]` rectangle. Value

Request URL:

https://crystalroof.co.uk/customer-api/demographics-and-migration/country-of-birth-detailed/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 183149,
      "Europe": 136878,
      "Europe: United Kingdom": 99816,
      "Europe: United Kingdom: England": 95299,
      "Europe: United Kingdom: Northern Ireland": 844,
      "Europe: United Kingdom: Scotland": 2441,
      "Europe: United Kingdom: Wales": 1219,
      "Europe: United Kingdom: Great Britain not otherwise specified": 4,
      "Europe: United Kingdom: United Kingdom not otherwise specified": 9,
      "Europe: Other Europe": 37062,
      "Europe: Other Europe: EU countries": 31228,
      "Europe: Other Europe: EU countries: Member countries in March 2001": 23959,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Ireland": 3036,
      "Europe: Other Europe: EU countries: Member countries in March 2001: France": 5094,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Germany": 1675,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Italy": 5408,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Portugal (including Madeira and the Azores)": 1568,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Spain (including Canary Islands)": 3258,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Other member countries in March 2001": 3920,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011": 6957,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Lithuania": 537,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Poland": 2553,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Romania": 1186,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Other EU countries": 2681,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2011 and March 2021": 312,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2011 and March 2021: Croatia": 312,
      "Europe: Other Europe: Rest of Europe": 5834,
      "Europe: Other Europe: Rest of Europe: Turkey": 907,
      "Europe: Other Europe: Rest of Europe: Other Europe": 4927,
      "Africa": 12656,
      "Africa: North Africa": 2869,
      "Africa: Central and Western Africa": 2444,
      "Africa: Central and Western Africa: Ghana": 702,
      "Africa: Central and Western Africa: Nigeria": 934,
      "Africa: Central and Western Africa: Other Central and Western Africa": 808,
      "Africa: South and Eastern Africa": 7313,
      "Africa: South and Eastern Africa: Kenya": 407,
      "Africa: South and Eastern Africa: Somalia": 2446,
      "Africa: South and Eastern Africa: South Africa": 1564,
      "Africa: South and Eastern Africa: Zimbabwe": 282,
      "Africa: South and Eastern Africa: Other South and Eastern Africa": 2614,
      "Africa: Africa not otherwise specified": 30,
      "Middle East and Asia": 18931,
      "Middle East and Asia: Middle East": 5069,
      "Middle East and Asia: Middle East: Iran": 1635,
      "Middle East and Asia: Middle East: Iraq": 1008,
      "Middle East and Asia: Middle East: Other Middle East": 2426,
      "Middle East and Asia: Eastern Asia": 4362,
      "Middle East and Asia: Eastern Asia: China": 2038,
      "Middle East and Asia: Eastern Asia: Hong Kong (Special Administrative Region of China)": 1055,
      "Middle East and Asia: Eastern Asia: Other Eastern Asia": 1269,
      "Middle East and Asia: Southern Asia": 4441,
      "Middle East and Asia: Southern Asia: Afghanistan": 657,
      "Middle East and Asia: Southern Asia: India": 1994,
      "Middle East and Asia: Southern Asia: Pakistan": 913,
      "Middle East and Asia: Southern Asia: Bangladesh": 551,
      "Middle East and Asia: Southern Asia: Sri Lanka": 254,
      "Middle East and Asia: Southern Asia: Other Southern Asia": 72,
      "Middle East and Asia: South-East Asia": 4879,
      "Middle East and Asia: South-East Asia: Philippines": 2943,
      "Middle East and Asia: South-East Asia: Malaysia": 606,
      "Middle East and Asia: South-East Asia: Singapore": 413,
      "Middle East and Asia: South-East Asia: Other South-East Asia": 917,
      "Middle East and Asia: Central Asia": 180,
      "The Americas and the Caribbean": 11430,
      "The Americas and the Caribbean: North America": 4411,
      "The Americas and the Caribbean: North America: United States": 3422,
      "The Americas and the Caribbean: North America: Canada": 965,
      "The Americas and the Caribbean: North America: Other North America": 24,
      "The Americas and the Caribbean: Central America": 354,
      "The Americas and the Caribbean: Central America: All Central American countries": 354,
      "The Americas and the Caribbean: South America": 4289,
      "The Americas and the Caribbean: South America: All South American countries": 4289,
      "The Americas and the Caribbean: The Caribbean": 2376,
      "The Americas and the Caribbean: The Caribbean: Jamaica": 850,
      "The Americas and the Caribbean: The Caribbean: Other Caribbean": 1526,
      "Antarctica and Oceania": 3254,
      "Antarctica and Oceania: Australasia": 3197,
      "Antarctica and Oceania: Australasia: Australia": 2318,
      "Antarctica and Oceania: Australasia: New Zealand": 879,
      "Antarctica and Oceania: Australasia: Other Australasia": 0,
      "Antarctica and Oceania: Other Oceania and Antarctica": 57,
      "Other": 0
    },
    "rank": {
      "Europe": 3,
      "Europe: United Kingdom": 2,
      "Europe: United Kingdom: England": 4,
      "Europe: United Kingdom: Northern Ireland": 7,
      "Europe: United Kingdom: Scotland": 6,
      "Europe: United Kingdom: Wales": 1,
      "Europe: United Kingdom: Great Britain not otherwise specified": 5,
      "Europe: United Kingdom: United Kingdom not otherwise specified": 4,
      "Europe: Other Europe": 10,
      "Europe: Other Europe: EU countries": 10,
      "Europe: Other Europe: EU countries: Member countries in March 2001": 10,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Ireland": 10,
      "Europe: Other Europe: EU countries: Member countries in March 2001: France": 9,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Germany": 8,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Italy": 9,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Portugal (including Madeira and the Azores)": 7,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Spain (including Canary Islands)": 10,
      "Europe: Other Europe: EU countries: Member countries in March 2001: Other member countries in March 2001": 9,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011": 5,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Lithuania": 3,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Poland": 5,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Romania": 3,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2001 and March 2011: Other EU countries": 6,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2011 and March 2021": 10,
      "Europe: Other Europe: EU countries: Countries that joined the EU between April 2011 and March 2021: Croatia": 10,
      "Europe: Other Europe: Rest of Europe": 7,
      "Europe: Other Europe: Rest of Europe: Turkey": 5,
      "Europe: Other Europe: Rest of Europe: Other Europe": 9,
      "Africa": 8,
      "Africa: North Africa": 9,
      "Africa: Central and Western Africa": 4,
      "Africa: Central and Western Africa: Ghana": 5,
      "Africa: Central and Western Africa: Nigeria": 4,
      "Africa: Central and Western Africa: Other Central and Western Africa": 5,
      "Africa: South and Eastern Africa": 8,
      "Africa: South and Eastern Africa: Kenya": 4,
      "Africa: South and Eastern Africa: Somalia": 9,
      "Africa: South and Eastern Africa: South Africa": 7,
      "Africa: South and Eastern Africa: Zimbabwe": 3,
      "Africa: South and Eastern Africa: Other South and Eastern Africa": 8,
      "Africa: Africa not otherwise specified": 5,
      "Middle East and Asia": 7,
      "Middle East and Asia: Middle East": 8,
      "Middle East and Asia: Middle East: Iran": 8,
      "Middle East and Asia: Middle East: Iraq": 7,
      "Middle East and Asia: Middle East: Other Middle East": 8,
      "Middle East and Asia: Eastern Asia": 8,
      "Middle East and Asia: Eastern Asia: China": 7,
      "Middle East and Asia: Eastern Asia: Hong Kong (Special Administrative Region of China)": 8,
      "Middle East and Asia: Eastern Asia: Other Eastern Asia": 7,
      "Middle East and Asia: Southern Asia": 3,
      "Middle East and Asia: Southern Asia: Afghanistan": 6,
      "Middle East and Asia: Southern Asia: India": 3,
      "Middle East and Asia: Southern Asia: Pakistan": 2,
      "Middle East and Asia: Southern Asia: Bangladesh": 3,
      "Middle East and Asia: Southern Asia: Sri Lanka": 2,
      "Middle East and Asia: Southern Asia: Other Southern Asia": 2,
      "Middle East and Asia: South-East Asia": 9,
      "Middle East and Asia: South-East Asia: Philippines": 10,
      "Middle East and Asia: South-East Asia: Malaysia": 8,
      "Middle East and Asia: South-East Asia: Singapore": 8,
      "Middle East and Asia: South-East Asia: Other South-East Asia": 8,
      "Middle East and Asia: Central Asia": 8,
      "The Americas and the Caribbean": 8,
      "The Americas and the Caribbean: North America": 8,
      "The Americas and the Caribbean: North America: United States": 7,
      "The Americas and the Caribbean: North America: Canada": 8,
      "The Americas and the Caribbean: North America: Other North America": 5,
      "The Americas and the Caribbean: Central America": 8,
      "The Americas and the Caribbean: Central America: All Central American countries": 8,
      "The Americas and the Caribbean: South America": 8,
      "The Americas and the Caribbean: South America: All South American countries": 8,
      "The Americas and the Caribbean: The Caribbean": 7,
      "The Americas and the Caribbean: The Caribbean: Jamaica": 5,
      "The Americas and the Caribbean: The Caribbean: Other Caribbean": 8,
      "Antarctica and Oceania": 9,
      "Antarctica and Oceania: Australasia": 9,
      "Antarctica and Oceania: Australasia: Australia": 9,
      "Antarctica and Oceania: Australasia: New Zealand": 9,
      "Antarctica and Oceania: Australasia: Other Australasia": 1,
      "Antarctica and Oceania: Other Oceania and Antarctica": 5,
      "Other": 1
    }
  },
  "dataDate": "2021-03-21",
  "refreshedDate": "2021-03-21"
}

401

Unauthorized

{
  "error": "No such API key or it is not valid anymore."
}

402

Payment Required

{
  "error": "You have exhausted the available calls provided by your package."
}

403

Forbidden

{
  "error": "API key is invalid for the given action."
}

404

Not Found

{
  "error": "Can't find such location."
}

429

Too Many Requests

{
  "error": "Too many requests have been sent in one second."
}

500

Internal Server Error

{
  "error": "We have already started working on a resolution!"
}