Search API

API Endpoints

Census Demographics

Passports Held

Tokens
× 1

API Credit Cost

Endpoint Overview

Census2021 Demographics

The Passports Held endpoint lists the types of passports held by residents in a postcode area, offering insights into nationality and citizenship.

Coverage

EnglandEngland
WalesWales

Update Frequency

Census

Request Format

HTTP Method:

GET

To use the API you should send an HTTP request to the following endpoint URL. This will return a JSON response.

https://api.postcodearea.co.uk/v1/census-ts005/?key=&postcode={postcode}

Note that your key has automatically been added to the API endpoint for convenience.

Querystring Parameters:

{postcode}

A valid UK postcode (e.g., SW1A 1AA). Note that you can send the postcode with or without the space separating the outward and inward codes. For example, both "SW1A 1AA" and "SW1A1AA" are both valid.

{api_key}

A valid API key that authenticates your account.

Authorisation

For every endpoint request your API Key should be sent as part of the querystring:

https://api.postcodearea.co.uk/v1/census-ts005/?key={api_key}&postcode=WS3+3PD

For example:

https://api.postcodearea.co.uk/v1/census-ts005/?key=&postcode=WS3+3PD

Example Request and Response

If the above URL endpoint exists and the API key is valid, our system will return the following example response:

https://api.postcodearea.co.uk/v1/census-ts005/?key=&postcode=WS3+3PD
{"data":[{"Postcode":"ST20 0LY","Total":310,"Europe":293,"Europe; United Kingdom":292,"Europe; Ireland":0,"Europe; Other Europe":1,"Europe; Other Europe; EU Member":1,"Europe; France":0,"Europe; Germany":0,"Europe; Italy":0,"Europe; Portugal":0,"Europe; Spain":0,"Europe; Lithuania":0,"Europe; Poland":0,"Europe; Romania":1,"Europe; Other EU countries":0,"Europe; Rest of Europe":0,"Europe; Turkey":0,"Europe; Other Europe":0,"Africa":0,"Africa; North Africa":0,"Africa; Central and Western Africa":0,"Africa; South and Eastern Africa":0,"Middle East and Asia":0,"Middle East and Asia; Middle East":0,"Middle East and Asia; Eastern Asia":0,"Middle East and Asia; Southern Asia":0,"Middle East and Asia; South-East Asia":0,"Middle East and Asia; Central Asia":0,"The Americas and the Caribbean":0,"The Americas and the Caribbean; North America and the Caribbean":0,"The Americas and the Caribbean; Central and South America":0,"Antarctica and Oceania inc Australasia":0,"British Overseas Territories":0,"No passport held":17}],"response_time":0.1562,"Source":"PostcodeArea API","Output Area":"OA","Radius":10,"Distance Unit":"Mile","Records":1,"Unique Fields":1,"Referrer":"api.postcodearea.co.uk"}

Error Handling

HTTP Status Code Error Message Reason
400 Invalid postcode format The postcode provided is not valid.
401 Unauthorised request API key missing or invalid.
404 Postcode not found No data available for the given postcode.
404 No Results Found No data available for the given radius.
429 Too many requests Exceeded rate limit.
500 Internal server error An unexpected issue occurred.

Caching Policy

You may temporarily cache data retrieved from the API for performance optimisation purposes, provided that the cached data is:

  1. Stored in-memory only (e.g., application-level cache).
  2. Retained for no longer than one hour.

Caching API data to any persistent storage, including but not limited to databases, files, or external systems, constitutes a breach of our API Terms and Conditions. Such actions are strictly prohibited to ensure data accuracy and compliance with our licensing agreements.

If you have specific requirements for extended caching, you must seek prior written consent from us.

Get started today

Ready to use this data for your own business or organisation? Sign up today and get immediate access to all the PostcodeArea API endpoints.

Sign up and access the API-or-Explore the docs

Share this page