Passports held (detailed)

England

Wales

gethttps://crystalroof.co.uk/customer-api/demographics-and-migration/passports-held-detailed/postcode/v1/{location}

Description

This method returns Census 2021 estimates that classify usual residents by passports held.

All passports classify a person according to the passport or passports they held at the time of the census. This included expired passports or travel documents people were entitled to renew. Where a person recorded having more than one passport, they were counted only once, categorised in the following priority order: 1. UK passport, 2. Irish passport, 3. Other passport. Only the first country written in "Other passport" was taken.

Passports held are split into 69 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. msoa - Middle layer Super Output Area (MSOA), a small geographical area used in the census, comprises 2,000-6,000 households and a population of 5,000 and 15,000 persons. MSOAs are made up of groups of LSOAs, usually four or five. MSOAs fit within local authorities. 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/passports-held-detailed/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 6189,
      "Europe": 5351,
      "Europe: United Kingdom": 4230,
      "Europe: Ireland": 136,
      "Europe: Other Europe": 985,
      "Europe: Other Europe: EU Member countries": 896,
      "Europe: Other Europe: EU Member countries: France": 137,
      "Europe: Other Europe: EU Member countries: Germany": 36,
      "Europe: Other Europe: EU Member countries: Italy": 179,
      "Europe: Other Europe: EU Member countries: Portugal": 41,
      "Europe: Other Europe: EU Member countries: Spain": 116,
      "Europe: Other Europe: EU Member countries: Lithuania": 31,
      "Europe: Other Europe: EU Member countries: Poland": 87,
      "Europe: Other Europe: EU Member countries: Romania": 40,
      "Europe: Other Europe: EU Member countries: Other EU countries": 229,
      "Europe: Other Europe: Rest of Europe": 89,
      "Europe: Other Europe: Rest of Europe: Turkey": 17,
      "Europe: Other Europe: Rest of Europe: Other Europe": 72,
      "Africa": 57,
      "Africa: North Africa": 18,
      "Africa: Central and Western Africa": 16,
      "Africa: Central and Western Africa: Ghana": 5,
      "Africa: Central and Western Africa: Nigeria": 8,
      "Africa: Central and Western Africa: Other Central and Western Africa": 3,
      "Africa: South and Eastern Africa": 23,
      "Africa: South and Eastern Africa: Kenya": 0,
      "Africa: South and Eastern Africa: Somalia": 0,
      "Africa: South and Eastern Africa: South Africa": 12,
      "Africa: South and Eastern Africa: Zimbabwe": 4,
      "Africa: South and Eastern Africa: Other South and Eastern Africa": 7,
      "Middle East and Asia": 315,
      "Middle East and Asia: Middle East": 24,
      "Middle East and Asia: Middle East: Iran": 15,
      "Middle East and Asia: Middle East: Iraq": 1,
      "Middle East and Asia: Middle East: Other Middle East": 8,
      "Middle East and Asia: Eastern Asia": 172,
      "Middle East and Asia: Eastern Asia: China": 101,
      "Middle East and Asia: Eastern Asia: Hong Kong (Special Administrative Region of China)": 17,
      "Middle East and Asia: Eastern Asia: Japan": 29,
      "Middle East and Asia: Eastern Asia: Other Eastern Asia": 25,
      "Middle East and Asia: Southern Asia": 59,
      "Middle East and Asia: Southern Asia: Afghanistan": 1,
      "Middle East and Asia: Southern Asia: Bangladesh": 2,
      "Middle East and Asia: Southern Asia: India": 40,
      "Middle East and Asia: Southern Asia: Pakistan": 8,
      "Middle East and Asia: Southern Asia: Sri Lanka": 2,
      "Middle East and Asia: Southern Asia: Other Southern Asia": 6,
      "Middle East and Asia: South-East Asia": 59,
      "Middle East and Asia: South-East Asia: Malaysia": 17,
      "Middle East and Asia: South-East Asia: Philippines": 26,
      "Middle East and Asia: South-East Asia: Singapore": 3,
      "Middle East and Asia: South-East Asia: Other South-East Asia": 13,
      "Middle East and Asia: Central Asia": 1,
      "The Americas and the Caribbean": 172,
      "The Americas and the Caribbean: North America": 118,
      "The Americas and the Caribbean: North America: Canada": 25,
      "The Americas and the Caribbean: North America: United States": 93,
      "The Americas and the Caribbean: Central America": 5,
      "The Americas and the Caribbean: South America": 41,
      "The Americas and the Caribbean: The Caribbean": 8,
      "The Americas and the Caribbean: The Caribbean: Jamaica": 4,
      "The Americas and the Caribbean: The Caribbean: Other Caribbean": 4,
      "Antarctica and Oceania": 43,
      "Antarctica and Oceania: Australasia": 42,
      "Antarctica and Oceania: Australasia: Australia": 32,
      "Antarctica and Oceania: Australasia: New Zealand": 10,
      "Antarctica and Oceania: Other Antarctica and Oceania": 1,
      "British Overseas Territories": 0,
      "No passport held": 251
    },
    "rank": {
      "Europe": 8,
      "Europe: United Kingdom": 4,
      "Europe: Ireland": 8,
      "Europe: Other Europe": 7,
      "Europe: Other Europe: EU Member countries": 7,
      "Europe: Other Europe: EU Member countries: France": 7,
      "Europe: Other Europe: EU Member countries: Germany": 6,
      "Europe: Other Europe: EU Member countries: Italy": 7,
      "Europe: Other Europe: EU Member countries: Portugal": 3,
      "Europe: Other Europe: EU Member countries: Spain": 6,
      "Europe: Other Europe: EU Member countries: Lithuania": 3,
      "Europe: Other Europe: EU Member countries: Poland": 4,
      "Europe: Other Europe: EU Member countries: Romania": 2,
      "Europe: Other Europe: EU Member countries: Other EU countries": 6,
      "Europe: Other Europe: Rest of Europe": 7,
      "Europe: Other Europe: Rest of Europe: Turkey": 5,
      "Europe: Other Europe: Rest of Europe: Other Europe": 7,
      "Africa": 4,
      "Africa: North Africa": 5,
      "Africa: Central and Western Africa": 2,
      "Africa: Central and Western Africa: Ghana": 2,
      "Africa: Central and Western Africa: Nigeria": 2,
      "Africa: Central and Western Africa: Other Central and Western Africa": 2,
      "Africa: South and Eastern Africa": 6,
      "Africa: South and Eastern Africa: Kenya": 1,
      "Africa: South and Eastern Africa: Somalia": 1,
      "Africa: South and Eastern Africa: South Africa": 5,
      "Africa: South and Eastern Africa: Zimbabwe": 3,
      "Africa: South and Eastern Africa: Other South and Eastern Africa": 4,
      "Middle East and Asia": 5,
      "Middle East and Asia: Middle East": 4,
      "Middle East and Asia: Middle East: Iran": 6,
      "Middle East and Asia: Middle East: Iraq": 2,
      "Middle East and Asia: Middle East: Other Middle East": 3,
      "Middle East and Asia: Eastern Asia": 6,
      "Middle East and Asia: Eastern Asia: China": 5,
      "Middle East and Asia: Eastern Asia: Hong Kong (Special Administrative Region of China)": 6,
      "Middle East and Asia: Eastern Asia: Japan": 5,
      "Middle East and Asia: Eastern Asia: Other Eastern Asia": 6,
      "Middle East and Asia: Southern Asia": 2,
      "Middle East and Asia: Southern Asia: Afghanistan": 2,
      "Middle East and Asia: Southern Asia: Bangladesh": 1,
      "Middle East and Asia: Southern Asia: India": 2,
      "Middle East and Asia: Southern Asia: Pakistan": 2,
      "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": 6,
      "Middle East and Asia: South-East Asia: Malaysia": 6,
      "Middle East and Asia: South-East Asia: Philippines": 5,
      "Middle East and Asia: South-East Asia: Singapore": 4,
      "Middle East and Asia: South-East Asia: Other South-East Asia": 5,
      "Middle East and Asia: Central Asia": 2,
      "The Americas and the Caribbean": 5,
      "The Americas and the Caribbean: North America": 5,
      "The Americas and the Caribbean: North America: Canada": 7,
      "The Americas and the Caribbean: North America: United States": 5,
      "The Americas and the Caribbean: Central America": 5,
      "The Americas and the Caribbean: South America": 6,
      "The Americas and the Caribbean: The Caribbean": 4,
      "The Americas and the Caribbean: The Caribbean: Jamaica": 3,
      "The Americas and the Caribbean: The Caribbean: Other Caribbean": 4,
      "Antarctica and Oceania": 6,
      "Antarctica and Oceania: Australasia": 6,
      "Antarctica and Oceania: Australasia: Australia": 6,
      "Antarctica and Oceania: Australasia: New Zealand": 5,
      "Antarctica and Oceania: Other Antarctica and Oceania": 2,
      "British Overseas Territories": 1,
      "No passport held": 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!"
}