diff --git a/api/app/queries/scottish_postcodes.ts b/api/app/queries/scottish_postcodes.ts index f31c38809..fe9ca9e43 100644 --- a/api/app/queries/scottish_postcodes.ts +++ b/api/app/queries/scottish_postcodes.ts @@ -29,7 +29,9 @@ export interface ScottishPostcodeRow { local_government_district_1991: string | null; uk_parliamentary_constituency: string | null; scottish_parliamentary_region: string | null; + scottish_parliamentary_region_2021: string | null; scottish_parliamentary_constituency: string | null; + scottish_parliamentary_constituency_2021: string | null; health_board_area: string | null; health_board_area_2006: string | null; health_board_area_1995: string | null; @@ -83,7 +85,9 @@ export interface ScottishPostcodeRow { local_government_district_1991_code: string | null; uk_parliamentary_constituency_code: string | null; scottish_parliamentary_region_code: string | null; + scottish_parliamentary_region_2021_code: string | null; scottish_parliamentary_constituency_code: string | null; + scottish_parliamentary_constituency_2021_code: string | null; health_board_area_code: string | null; health_board_area_2006_code: string | null; health_board_area_1995_code: string | null; @@ -123,8 +127,10 @@ const SELECT_COLUMNS = ` local_government_district_1995_name AS local_government_district, local_government_district_1991_name AS local_government_district_1991, uk_parliamentary_constituency_2024_name AS uk_parliamentary_constituency, - scottish_parliamentary_region_2021_name AS scottish_parliamentary_region, - scottish_parliamentary_constituency_2021_name AS scottish_parliamentary_constituency, + scottish_parliamentary_region_2025_name AS scottish_parliamentary_region, + scottish_parliamentary_region_2021_name AS scottish_parliamentary_region_2021, + scottish_parliamentary_constituency_2025_name AS scottish_parliamentary_constituency, + scottish_parliamentary_constituency_2021_name AS scottish_parliamentary_constituency_2021, health_board_area_2019_name AS health_board_area, health_board_area_2006_name AS health_board_area_2006, health_board_area_1995_name AS health_board_area_1995, @@ -177,8 +183,10 @@ const SELECT_COLUMNS = ` local_government_district_1995_code AS local_government_district_code, local_government_district_1991_code AS local_government_district_1991_code, uk_parliamentary_constituency_2024_code AS uk_parliamentary_constituency_code, - scottish_parliamentary_region_2021_code AS scottish_parliamentary_region_code, - scottish_parliamentary_constituency_2021_code AS scottish_parliamentary_constituency_code, + scottish_parliamentary_region_2025_code AS scottish_parliamentary_region_code, + scottish_parliamentary_region_2021_code AS scottish_parliamentary_region_2021_code, + scottish_parliamentary_constituency_2025_code AS scottish_parliamentary_constituency_code, + scottish_parliamentary_constituency_2021_code AS scottish_parliamentary_constituency_2021_code, health_board_area_2019_code AS health_board_area_code, health_board_area_2006_code AS health_board_area_2006_code, health_board_area_1995_code AS health_board_area_1995_code, @@ -251,7 +259,9 @@ export const toJson = (row: ScottishPostcodeRow) => ({ local_government_district_1991: row.local_government_district_1991, uk_parliamentary_constituency: row.uk_parliamentary_constituency, scottish_parliamentary_region: row.scottish_parliamentary_region, + scottish_parliamentary_region_2021: row.scottish_parliamentary_region_2021, scottish_parliamentary_constituency: row.scottish_parliamentary_constituency, + scottish_parliamentary_constituency_2021: row.scottish_parliamentary_constituency_2021, health_board_area: row.health_board_area, health_board_area_2006: row.health_board_area_2006, health_board_area_1995: row.health_board_area_1995, @@ -302,7 +312,9 @@ export const toJson = (row: ScottishPostcodeRow) => ({ local_government_district_1991: row.local_government_district_1991_code, uk_parliamentary_constituency: row.uk_parliamentary_constituency_code, scottish_parliamentary_region: row.scottish_parliamentary_region_code, + scottish_parliamentary_region_2021: row.scottish_parliamentary_region_2021_code, scottish_parliamentary_constituency: row.scottish_parliamentary_constituency_code, + scottish_parliamentary_constituency_2021: row.scottish_parliamentary_constituency_2021_code, health_board_area: row.health_board_area_code, health_board_area_2006: row.health_board_area_2006_code, health_board_area_1995: row.health_board_area_1995_code, diff --git a/build/404.html b/build/404.html index d58f30961..7e4804695 100644 --- a/build/404.html +++ b/build/404.html @@ -4,7 +4,7 @@
codes object",id:"codes-object",level:3}];function o(e){const n={admonition:"admonition",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["The Scottish Postcode schema represents the full set of geographies the Scottish Postcode Directory (SPD) ships against a postcode: administrative, electoral, health, statistical, and census. It is returned by the ",(0,s.jsx)(n.code,{children:"/scotland/postcodes/:postcode"})," endpoint."]}),"\n",(0,s.jsxs)(n.p,{children:["Top-level fields hold the ",(0,s.jsx)(n.strong,{children:"canonical (latest)"})," value for each datapoint. Year-suffixed fields surface prior versions where SPD publishes them (e.g. ",(0,s.jsx)(n.code,{children:"data_zone"})," is the 2022 Data Zone; ",(0,s.jsx)(n.code,{children:"data_zone_2011"})," and ",(0,s.jsx)(n.code,{children:"data_zone_2001"})," are historical baselines). The ",(0,s.jsx)(n.code,{children:"codes"})," object mirrors the same datapoints with their GSS / official codes."]}),"\n",(0,s.jsx)(n.admonition,{title:"Scottish Parliament 2025 boundaries",type:"note",children:(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"scottish_parliamentary_constituency"})," and ",(0,s.jsx)(n.code,{children:"scottish_parliamentary_region"})," now hold the ",(0,s.jsx)(n.strong,{children:"2025"})," designation (Second Review of Scottish Parliament Boundaries, SSI 2025/285), which took effect at the 7 May 2026 Holyrood election - boundaries ",(0,s.jsx)(n.strong,{children:"and"})," names changed. The superseded 2021 values moved to ",(0,s.jsx)(n.code,{children:"scottish_parliamentary_constituency_2021"})," and ",(0,s.jsx)(n.code,{children:"scottish_parliamentary_region_2021"}),". Consumers pinned to the 2021 boundaries should read the ",(0,s.jsx)(n.code,{children:"_2021"})," fields."]})}),"\n",(0,s.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-json",children:'{\n "status": 200,\n "result": {\n "postcode": "AB10 1XG",\n "postcode_district": "AB10",\n "postcode_sector": "AB10 1",\n "incode": "1XG",\n "outcode": "AB10",\n "user_type": "0",\n "date_of_introduction": "199406",\n "date_of_deletion": null,\n "longitude": -2.10250,\n "latitude": 57.14945,\n "eastings": 393859,\n "northings": 806073,\n "council_area": "Aberdeen City",\n "electoral_ward": "Midstocket/Rosemount",\n "uk_parliamentary_constituency": "Aberdeen South",\n "scottish_parliamentary_region": "North East Scotland",\n "scottish_parliamentary_region_2021": "North East Scotland",\n "scottish_parliamentary_constituency": "Aberdeen Central",\n "scottish_parliamentary_constituency_2021": "Aberdeen Central",\n "health_board_area": "Grampian",\n "integration_authority": "Aberdeen City",\n "data_zone": "West End North - 01",\n "data_zone_2011": "S01006571",\n "intermediate_zone": "West End North",\n "output_area": "S00136537",\n "locality": "Aberdeen",\n "settlement": "Aberdeen, Milltimber, and Peterculter",\n "civil_parish": "Old Machar",\n "island": "Mainland of Scotland",\n "national_park": null,\n "travel_to_work_area": "Aberdeen",\n "lau_level_1": "Aberdeen City",\n "itl_level_2": "North Eastern Scotland",\n "itl_level_3": "Aberdeen City and Aberdeenshire",\n "urban_rural_6_fold": "1",\n "urban_rural_8_fold": "1",\n "scottish_index_of_multiple_deprivation": 6414,\n "census_household_count": 0,\n "census_population_count": 0,\n "codes": {\n "council_area": "S12000033",\n "electoral_ward": "S13002841",\n "uk_parliamentary_constituency": "S14000061",\n "scottish_parliamentary_region": "S17000026",\n "scottish_parliamentary_region_2021": "S17000014",\n "scottish_parliamentary_constituency": "S16000151",\n "scottish_parliamentary_constituency_2021": "S16000074",\n "health_board_area": "S08000020",\n "integration_authority": "S37000002",\n "data_zone": "S01013550",\n "intermediate_zone": "S02002527",\n "locality": "S19000001",\n "settlement": "S20000001",\n "civil_parish": "S07000001",\n "national_park": null,\n "travel_to_work_area": "S22000047"\n }\n }\n}\n'})}),"\n",(0,s.jsx)(n.h2,{id:"reference",children:"Reference"}),"\n",(0,s.jsx)(n.h3,{id:"identity--spatial",children:"Identity & spatial"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"postcode"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Royal Mail postcode (canonical formatting with single space)."}),(0,s.jsx)(n.td,{children:'"AB10 1XG"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"pc_compact"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Postcode with all spaces removed."}),(0,s.jsx)(n.td,{children:'"AB101XG"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"postcode_district"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Equivalent to the outward code."}),(0,s.jsx)(n.td,{children:'"AB10"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"postcode_sector"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Outward code plus the first character of the inward code."}),(0,s.jsx)(n.td,{children:'"AB10 1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"outcode"})," / ",(0,s.jsx)(n.code,{children:"incode"})]}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Outward / inward halves of the postcode."}),(0,s.jsx)(n.td,{children:'"AB10" / "1XG"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"user_type"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:'SPD user type ("0" = small user, "1" = large user).'}),(0,s.jsx)(n.td,{children:'"0"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"date_of_introduction"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Date the postcode was introduced (YYYYMM)."}),(0,s.jsx)(n.td,{children:'"199406"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"date_of_deletion"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsxs)(n.td,{children:["Date the postcode was deleted (YYYYMM); ",(0,s.jsx)(n.code,{children:"null"})," for live postcodes."]}),(0,s.jsx)(n.td,{children:"null"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"linked_small_user_postcode"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"For large-user postcodes, the linked small-user postcode (if any)."}),(0,s.jsx)(n.td,{children:"null"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"longitude"})," / ",(0,s.jsx)(n.code,{children:"latitude"})]}),(0,s.jsx)(n.td,{children:"number | null"}),(0,s.jsx)(n.td,{children:"WGS84 coordinates."}),(0,s.jsx)(n.td,{children:"-2.10250"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"eastings"})," / ",(0,s.jsx)(n.code,{children:"northings"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"OS National Grid grid reference (1m resolution)."}),(0,s.jsx)(n.td,{children:"393859"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"split_indicator"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Marks postcodes that span more than one administrative unit."}),(0,s.jsx)(n.td,{children:'"0"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"grid_link_indicator"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"How the postcode was linked to its grid reference."}),(0,s.jsx)(n.td,{children:'"1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"grid_link_positional_accuracy"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Positional accuracy of the grid reference."}),(0,s.jsx)(n.td,{children:'"1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"never_digitised"})}),(0,s.jsx)(n.td,{children:"boolean"}),(0,s.jsx)(n.td,{children:"True if the postcode has never been digitised (no grid reference established)."}),(0,s.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"administrative-geographies",children:"Administrative geographies"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"council_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2019 council area name (current unitary authority)."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"electoral_ward"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 electoral ward name."}),(0,s.jsx)(n.td,{children:'"Midstocket/Rosemount"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"local_government_district"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1995 local government district name (pre-unitary boundary)."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"local_government_district_1991"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1991 local government district name (historical)."}),(0,s.jsx)(n.td,{children:'"City of Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"enterprise_region"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2008 enterprise region name."}),(0,s.jsx)(n.td,{children:'"Highlands and Islands"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"registration_district"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2007 registration district code. (SPD provides codes only \u2014 no names.)"}),(0,s.jsx)(n.td,{children:'"RD20"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"strategic_development_planning_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2013 SDPA code."}),(0,s.jsx)(n.td,{children:'"SD01"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"civil_parish"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1930 Scottish civil parish name (latest historical baseline)."}),(0,s.jsx)(n.td,{children:'"Old Machar"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"island"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:'Island name; "Mainland of Scotland" for non-island postcodes.'}),(0,s.jsx)(n.td,{children:'"Mainland of Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"national_park"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2010 national park name (Cairngorms / Loch Lomond and the Trossachs)."}),(0,s.jsx)(n.td,{children:"null"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"parliamentary",children:"Parliamentary"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"uk_parliamentary_constituency"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2024 UK Parliamentary constituency."}),(0,s.jsx)(n.td,{children:'"Aberdeen South"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_parliamentary_region"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:"2025"})," Scottish Parliamentary region (current; SSI 2025/285, 7 May 2026 election)."]}),(0,s.jsx)(n.td,{children:'"North East Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_parliamentary_region_2021"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2021 Scottish Parliamentary region (superseded)."}),(0,s.jsx)(n.td,{children:'"North East Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_parliamentary_constituency"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:"2025"})," Scottish Parliamentary constituency (current; SSI 2025/285, 7 May 2026 election)."]}),(0,s.jsx)(n.td,{children:'"Aberdeen Central"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_parliamentary_constituency_2021"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2021 Scottish Parliamentary constituency (superseded)."}),(0,s.jsx)(n.td,{children:'"Aberdeen Central"'})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"health",children:"Health"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"health_board_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2019 NHS health board area (operational)."}),(0,s.jsx)(n.td,{children:'"Grampian"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"health_board_area_2006"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2006 health board area (historical)."}),(0,s.jsx)(n.td,{children:'"Grampian"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"health_board_area_1995"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1995 health board area (historical)."}),(0,s.jsx)(n.td,{children:'"Grampian"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"integration_authority"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2019 health and social care integration authority."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"statistical--census",children:"Statistical & census"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"output_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 census Output Area code (smallest census geography)."}),(0,s.jsx)(n.td,{children:'"S00136537"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"output_area_2011"})," / ",(0,s.jsx)(n.code,{children:"output_area_2001"})," / ",(0,s.jsx)(n.code,{children:"output_area_1991"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical Output Area codes."}),(0,s.jsx)(n.td,{children:'"S00088970"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"data_zone"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 Data Zone name (Scottish equivalent of LSOA)."}),(0,s.jsx)(n.td,{children:'"West End North - 01"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"data_zone_2011"})," / ",(0,s.jsx)(n.code,{children:"data_zone_2001"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical Data Zone codes."}),(0,s.jsx)(n.td,{children:'"S01006571"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"intermediate_zone"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 Intermediate Zone name (Scottish equivalent of MSOA)."}),(0,s.jsx)(n.td,{children:'"West End North"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"intermediate_zone_2011"})," / ",(0,s.jsx)(n.code,{children:"intermediate_zone_2001"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical Intermediate Zone codes."}),(0,s.jsx)(n.td,{children:'"S02000007"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"locality"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 locality name."}),(0,s.jsx)(n.td,{children:'"Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"locality_2020"})," / ",(0,s.jsx)(n.code,{children:"locality_2001"})," / ",(0,s.jsx)(n.code,{children:"locality_1991"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical locality names."}),(0,s.jsx)(n.td,{children:'"Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"settlement"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 settlement name."}),(0,s.jsx)(n.td,{children:'"Aberdeen, Milltimber, and Peterculter"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"settlement_2020"})," / ",(0,s.jsx)(n.code,{children:"settlement_2001"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical settlement names."}),(0,s.jsx)(n.td,{children:'"Aberdeen Settlement"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"travel_to_work_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2011 Travel to Work Area."}),(0,s.jsx)(n.td,{children:'"Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"lau_level_1"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2025 LAU level 1 name (replaces previous NUTS classifications)."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"itl_level_2"})," / ",(0,s.jsx)(n.code,{children:"itl_level_3"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2025 ITL level 2 / 3 names (replaces NUTS 2 / 3)."}),(0,s.jsx)(n.td,{children:'"North Eastern Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"urban_rural_6_fold"})," / ",(0,s.jsx)(n.code,{children:"urban_rural_8_fold"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 Scottish Government urban-rural classification codes."}),(0,s.jsx)(n.td,{children:'"1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_index_of_multiple_deprivation"})}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"SIMD 2020 rank for the postcode's Data Zone (1 = most deprived, 6976 = least deprived)."}),(0,s.jsx)(n.td,{children:"6414"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"roa_community_planning_partnership"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2006 Community Planning Partnership name."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"roa_local"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2006 Regional Outcome Agreement local authority."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count"})," / ",(0,s.jsx)(n.code,{children:"census_population_count"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 2022 census. May be 0 for empty / zero-suppressed postcodes."}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count_2011"})," / ",(0,s.jsx)(n.code,{children:"census_population_count_2011"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 2011 census."}),(0,s.jsx)(n.td,{children:"8 / 18"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count_2001"})," / ",(0,s.jsx)(n.code,{children:"census_population_count_2001"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 2001 census."}),(0,s.jsx)(n.td,{children:"12 / 26"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count_1991"})," / ",(0,s.jsx)(n.code,{children:"census_population_count_1991"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 1991 census."}),(0,s.jsx)(n.td,{children:"null"})]})]})]}),"\n",(0,s.jsxs)(n.h3,{id:"codes-object",children:[(0,s.jsx)(n.code,{children:"codes"})," object"]}),"\n",(0,s.jsxs)(n.p,{children:["Mirrors every name field above with its GSS / official code, where SPD publishes one. Where SPD ships only a code (e.g. ",(0,s.jsx)(n.code,{children:"registration_district"}),", ",(0,s.jsx)(n.code,{children:"strategic_development_planning_area"}),"), the same value appears as the top-level field. Pseudo codes (e.g. ",(0,s.jsx)(n.code,{children:"S99999999"}),") appear where a geography does not apply."]})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},31736(e,n,t){t.d(n,{R:()=>i,x:()=>l});var d=t(20489);const s={},r=d.createContext(s);function i(e){const n=d.useContext(r);return d.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),d.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/2b8f49f9.a97c08f0.js b/build/assets/js/2b8f49f9.a97c08f0.js
deleted file mode 100644
index 15804d122..000000000
--- a/build/assets/js/2b8f49f9.a97c08f0.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[759],{9856(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>i,metadata:()=>d,toc:()=>h});const d=JSON.parse('{"id":"scottish-postcode/schema","title":"Scottish Postcode Schema","description":"The Scottish Postcode schema represents the full set of geographies the Scottish Postcode Directory (SPD) ships against a postcodepostcode endpoint.","source":"@site/docs/scottish-postcode/schema.mdx","sourceDirName":"scottish-postcode","slug":"/scottish-postcode/schema","permalink":"/docs/scottish-postcode/schema","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"sidebar_label":"Schema","title":"Scottish Postcode Schema"},"sidebar":"docsSidebar","previous":{"title":"Lookup","permalink":"/docs/terminated-postcode/lookup"},"next":{"title":"Lookup","permalink":"/docs/scottish-postcode/lookup"}}');var s=t(31325),r=t(31736);const i={sidebar_label:"Schema",title:"Scottish Postcode Schema"},l=void 0,c={},h=[{value:"Example",id:"example",level:2},{value:"Reference",id:"reference",level:2},{value:"Identity & spatial",id:"identity--spatial",level:3},{value:"Administrative geographies",id:"administrative-geographies",level:3},{value:"Parliamentary",id:"parliamentary",level:3},{value:"Health",id:"health",level:3},{value:"Statistical & census",id:"statistical--census",level:3},{value:"codes object",id:"codes-object",level:3}];function o(e){const n={code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["The Scottish Postcode schema represents the full set of geographies the Scottish Postcode Directory (SPD) ships against a postcode: administrative, electoral, health, statistical, and census. It is returned by the ",(0,s.jsx)(n.code,{children:"/scotland/postcodes/:postcode"})," endpoint."]}),"\n",(0,s.jsxs)(n.p,{children:["Top-level fields hold the ",(0,s.jsx)(n.strong,{children:"canonical (latest)"})," value for each datapoint. Year-suffixed fields surface prior versions where SPD publishes them (e.g. ",(0,s.jsx)(n.code,{children:"data_zone"})," is the 2022 Data Zone; ",(0,s.jsx)(n.code,{children:"data_zone_2011"})," and ",(0,s.jsx)(n.code,{children:"data_zone_2001"})," are historical baselines). The ",(0,s.jsx)(n.code,{children:"codes"})," object mirrors the same datapoints with their GSS / official codes."]}),"\n",(0,s.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-json",children:'{\n "status": 200,\n "result": {\n "postcode": "AB10 1XG",\n "postcode_district": "AB10",\n "postcode_sector": "AB10 1",\n "incode": "1XG",\n "outcode": "AB10",\n "user_type": "0",\n "date_of_introduction": "199406",\n "date_of_deletion": null,\n "longitude": -2.10250,\n "latitude": 57.14945,\n "eastings": 393859,\n "northings": 806073,\n "council_area": "Aberdeen City",\n "electoral_ward": "Midstocket/Rosemount",\n "uk_parliamentary_constituency": "Aberdeen South",\n "scottish_parliamentary_region": "North East Scotland",\n "scottish_parliamentary_constituency": "Aberdeen Central",\n "health_board_area": "Grampian",\n "integration_authority": "Aberdeen City",\n "data_zone": "West End North - 01",\n "data_zone_2011": "S01006571",\n "intermediate_zone": "West End North",\n "output_area": "S00136537",\n "locality": "Aberdeen",\n "settlement": "Aberdeen, Milltimber, and Peterculter",\n "civil_parish": "Old Machar",\n "island": "Mainland of Scotland",\n "national_park": null,\n "travel_to_work_area": "Aberdeen",\n "lau_level_1": "Aberdeen City",\n "itl_level_2": "North Eastern Scotland",\n "itl_level_3": "Aberdeen City and Aberdeenshire",\n "urban_rural_6_fold": "1",\n "urban_rural_8_fold": "1",\n "scottish_index_of_multiple_deprivation": 6414,\n "census_household_count": 0,\n "census_population_count": 0,\n "codes": {\n "council_area": "S12000033",\n "electoral_ward": "S13002841",\n "uk_parliamentary_constituency": "S14000061",\n "scottish_parliamentary_region": "S17000016",\n "scottish_parliamentary_constituency": "S16000094",\n "health_board_area": "S08000020",\n "integration_authority": "S37000002",\n "data_zone": "S01013550",\n "intermediate_zone": "S02002527",\n "locality": "S19000001",\n "settlement": "S20000001",\n "civil_parish": "S07000001",\n "national_park": null,\n "travel_to_work_area": "S22000047"\n }\n }\n}\n'})}),"\n",(0,s.jsx)(n.h2,{id:"reference",children:"Reference"}),"\n",(0,s.jsx)(n.h3,{id:"identity--spatial",children:"Identity & spatial"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"postcode"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Royal Mail postcode (canonical formatting with single space)."}),(0,s.jsx)(n.td,{children:'"AB10 1XG"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"pc_compact"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Postcode with all spaces removed."}),(0,s.jsx)(n.td,{children:'"AB101XG"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"postcode_district"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Equivalent to the outward code."}),(0,s.jsx)(n.td,{children:'"AB10"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"postcode_sector"})}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Outward code plus the first character of the inward code."}),(0,s.jsx)(n.td,{children:'"AB10 1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"outcode"})," / ",(0,s.jsx)(n.code,{children:"incode"})]}),(0,s.jsx)(n.td,{children:"string"}),(0,s.jsx)(n.td,{children:"Outward / inward halves of the postcode."}),(0,s.jsx)(n.td,{children:'"AB10" / "1XG"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"user_type"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:'SPD user type ("0" = small user, "1" = large user).'}),(0,s.jsx)(n.td,{children:'"0"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"date_of_introduction"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Date the postcode was introduced (YYYYMM)."}),(0,s.jsx)(n.td,{children:'"199406"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"date_of_deletion"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsxs)(n.td,{children:["Date the postcode was deleted (YYYYMM); ",(0,s.jsx)(n.code,{children:"null"})," for live postcodes."]}),(0,s.jsx)(n.td,{children:"null"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"linked_small_user_postcode"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"For large-user postcodes, the linked small-user postcode (if any)."}),(0,s.jsx)(n.td,{children:"null"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"longitude"})," / ",(0,s.jsx)(n.code,{children:"latitude"})]}),(0,s.jsx)(n.td,{children:"number | null"}),(0,s.jsx)(n.td,{children:"WGS84 coordinates."}),(0,s.jsx)(n.td,{children:"-2.10250"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"eastings"})," / ",(0,s.jsx)(n.code,{children:"northings"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"OS National Grid grid reference (1m resolution)."}),(0,s.jsx)(n.td,{children:"393859"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"split_indicator"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Marks postcodes that span more than one administrative unit."}),(0,s.jsx)(n.td,{children:'"0"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"grid_link_indicator"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"How the postcode was linked to its grid reference."}),(0,s.jsx)(n.td,{children:'"1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"grid_link_positional_accuracy"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Positional accuracy of the grid reference."}),(0,s.jsx)(n.td,{children:'"1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"never_digitised"})}),(0,s.jsx)(n.td,{children:"boolean"}),(0,s.jsx)(n.td,{children:"True if the postcode has never been digitised (no grid reference established)."}),(0,s.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"administrative-geographies",children:"Administrative geographies"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"council_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2019 council area name (current unitary authority)."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"electoral_ward"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 electoral ward name."}),(0,s.jsx)(n.td,{children:'"Midstocket/Rosemount"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"local_government_district"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1995 local government district name (pre-unitary boundary)."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"local_government_district_1991"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1991 local government district name (historical)."}),(0,s.jsx)(n.td,{children:'"City of Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"enterprise_region"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2008 enterprise region name."}),(0,s.jsx)(n.td,{children:'"Highlands and Islands"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"registration_district"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2007 registration district code. (SPD provides codes only \u2014 no names.)"}),(0,s.jsx)(n.td,{children:'"RD20"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"strategic_development_planning_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2013 SDPA code."}),(0,s.jsx)(n.td,{children:'"SD01"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"civil_parish"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1930 Scottish civil parish name (latest historical baseline)."}),(0,s.jsx)(n.td,{children:'"Old Machar"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"island"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:'Island name; "Mainland of Scotland" for non-island postcodes.'}),(0,s.jsx)(n.td,{children:'"Mainland of Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"national_park"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2010 national park name (Cairngorms / Loch Lomond and the Trossachs)."}),(0,s.jsx)(n.td,{children:"null"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"parliamentary",children:"Parliamentary"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"uk_parliamentary_constituency"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2024 UK Parliamentary constituency."}),(0,s.jsx)(n.td,{children:'"Aberdeen South"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_parliamentary_region"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2021 Scottish Parliamentary region."}),(0,s.jsx)(n.td,{children:'"North East Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_parliamentary_constituency"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2021 Scottish Parliamentary constituency."}),(0,s.jsx)(n.td,{children:'"Aberdeen Central"'})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"health",children:"Health"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"health_board_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2019 NHS health board area (operational)."}),(0,s.jsx)(n.td,{children:'"Grampian"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"health_board_area_2006"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2006 health board area (historical)."}),(0,s.jsx)(n.td,{children:'"Grampian"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"health_board_area_1995"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"1995 health board area (historical)."}),(0,s.jsx)(n.td,{children:'"Grampian"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"integration_authority"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2019 health and social care integration authority."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"statistical--census",children:"Statistical & census"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Field"}),(0,s.jsx)(n.th,{children:"Type"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"output_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 census Output Area code (smallest census geography)."}),(0,s.jsx)(n.td,{children:'"S00136537"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"output_area_2011"})," / ",(0,s.jsx)(n.code,{children:"output_area_2001"})," / ",(0,s.jsx)(n.code,{children:"output_area_1991"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical Output Area codes."}),(0,s.jsx)(n.td,{children:'"S00088970"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"data_zone"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 Data Zone name (Scottish equivalent of LSOA)."}),(0,s.jsx)(n.td,{children:'"West End North - 01"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"data_zone_2011"})," / ",(0,s.jsx)(n.code,{children:"data_zone_2001"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical Data Zone codes."}),(0,s.jsx)(n.td,{children:'"S01006571"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"intermediate_zone"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 Intermediate Zone name (Scottish equivalent of MSOA)."}),(0,s.jsx)(n.td,{children:'"West End North"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"intermediate_zone_2011"})," / ",(0,s.jsx)(n.code,{children:"intermediate_zone_2001"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical Intermediate Zone codes."}),(0,s.jsx)(n.td,{children:'"S02000007"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"locality"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 locality name."}),(0,s.jsx)(n.td,{children:'"Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"locality_2020"})," / ",(0,s.jsx)(n.code,{children:"locality_2001"})," / ",(0,s.jsx)(n.code,{children:"locality_1991"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical locality names."}),(0,s.jsx)(n.td,{children:'"Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"settlement"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 settlement name."}),(0,s.jsx)(n.td,{children:'"Aberdeen, Milltimber, and Peterculter"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"settlement_2020"})," / ",(0,s.jsx)(n.code,{children:"settlement_2001"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"Historical settlement names."}),(0,s.jsx)(n.td,{children:'"Aberdeen Settlement"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"travel_to_work_area"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2011 Travel to Work Area."}),(0,s.jsx)(n.td,{children:'"Aberdeen"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"lau_level_1"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2025 LAU level 1 name (replaces previous NUTS classifications)."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"itl_level_2"})," / ",(0,s.jsx)(n.code,{children:"itl_level_3"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2025 ITL level 2 / 3 names (replaces NUTS 2 / 3)."}),(0,s.jsx)(n.td,{children:'"North Eastern Scotland"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"urban_rural_6_fold"})," / ",(0,s.jsx)(n.code,{children:"urban_rural_8_fold"})]}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2022 Scottish Government urban-rural classification codes."}),(0,s.jsx)(n.td,{children:'"1"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"scottish_index_of_multiple_deprivation"})}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"SIMD 2020 rank for the postcode's Data Zone (1 = most deprived, 6976 = least deprived)."}),(0,s.jsx)(n.td,{children:"6414"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"roa_community_planning_partnership"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2006 Community Planning Partnership name."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"roa_local"})}),(0,s.jsx)(n.td,{children:"string | null"}),(0,s.jsx)(n.td,{children:"2006 Regional Outcome Agreement local authority."}),(0,s.jsx)(n.td,{children:'"Aberdeen City"'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count"})," / ",(0,s.jsx)(n.code,{children:"census_population_count"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 2022 census. May be 0 for empty / zero-suppressed postcodes."}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count_2011"})," / ",(0,s.jsx)(n.code,{children:"census_population_count_2011"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 2011 census."}),(0,s.jsx)(n.td,{children:"8 / 18"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count_2001"})," / ",(0,s.jsx)(n.code,{children:"census_population_count_2001"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 2001 census."}),(0,s.jsx)(n.td,{children:"12 / 26"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"census_household_count_1991"})," / ",(0,s.jsx)(n.code,{children:"census_population_count_1991"})]}),(0,s.jsx)(n.td,{children:"integer | null"}),(0,s.jsx)(n.td,{children:"Counts at the 1991 census."}),(0,s.jsx)(n.td,{children:"null"})]})]})]}),"\n",(0,s.jsxs)(n.h3,{id:"codes-object",children:[(0,s.jsx)(n.code,{children:"codes"})," object"]}),"\n",(0,s.jsxs)(n.p,{children:["Mirrors every name field above with its GSS / official code, where SPD publishes one. Where SPD ships only a code (e.g. ",(0,s.jsx)(n.code,{children:"registration_district"}),", ",(0,s.jsx)(n.code,{children:"strategic_development_planning_area"}),"), the same value appears as the top-level field. Pseudo codes (e.g. ",(0,s.jsx)(n.code,{children:"S99999999"}),") appear where a geography does not apply."]})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},31736(e,n,t){t.d(n,{R:()=>i,x:()=>l});var d=t(20489);const s={},r=d.createContext(s);function i(e){const n=d.useContext(r);return d.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),d.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/31c97d68.1b2c4a87.js b/build/assets/js/31c97d68.1b2c4a87.js
new file mode 100644
index 000000000..f7e039409
--- /dev/null
+++ b/build/assets/js/31c97d68.1b2c4a87.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[2008],{41228(e,t,i){i.r(t),i.d(t,{assets:()=>S,contentTitle:()=>f,default:()=>b,frontMatter:()=>y,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"id":"api/postcode-lookup","title":"Autocomplete Search a Postcode","description":"Query for a postcode either by:","source":"@site/docs/api/postcode-lookup.api.mdx","sourceDirName":"api","slug":"/api/postcode-lookup","permalink":"/docs/api/postcode-lookup","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"postcode-lookup","title":"Autocomplete Search a Postcode","description":"Query for a postcode either by:","sidebar_label":"Autocomplete Search a Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJztPItOI0mSvxKqlQ5zMsY2MN34NLqjaYZhhte2afXNTo8gXRW2czorsyYzC/C1kO4j7gvvS06RWW8bg00zuyftSLuNq/IRERkZ74qvgWUTEwx+DS6VsaGK0AS/tQOVoGaWK3kSBYPiFZwq9SVNgnYQoQk1T2hEMAj+mqKewVhpYJDkY5HbKWoYzQaf5We5BVdTLF9ya1CMoXXH7RRu/qD5399sgqLxbRp9ABNUQoUOCGjdCGa/vwEmI7gRSn5/s9mhVf/yF/B7u3VyMOnNMB3F3FbhcZu4FTSGyG8RGIQqTgRaBMGNBTUuR8fMhlM0bjwTApgxKuTMYlSOiZhlHbiacgPcgNV8MkGNEdxNURZI0SuTJongGDmY8/FoDErLmRCzKpgGmQ6ncDfl4RQSjWN+XwNGo021NMUEA1yCUZogUzpCDa2QGQQuDUrDLb/FzXLfGO1URQ6mhIW0WzamDbyDHeAWIrQYWuOO0w0yMEJ7hyhBpfaO6cjBwaX7M2HaGqKcrR5vy6gYAe8ZkdfQkowLpElgCYxfuTEp/taaWpuYwfb2hNtpOuqEKt7mETKxVWC3XfzV4WrbTTPbu7ubOU4IGk0qLBi0EDJZsB0CxomdEUslKkmFOzrHJmkCVkGv263wqrTccjQdOPLT79iMaHHH6ejFHZuZjPDAoN/t0qaJkgaBpi9gxeOSeenlh+zQJDKNxlYOz1+aCb9FCULJCbdphI7Agln343EOa94JYBqrvBa0g4RpFqNFTVf8ayBZjMEgcKwZtAMuKz+MnQl6OVY6DtoB3idCRRgMxkwYbAcmnGLMgsHXxt0vZINV/op14EBwZtDQk5s/vr9xizlOCAbB8FPvAPoHB8HDQ7uAR/CY2xXhqUNxSisYkGk8Ql29yKa4PFZlR9iB9zhmqbDG80EHzhEj92OEINAYsFMmiUM6QR1xNy0Y9LrtIGb3PE5j+kG/uMx+VZDdqeGYH+6L8DxGNdEsmfIQQqV0xCWzSOBaMAmGfMwJ0ykCMmO37jJe406IqrGTM1zaGlaWW7f/aQVAO0vokSdn0HawMRsMgkilI4HVE93qdnr9N9/t71VJ8rZKkq3e226NEhljr82ABcTlQk8D3OCXcmqByV6vs9fd2dutILJfw2O/hoZmEU/N341ru/FjfNtvd+ntwkP+kAOdEYxLixNHsZIMxM8VVq/yer9bZ/YqPe54hF55vfhgP1WXyiAdKSWQybmTHHp96YV6v/slBn8wbRilFkw6+h1DS+8YZGgQoXvdTG+YDgy5DBGEM20MqFskiUzYkDxlTqmMEG5JtuN9QgqT1OUdbtwihBqdYrEV5Up7CaHuYKZSCKdKGSccY/YF3dW0mkUIajwu9Gqm8z3gTqCXLFGAWT1+R7kOfCI1gJKNBEbt6nThGcvh0us6vcAnUmmMOjVpbHXq70Z22oFbuCabx1xYxyAvO9If8mWy4zRWczmZO80DMsliBgZJczmVPeUWc/OMWav5KLWYc72/G7llURgDyp16y2y2ATuTDngkvs+vV7sQxu1Sy8pUiEKvG6/6QyUtlymW19AN68DJGKSqguPu6zwIbSCTxBsinhO5KYCuHUUOW/Dw8Fs7KOAgGva73Xm9O0zDEA1dZQISpaUhjHS/Nzu2fzc07uuCsygsffiQbVOei4cyIAj+SLnGiFwDY5l1UsPjRg5CoslFIJvJ7eEH0B5NuVJIYi7tTp9QliQ6fu13u789FCuWM5nWzNkmFmO3opJ4MXbWyzIQC/K1A5Xmf3GZ/fFHygS3tCzpRS4nhIxU2k6zv0OVSus4W07N9ZQF7YBFMZfX7sWs+BlxYly3u39ARnDQrmn3in5LmBacxSgt07PrUElDr1CGDpSUaMjkNQoMrdJMXGuc0OkSeXnspjCN11anxuObv2WaG5KNwigCNfb/hI6lwpCuVTKmJxGzeK3G11xaraI0tH5+/tiijsmC8E+5jPCeHsepsDwReB1hovlt/v5xZK773f4uSQWUGEVNPBc8vZYqI3WBk7V3BLGHhonrhOkvQTsYpfSUhyPCjMkQ9TUTgtNfGf69XkYB9wc96edP3B/ZPzoNe9m/7rfAJPuHmFKm1rNB5v/W2btgrgWX6EmR9vHn0s/wl2EA/a1dCKdMs9CSlM/cKieagHmvq+1dT9jZKgdmPpd3sUiwtSG3pzc78DGJnMSMlbRTMYOxVjF8UDMm4Ixx0XnEDi8vTAW7iwykw+dgSF7YmGuyNZm2uZ2ZoTzCsdJe8XmXs1VD3mxm/s0EJWrnDPOI3LHCkqWVmACr7iQ5c/kNnEeHUMlufAWTE7kaIgZDJaNFmLAxnUEFkcwx3Klj8yOKxORIzHKzPARjNSIpZQ2jlIuIJI9zFrnMdmHCWRx1zHr+jHIJVudA7i8L/NW/hRMZkfhXepGFN+e3PTobWr2t/c0ODKfqzh+CF/C5n8+M4RPSuhPNKSIxRo0yRBfo+VfoDeCTR4vG5rjmc71hGwGLIk0mayiUITfFqnoIIUbmVusP4MC7yb024H2IiYXRDG65SZmgKEeCYe7enDIZCS5pk8RAaxgqK+gWKSlmm7TYzgAOkkSrex47v0nlB7DXJetNo6FRu4MilASp5NbBAi12i5pNMPIXK4Mf/RmCYXEJvNtrbwBHxrqNIoL44nwIqSFKmFRrlUpHlcLipynfVTY2TidkW8eMSzGDywt4p+7RuPXfDuAqk9/VoFRLMGPhi6TrQlvWj8jN3B/Auar4jwbYLeOCzEgXNCiYr/dQUZgVzjsqlejT+p4MJlo6GJC1uejKXTShhGxTaP3nVgnmpnN8/DmRlaVESot04AMKlpmExELvNLfcTOE8UyVwTIsTBx2/c0KVBp3oxUPOyShALeFEI/FOBz6RIThCbx/SkMMpkxIFnBga4A3uEyPIpIczJmvXd2+n291981A1Nip0PK9YIK9DyHxbaP3y/5ySvTf7+3vEkLmpVqHjYWG9PS3fP/4MpSViIVvNgeOcuPIiHckJgdWGXI604RMTaNpzqLWbmLRJylcw2azL9GxlkuuZuVlBZmjJ8ZnwEH5EJuwUDlI7Vdqbr038nuaJ8x+HMPULsXwh79jOoVwH8lTJSEmCsWYJN8m+HlRuSdLkjILP/hQWHEIHzolX7qaYmRClJcWEMGQ5GeeoZytsCbxFUUG0RZNSGaEWM7oGx8OhN5+402tO8xpMIwUmDafADNwc7Wf/3bRJUo9ZiJFfAm58ILpKj5v60RLmD3POQoVm70sH4sVUy9cnZiM9xSi/UaD+xPF+QmNjLg155Q81b6YaiPHezeqQFi7NdgNmZ4w9AdrQduAnFqPZMARa6VutHa1cDvCn4+Hb3Ur0vRJZbc3HUTc7cMZmhRzj41qmKpWFLu0sCJOSKij8w3VDmc/CJluwhozTBltGpXb6QnTyWCkJ5CVObpWVSn6Dy+oMOKy7i6sz28efGytWYXiK2Q5d4sdZj07gOSXUuByPe+pVoygbBEf5IPjgBkHr6OjD5lqYPb7ms4X3gkhC1Yfwb+GQQoRX9BZal4dX60Hr1Qxt1JRUj+gbeM/HzlKxIFlM8jlU8pYcJyUNUDBrBizUyhg6Y09ys1SMzR/LhyLAsDI+fjEmIELyd/yNWGAo0A0lBQPHFHCVxIVwMR7zELPTck7f8cUHs/noKfmITvVk3JPtQxXHJNvXuxkhv+UC/OKFQePS7GG+LrScUbO5gr5oQyr9muTHaWROSlMMqiag71DDKZuhhmGaoIaL1CaphQOasCoy/W6/B4coTWrgdHhxkMVATMyEQO3cU24sDzMXug12ltAvMYMepUO2eu09n7Z1jjn56efqzmfDjM8c9Hs+of8Y1tDtvT0kTOMGpmc8igS+CqpnJaoxj7YM/y9ciuuew/UN/f+LcSVUKaI4Z/BVhNGLrJnM6CtkKkT8lpv8jhGzEteW+f95/6FMl5EPrlKq92g4QIqiZqBcUv8RGZLZbBQ3reIquHQ0phvIDcHlDEitXAHMauiSEb5swTzvwEcCPWaCSfe6IlMN6lse+oKP7CrXD5B2ca6J019QkS7jRvxfkGz6QekQ1+NRX8vjVhm7VZ7jUJyh1YpmWSbBw0DALYxRVy1mMl3UGE7qMezVAY58qrziRNwxIqZf1ueQfvnll1/OzrI4bSMQt/+22+1VIa6GzxcAfFWLrn8reG0Z85mD13tLdAyCtG55dRaw+/Jofy2AGuG982OzgfC+lhZ4aeCCglRL94DWydn7TdBMfplnsQ2vDzrg9Q0NMhAq7S+US8bGFH/2yGX6iup8cuc+c+mLWCH9r+nfQ+oKqiJMUJJIhZOz92BCmgn/+9//A7dMpBRF0xRwsRBxjaEVM1dexjShnpsxPtzAG0fS2327u7PUkvYZlpXNaWjRvPWsuRWtahgxQyVoEn5KxYx0zC6MKMrJ5tB9ls29KJdUjZK413A4i3X6cg+itlrrEwozrSC/+ZRDARcUnc2Sr3TaVoFfpLiC/+a1FgqDLprRIAhDHc2iCC5RMm2njxCA0mbPoQGc587jt4gqrkScrHDh29Oot/tQyxhWw6g/DvP7DC8w9+eXeSYa86bKI1a+y3FWAL/SjMJVRAmlv6yvihesswj0q6tPB15KOSGYhdViRcENVCR1R8pOve4gItwp/eUxVOp52uph5IHgS5/AXeMcqis0hIwP+/mkTZuCFUzOFmk3ShtXgHqXcmG30mR9EtdWcGK1v8hlKsd5EhOxHUP5et4po2JalLDBtcZb1GTxzSDVIya5wWijTu5jV12kK5YcJcJrutnixNfJOA/+nVo3YEfMv3C1OdO0YpEWVmpe1zufvlxoky7eyTkcjRR/1SB3r+CgzP6vjmVjjUUH2BhiYESrg1UTdE4EIZRodcsj1D5jERb2PD2xCnhMAxA8MkCkqhPlwxnxtnXjWxW6bOaOdK/3bFeaeLHXW13F06w5jzqr3c3ogrBBwGzAmKOIOnAiSzPJ5jXJU4T3zDL4m5JURC7njScaMiRH3cH7PP+6ToDlHva3oMDZoxSIn0MB4mcdY0QfCDhKPOlZZ3Uqq5xyfy0cF8RN/tST7K94ki/F8uxpLFc/rSYa3xjm6nJOzW35ogsX3TIWQj9skhV/1zVecNTtdru7vbd7LgDqypyq8c9UM7H1kTQMHAqq3Bjz/Kua9e4NCdLq3VmywxMRAT8nZr+7gKQkNej2eMjLtJ6Nxzon4PHovy4ersysdsspBHREHJhobrBQBFOeQCsLx6+HSxbph6VbLNB4p0eX3lBJynHlNz/CrZanFXn2FdKIKllc+ctjBqIrrHs24kNXdbU26iafviLyzoTktmZWuqppwZKE1P7p0WUWMVhgZLqiwYY1pnPDmMI/mlulORNwSmlpA62Tq9PVERxWAr6FCIC8npACWJVdfciBG0o6lImJ849XQ9iCcxWjDAWzqXYRqo+SZx96VYEt9jP+I6sD56n/xGRKBKYb04axogp3otA7jffctv0WFKDSmAiXMx/N4OTqFFpPkWUzL97++HPns/yB6uNY+CWrdIwTZvmIU31auyiOom/BitpsZ3JlFpk/XQptZxl7WvazO6jPgVfilGlangr3RaCVcz2oJ7MO3fv5iun6qR0qaRmXXuNQ2UGrkh2qHunQh3U3ofJB2Hz2zFAQ3+IA8k/JNi593YKbtZGXg57mxQuL6mvacFZ7XSlQacN57dV8hcuw9j7Xq94HqrqTzNcKWqVnFW6NFBoXG8N7bmyHguFEB6GozsVMVSoimFL1not4Zt/VGarH2DhXlor2Mn97AzRzdrj71MWSg+TM8ynGNPqWCR7ByXt3X6v14Y+UbzfKu7Nq7qK+2tdSh+HkmkdFgXVWKyxY2p8rwfZl10vLvp8uo/6HqYueK4R+uq7FsfojxbZPxIEpY0pSYb9S8VzU6xSi+5EamKZJtE9G0c7O0+VLfzbAHo4GuPndWl6J82eDSjA06brX7e287X63LGf96mD6jRuQ7e50u93+joOsmco7PH51mJZl9xqQ7rwlSPdySEm0NIA9eb+6kTBV2malbXn9vF4HvE/9jzt/W5T7PXr/+kR8LL+85LrMGWFXpy+EsQ7TE9bLgpDX1enJTt+ZwKQhqibwwcf+erB5q7Zhh5D1Br7gsd+8yHNA1STiXK0G+cyvfbjNUEQTvh5VSvv7O1dh8WfDd7YAPvr2df/Nm0X59B9eH7q5nH0DvD6Jvyw//byCvCVZw1dHZknCclH2cLMalfMOwBNWVIM6vd1ut/vdzv5y6swlWZ9BonUzrC+n1Ar51hr+j+fQsqTXa5/+fJ6tqcodK3d3FqbMrj4drAfdoiTZfCjnyN2j/s7u85Ncr0+w6m6rZrvWg2xhumsRtXZJar/9blFu6vDdq1NmYR6pAeKeY6f+m9XSS69v69T3awL9nbsC+48khEgfuhDs6yvFepZoXhATdE+o8kYy5+8C/NlC4OMFwFf0/IIkjQe+/2cAv5K51F9E4z8ZzCespmVJFL/MOnAuy6N8ozyJ56P1gHtWmmQe1oPeqkmQb0PBNYCcy3AcXZaJjNflv+flPJoq6w3xwV5vYZKCYC9zEa8N/fPSFvMa/+GBLKNmI4IH6qfRaKdCzTRcpJxx5/AXndiKL3y49CVhZZqLPnz4I0VT+6xY6fnmZcGD/68d3G/Rg6Fv9+Z6dQgmJ8EgoAZvLlY6QlE0Cvz44ZTaQqhUkwoO8iZwLOGdWre3sgkcfd7fPzj4TJmlYu3Qr1Nf+/D0pLp2mGoBW8ew9QU+f/4st7bo98bzd9yob9lA5zyjyMoI/Tv1ays6Z/0LNXLLv6haimO+4TfCcgkYDvHf2oHvaRQMgglaF7y202AQlEu4/h76Nm8wl2qxhADz7X4uT1z+w5Um3jLN6UZROMc1wSHWpNvp6qTc+N7bTrfTJYJwyok7Ay7rU3R2chW0G/sr6tbkiNRRerKdTTLbNLZygwiKD8UXA1u1NBPdfNSxuRhneZrK8jWiRio0xQ6Lui2UmSsK0MBYY6Wy23efAoKE3KIJKnqsixvpUmOuyeCRjNyXHC4zJ0T5VUDWp4q5tkB5lwKaW+bqMJvr1rq5ufksHzup7LXvsOigCqnzgoHjoysH4eXF8CqXE6bjf3peMa5aOmtKRN+mINw0+xLd5NjkDYgM/T5i1ASr7KwY580VmKSKS60S7Uo2fry6unQptNTkvVB8Xwii1k/Di/PLAjLXXQRd9XYo6HNIat7oOlv69klt2M0eMBixKJ9Hj3fdY8pZjcmtdljv5bMdzwJqrbTbYR4mOmRhVL5xtUOVx2+kollOBvrEm4K2ZcfIGsMU2bMso+XS8eV43+rRSXmflMGYcboH1AtSafsfjZ6anVB10i8uqeSuztAPm7s+C6dtZ4tSkzDXGCdmsnIND1Kriq6qWW82BpVmObV78bVsXvXPJrL/bCL7zyay/5BNZDPT1+K93U4E466+x4mKr5lBUPZfc92zpoq+Mv41+PqVgpQftXh4oMe+eSCZCRE3rmlh0TDwC84q3QXd9zTBIHCW0NzYRyXIKzaBXUgCD3TevHZNoL9ZR9dlIFaaJSwHMxtfdiP4OxzFczqbLkG26Mv6HExrTUufM6Foh1kO/q00XYPBr+SETZFFqB2n+1kHznqqzJpr1FiztY+ProKHh/8DITAmZg==","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Lookup Postcode","permalink":"/docs/api/lookup-postcode"},"next":{"title":"Find the Nearest Postcodes","permalink":"/docs/api/nearest-postcode"}}');var o=i(31325),r=i(31736),n=i(47812),l=i.n(n),s=i(38616),c=i.n(s),d=i(67994),p=i.n(d),u=i(54768),m=i.n(u),h=(i(24909),i(96847),i(78121));const y={id:"postcode-lookup",title:"Autocomplete Search a Postcode",description:"Query for a postcode either by:",sidebar_label:"Autocomplete Search a Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJztPItOI0mSvxKqlQ5zMsY2MN34NLqjaYZhhte2afXNTo8gXRW2czorsyYzC/C1kO4j7gvvS06RWW8bg00zuyftSLuNq/IRERkZ74qvgWUTEwx+DS6VsaGK0AS/tQOVoGaWK3kSBYPiFZwq9SVNgnYQoQk1T2hEMAj+mqKewVhpYJDkY5HbKWoYzQaf5We5BVdTLF9ya1CMoXXH7RRu/qD5399sgqLxbRp9ABNUQoUOCGjdCGa/vwEmI7gRSn5/s9mhVf/yF/B7u3VyMOnNMB3F3FbhcZu4FTSGyG8RGIQqTgRaBMGNBTUuR8fMhlM0bjwTApgxKuTMYlSOiZhlHbiacgPcgNV8MkGNEdxNURZI0SuTJongGDmY8/FoDErLmRCzKpgGmQ6ncDfl4RQSjWN+XwNGo021NMUEA1yCUZogUzpCDa2QGQQuDUrDLb/FzXLfGO1URQ6mhIW0WzamDbyDHeAWIrQYWuOO0w0yMEJ7hyhBpfaO6cjBwaX7M2HaGqKcrR5vy6gYAe8ZkdfQkowLpElgCYxfuTEp/taaWpuYwfb2hNtpOuqEKt7mETKxVWC3XfzV4WrbTTPbu7ubOU4IGk0qLBi0EDJZsB0CxomdEUslKkmFOzrHJmkCVkGv263wqrTccjQdOPLT79iMaHHH6ejFHZuZjPDAoN/t0qaJkgaBpi9gxeOSeenlh+zQJDKNxlYOz1+aCb9FCULJCbdphI7Agln343EOa94JYBqrvBa0g4RpFqNFTVf8ayBZjMEgcKwZtAMuKz+MnQl6OVY6DtoB3idCRRgMxkwYbAcmnGLMgsHXxt0vZINV/op14EBwZtDQk5s/vr9xizlOCAbB8FPvAPoHB8HDQ7uAR/CY2xXhqUNxSisYkGk8Ql29yKa4PFZlR9iB9zhmqbDG80EHzhEj92OEINAYsFMmiUM6QR1xNy0Y9LrtIGb3PE5j+kG/uMx+VZDdqeGYH+6L8DxGNdEsmfIQQqV0xCWzSOBaMAmGfMwJ0ykCMmO37jJe406IqrGTM1zaGlaWW7f/aQVAO0vokSdn0HawMRsMgkilI4HVE93qdnr9N9/t71VJ8rZKkq3e226NEhljr82ABcTlQk8D3OCXcmqByV6vs9fd2dutILJfw2O/hoZmEU/N341ru/FjfNtvd+ntwkP+kAOdEYxLixNHsZIMxM8VVq/yer9bZ/YqPe54hF55vfhgP1WXyiAdKSWQybmTHHp96YV6v/slBn8wbRilFkw6+h1DS+8YZGgQoXvdTG+YDgy5DBGEM20MqFskiUzYkDxlTqmMEG5JtuN9QgqT1OUdbtwihBqdYrEV5Up7CaHuYKZSCKdKGSccY/YF3dW0mkUIajwu9Gqm8z3gTqCXLFGAWT1+R7kOfCI1gJKNBEbt6nThGcvh0us6vcAnUmmMOjVpbHXq70Z22oFbuCabx1xYxyAvO9If8mWy4zRWczmZO80DMsliBgZJczmVPeUWc/OMWav5KLWYc72/G7llURgDyp16y2y2ATuTDngkvs+vV7sQxu1Sy8pUiEKvG6/6QyUtlymW19AN68DJGKSqguPu6zwIbSCTxBsinhO5KYCuHUUOW/Dw8Fs7KOAgGva73Xm9O0zDEA1dZQISpaUhjHS/Nzu2fzc07uuCsygsffiQbVOei4cyIAj+SLnGiFwDY5l1UsPjRg5CoslFIJvJ7eEH0B5NuVJIYi7tTp9QliQ6fu13u789FCuWM5nWzNkmFmO3opJ4MXbWyzIQC/K1A5Xmf3GZ/fFHygS3tCzpRS4nhIxU2k6zv0OVSus4W07N9ZQF7YBFMZfX7sWs+BlxYly3u39ARnDQrmn3in5LmBacxSgt07PrUElDr1CGDpSUaMjkNQoMrdJMXGuc0OkSeXnspjCN11anxuObv2WaG5KNwigCNfb/hI6lwpCuVTKmJxGzeK3G11xaraI0tH5+/tiijsmC8E+5jPCeHsepsDwReB1hovlt/v5xZK773f4uSQWUGEVNPBc8vZYqI3WBk7V3BLGHhonrhOkvQTsYpfSUhyPCjMkQ9TUTgtNfGf69XkYB9wc96edP3B/ZPzoNe9m/7rfAJPuHmFKm1rNB5v/W2btgrgWX6EmR9vHn0s/wl2EA/a1dCKdMs9CSlM/cKieagHmvq+1dT9jZKgdmPpd3sUiwtSG3pzc78DGJnMSMlbRTMYOxVjF8UDMm4Ixx0XnEDi8vTAW7iwykw+dgSF7YmGuyNZm2uZ2ZoTzCsdJe8XmXs1VD3mxm/s0EJWrnDPOI3LHCkqWVmACr7iQ5c/kNnEeHUMlufAWTE7kaIgZDJaNFmLAxnUEFkcwx3Klj8yOKxORIzHKzPARjNSIpZQ2jlIuIJI9zFrnMdmHCWRx1zHr+jHIJVudA7i8L/NW/hRMZkfhXepGFN+e3PTobWr2t/c0ODKfqzh+CF/C5n8+M4RPSuhPNKSIxRo0yRBfo+VfoDeCTR4vG5rjmc71hGwGLIk0mayiUITfFqnoIIUbmVusP4MC7yb024H2IiYXRDG65SZmgKEeCYe7enDIZCS5pk8RAaxgqK+gWKSlmm7TYzgAOkkSrex47v0nlB7DXJetNo6FRu4MilASp5NbBAi12i5pNMPIXK4Mf/RmCYXEJvNtrbwBHxrqNIoL44nwIqSFKmFRrlUpHlcLipynfVTY2TidkW8eMSzGDywt4p+7RuPXfDuAqk9/VoFRLMGPhi6TrQlvWj8jN3B/Auar4jwbYLeOCzEgXNCiYr/dQUZgVzjsqlejT+p4MJlo6GJC1uejKXTShhGxTaP3nVgnmpnN8/DmRlaVESot04AMKlpmExELvNLfcTOE8UyVwTIsTBx2/c0KVBp3oxUPOyShALeFEI/FOBz6RIThCbx/SkMMpkxIFnBga4A3uEyPIpIczJmvXd2+n291981A1Nip0PK9YIK9DyHxbaP3y/5ySvTf7+3vEkLmpVqHjYWG9PS3fP/4MpSViIVvNgeOcuPIiHckJgdWGXI604RMTaNpzqLWbmLRJylcw2azL9GxlkuuZuVlBZmjJ8ZnwEH5EJuwUDlI7Vdqbr038nuaJ8x+HMPULsXwh79jOoVwH8lTJSEmCsWYJN8m+HlRuSdLkjILP/hQWHEIHzolX7qaYmRClJcWEMGQ5GeeoZytsCbxFUUG0RZNSGaEWM7oGx8OhN5+402tO8xpMIwUmDafADNwc7Wf/3bRJUo9ZiJFfAm58ILpKj5v60RLmD3POQoVm70sH4sVUy9cnZiM9xSi/UaD+xPF+QmNjLg155Q81b6YaiPHezeqQFi7NdgNmZ4w9AdrQduAnFqPZMARa6VutHa1cDvCn4+Hb3Ur0vRJZbc3HUTc7cMZmhRzj41qmKpWFLu0sCJOSKij8w3VDmc/CJluwhozTBltGpXb6QnTyWCkJ5CVObpWVSn6Dy+oMOKy7i6sz28efGytWYXiK2Q5d4sdZj07gOSXUuByPe+pVoygbBEf5IPjgBkHr6OjD5lqYPb7ms4X3gkhC1Yfwb+GQQoRX9BZal4dX60Hr1Qxt1JRUj+gbeM/HzlKxIFlM8jlU8pYcJyUNUDBrBizUyhg6Y09ys1SMzR/LhyLAsDI+fjEmIELyd/yNWGAo0A0lBQPHFHCVxIVwMR7zELPTck7f8cUHs/noKfmITvVk3JPtQxXHJNvXuxkhv+UC/OKFQePS7GG+LrScUbO5gr5oQyr9muTHaWROSlMMqiag71DDKZuhhmGaoIaL1CaphQOasCoy/W6/B4coTWrgdHhxkMVATMyEQO3cU24sDzMXug12ltAvMYMepUO2eu09n7Z1jjn56efqzmfDjM8c9Hs+of8Y1tDtvT0kTOMGpmc8igS+CqpnJaoxj7YM/y9ciuuew/UN/f+LcSVUKaI4Z/BVhNGLrJnM6CtkKkT8lpv8jhGzEteW+f95/6FMl5EPrlKq92g4QIqiZqBcUv8RGZLZbBQ3reIquHQ0phvIDcHlDEitXAHMauiSEb5swTzvwEcCPWaCSfe6IlMN6lse+oKP7CrXD5B2ca6J019QkS7jRvxfkGz6QekQ1+NRX8vjVhm7VZ7jUJyh1YpmWSbBw0DALYxRVy1mMl3UGE7qMezVAY58qrziRNwxIqZf1ueQfvnll1/OzrI4bSMQt/+22+1VIa6GzxcAfFWLrn8reG0Z85mD13tLdAyCtG55dRaw+/Jofy2AGuG982OzgfC+lhZ4aeCCglRL94DWydn7TdBMfplnsQ2vDzrg9Q0NMhAq7S+US8bGFH/2yGX6iup8cuc+c+mLWCH9r+nfQ+oKqiJMUJJIhZOz92BCmgn/+9//A7dMpBRF0xRwsRBxjaEVM1dexjShnpsxPtzAG0fS2327u7PUkvYZlpXNaWjRvPWsuRWtahgxQyVoEn5KxYx0zC6MKMrJ5tB9ls29KJdUjZK413A4i3X6cg+itlrrEwozrSC/+ZRDARcUnc2Sr3TaVoFfpLiC/+a1FgqDLprRIAhDHc2iCC5RMm2njxCA0mbPoQGc587jt4gqrkScrHDh29Oot/tQyxhWw6g/DvP7DC8w9+eXeSYa86bKI1a+y3FWAL/SjMJVRAmlv6yvihesswj0q6tPB15KOSGYhdViRcENVCR1R8pOve4gItwp/eUxVOp52uph5IHgS5/AXeMcqis0hIwP+/mkTZuCFUzOFmk3ShtXgHqXcmG30mR9EtdWcGK1v8hlKsd5EhOxHUP5et4po2JalLDBtcZb1GTxzSDVIya5wWijTu5jV12kK5YcJcJrutnixNfJOA/+nVo3YEfMv3C1OdO0YpEWVmpe1zufvlxoky7eyTkcjRR/1SB3r+CgzP6vjmVjjUUH2BhiYESrg1UTdE4EIZRodcsj1D5jERb2PD2xCnhMAxA8MkCkqhPlwxnxtnXjWxW6bOaOdK/3bFeaeLHXW13F06w5jzqr3c3ogrBBwGzAmKOIOnAiSzPJ5jXJU4T3zDL4m5JURC7njScaMiRH3cH7PP+6ToDlHva3oMDZoxSIn0MB4mcdY0QfCDhKPOlZZ3Uqq5xyfy0cF8RN/tST7K94ki/F8uxpLFc/rSYa3xjm6nJOzW35ogsX3TIWQj9skhV/1zVecNTtdru7vbd7LgDqypyq8c9UM7H1kTQMHAqq3Bjz/Kua9e4NCdLq3VmywxMRAT8nZr+7gKQkNej2eMjLtJ6Nxzon4PHovy4ersysdsspBHREHJhobrBQBFOeQCsLx6+HSxbph6VbLNB4p0eX3lBJynHlNz/CrZanFXn2FdKIKllc+ctjBqIrrHs24kNXdbU26iafviLyzoTktmZWuqppwZKE1P7p0WUWMVhgZLqiwYY1pnPDmMI/mlulORNwSmlpA62Tq9PVERxWAr6FCIC8npACWJVdfciBG0o6lImJ849XQ9iCcxWjDAWzqXYRqo+SZx96VYEt9jP+I6sD56n/xGRKBKYb04axogp3otA7jffctv0WFKDSmAiXMx/N4OTqFFpPkWUzL97++HPns/yB6uNY+CWrdIwTZvmIU31auyiOom/BitpsZ3JlFpk/XQptZxl7WvazO6jPgVfilGlangr3RaCVcz2oJ7MO3fv5iun6qR0qaRmXXuNQ2UGrkh2qHunQh3U3ofJB2Hz2zFAQ3+IA8k/JNi593YKbtZGXg57mxQuL6mvacFZ7XSlQacN57dV8hcuw9j7Xq94HqrqTzNcKWqVnFW6NFBoXG8N7bmyHguFEB6GozsVMVSoimFL1not4Zt/VGarH2DhXlor2Mn97AzRzdrj71MWSg+TM8ynGNPqWCR7ByXt3X6v14Y+UbzfKu7Nq7qK+2tdSh+HkmkdFgXVWKyxY2p8rwfZl10vLvp8uo/6HqYueK4R+uq7FsfojxbZPxIEpY0pSYb9S8VzU6xSi+5EamKZJtE9G0c7O0+VLfzbAHo4GuPndWl6J82eDSjA06brX7e287X63LGf96mD6jRuQ7e50u93+joOsmco7PH51mJZl9xqQ7rwlSPdySEm0NIA9eb+6kTBV2malbXn9vF4HvE/9jzt/W5T7PXr/+kR8LL+85LrMGWFXpy+EsQ7TE9bLgpDX1enJTt+ZwKQhqibwwcf+erB5q7Zhh5D1Br7gsd+8yHNA1STiXK0G+cyvfbjNUEQTvh5VSvv7O1dh8WfDd7YAPvr2df/Nm0X59B9eH7q5nH0DvD6Jvyw//byCvCVZw1dHZknCclH2cLMalfMOwBNWVIM6vd1ut/vdzv5y6swlWZ9BonUzrC+n1Ar51hr+j+fQsqTXa5/+fJ6tqcodK3d3FqbMrj4drAfdoiTZfCjnyN2j/s7u85Ncr0+w6m6rZrvWg2xhumsRtXZJar/9blFu6vDdq1NmYR6pAeKeY6f+m9XSS69v69T3awL9nbsC+48khEgfuhDs6yvFepZoXhATdE+o8kYy5+8C/NlC4OMFwFf0/IIkjQe+/2cAv5K51F9E4z8ZzCespmVJFL/MOnAuy6N8ozyJ56P1gHtWmmQe1oPeqkmQb0PBNYCcy3AcXZaJjNflv+flPJoq6w3xwV5vYZKCYC9zEa8N/fPSFvMa/+GBLKNmI4IH6qfRaKdCzTRcpJxx5/AXndiKL3y49CVhZZqLPnz4I0VT+6xY6fnmZcGD/68d3G/Rg6Fv9+Z6dQgmJ8EgoAZvLlY6QlE0Cvz44ZTaQqhUkwoO8iZwLOGdWre3sgkcfd7fPzj4TJmlYu3Qr1Nf+/D0pLp2mGoBW8ew9QU+f/4st7bo98bzd9yob9lA5zyjyMoI/Tv1ays6Z/0LNXLLv6haimO+4TfCcgkYDvHf2oHvaRQMgglaF7y202AQlEu4/h76Nm8wl2qxhADz7X4uT1z+w5Um3jLN6UZROMc1wSHWpNvp6qTc+N7bTrfTJYJwyok7Ay7rU3R2chW0G/sr6tbkiNRRerKdTTLbNLZygwiKD8UXA1u1NBPdfNSxuRhneZrK8jWiRio0xQ6Lui2UmSsK0MBYY6Wy23efAoKE3KIJKnqsixvpUmOuyeCRjNyXHC4zJ0T5VUDWp4q5tkB5lwKaW+bqMJvr1rq5ufksHzup7LXvsOigCqnzgoHjoysH4eXF8CqXE6bjf3peMa5aOmtKRN+mINw0+xLd5NjkDYgM/T5i1ASr7KwY580VmKSKS60S7Uo2fry6unQptNTkvVB8Xwii1k/Di/PLAjLXXQRd9XYo6HNIat7oOlv69klt2M0eMBixKJ9Hj3fdY8pZjcmtdljv5bMdzwJqrbTbYR4mOmRhVL5xtUOVx2+kollOBvrEm4K2ZcfIGsMU2bMso+XS8eV43+rRSXmflMGYcboH1AtSafsfjZ6anVB10i8uqeSuztAPm7s+C6dtZ4tSkzDXGCdmsnIND1Kriq6qWW82BpVmObV78bVsXvXPJrL/bCL7zyay/5BNZDPT1+K93U4E466+x4mKr5lBUPZfc92zpoq+Mv41+PqVgpQftXh4oMe+eSCZCRE3rmlh0TDwC84q3QXd9zTBIHCW0NzYRyXIKzaBXUgCD3TevHZNoL9ZR9dlIFaaJSwHMxtfdiP4OxzFczqbLkG26Mv6HExrTUufM6Foh1kO/q00XYPBr+SETZFFqB2n+1kHznqqzJpr1FiztY+ProKHh/8DITAmZg==",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},f=void 0,S={},g=[{value:"Query with Postcode",id:"query-with-postcode",level:2},{value:"Query with Geolocation",id:"query-with-geolocation",level:2}];function x(e){const t={a:"a",code:"code",h2:"h2",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Autocomplete Search a Postcode"}),"\n",(0,o.jsx)(l(),{method:"get",path:"/postcodes",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"Query for a postcode either by:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["The postcode itself (with ",(0,o.jsx)(t.code,{children:"query="}),") or by,"]}),"\n",(0,o.jsxs)(t.li,{children:["A geolocation (",(0,o.jsx)(t.code,{children:"lat="})," and ",(0,o.jsx)(t.code,{children:"lon="}),")."]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"query-with-postcode",children:"Query with Postcode"}),"\n",(0,o.jsxs)(t.p,{children:["Submit a postcode query and receive a complete list of postcode matches and all associated postcode data. This is triggered when ",(0,o.jsx)(t.code,{children:"query="})," is supplied."]}),"\n",(0,o.jsx)(t.p,{children:"This is essentially a postcode search which prefix matches and returns postcodes in sorted order (case insensitive)."}),"\n",(0,o.jsxs)(t.p,{children:["This method is space sensitive, i.e. it detects for spaces between outward and inward parts of the postcode (some examples detailed in this ",(0,o.jsx)(t.a,{href:"https://github.com/ideal-postcodes/postcodes.io/issues/44",children:"issue"}),")."]}),"\n",(0,o.jsx)(t.p,{children:"The result set can either be empty or populated with up to 100 postcode entities. Either way it will always return a 200 response code."}),"\n",(0,o.jsx)(t.h2,{id:"query-with-geolocation",children:"Query with Geolocation"}),"\n",(0,o.jsxs)(t.p,{children:["Returns nearest postcodes for a given longitude and latitude. This is triggered when ",(0,o.jsx)(t.code,{children:"lat="})," and ",(0,o.jsx)(t.code,{children:"lon="})," are supplied."]}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:[{name:"query",in:"query",style:"form",explode:!1,schema:{description:"Postcode to query. Aliases to `q=`",example:"SW1A 2AA"}},{name:"limit",in:"query",style:"form",explode:!1,description:"Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100.",schema:{default:10,maximum:100,minimum:1,example:3}},{name:"longitude",in:"query",style:"form",explode:!1,description:"Geographic coordinate that specifies the east-west position of a point",schema:{title:"Longitude",type:"number",format:"double",example:-.127695,maximum:180,minimum:-180}},{name:"latitude",in:"query",style:"form",explode:!1,schema:{title:"Latitude",type:"number",format:"double",description:"Latitude",example:51.50354,maximum:90,minimum:-90}},{name:"radius",in:"query",style:"form",explode:!1,description:"Limits number of postcodes matches to return. Defaults to 100m. Needs to be less than 2,000m.",schema:{title:"Radius",type:"integer",example:500,default:100,maximum:2e3,minimum:1}},{name:"widesearch",in:"query",style:"form",explode:!1,schema:{title:"Widesearch",type:"boolean",description:"Search up to 20km radius, but subject to a maximum of 10 results. Since lookups over a wide area can be very expensive, we've created this method to allow you choose to make the trade off between search radius and number of results. Defaults to false. When enabled, radius and limits over 10 are ignored.",example:"true",default:"false"}},{name:"filter",in:"query",style:"form",explode:!1,schema:{title:"Filter",type:"string",description:"A comma separated whitelist of attributes to be returned in the result object(s), e.g. filter=postcode,longitude,latitude. null responses will continue to return null. If no attributes match the result object, an empty object is returned",example:"postcode"}}]}),"\n",(0,o.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcodes Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{type:"array",items:{oneOf:[{type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","pfa","date_of_introduction","date_of_termination","index_of_multiple_deprivation","parliamentary_constituency_2024","senedd_constituency","senedd_constituency_no","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. Null where the postcode falls outside a county-level authority (the underlying GSS code is then a pseudo such as `E99999999`, surfaced under `codes.admin_county`).",example:null},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:"Caerdydd Penarth"},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:14},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",required:["admin_district","admin_county","admin_ward","parish","ccg","ccg_id","ced","nuts","lau2","lsoa","msoa","pfa","parliamentary_constituency","parliamentary_constituency_2024","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2"],properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}]},description:"Array containing detailed location information for the requested postcode or nearest postcodes"}}}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/31c97d68.62c03ba9.js b/build/assets/js/31c97d68.62c03ba9.js
deleted file mode 100644
index 845c147f6..000000000
--- a/build/assets/js/31c97d68.62c03ba9.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[2008],{41228(e,t,i){i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>x,frontMatter:()=>f,metadata:()=>o,toc:()=>S});const o=JSON.parse('{"id":"api/postcode-lookup","title":"Autocomplete Search a Postcode","description":"Query for a postcode either by:","source":"@site/docs/api/postcode-lookup.api.mdx","sourceDirName":"api","slug":"/api/postcode-lookup","permalink":"/docs/api/postcode-lookup","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"postcode-lookup","title":"Autocomplete Search a Postcode","description":"Query for a postcode either by:","sidebar_label":"Autocomplete Search a Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJztPA1PG8mSf6U0TzrMkzG2gQR8Wt0RwrLs8vUwUW7fJoL2TNnuTU/3bHcP4IuQ7kfcL7xfcqru+bSNwSZk76SNlMT29EdVdXV9T30NLBuZoPdbcKGMDVWEJvjcDFSCmlmu5HEU9IpHcKLUlzQJmkGEJtQ8oRFBL/hHinoCQ6WBQZKPRW7HqGEw6X2Sn+QGXI2xfMitQTGExh23Y7j5g+b/cLMOisY3afQ+jFAJFTogoHEjmP3hBpiM4EYo+cPNeotW/dvfwO/t1snBpCf9dBBzW4XHbeJW0Bgiv0VgEKo4EWgRBDcW1LAcHTMbjtG48UwIYMaokDOLUTkmYpa14GrMDXADVvPRCDVGcDdGWSBFj0yaJIJj5GDOx6MxKC1nQkyqYBpkOhzD3ZiHY0g0Dvl9DRiNNtXSFBMMcAlGaYJM6Qg1NEJmELg0KA23/BbXy31jtGMVOZgSFtJu2Zgm8Ba2gFuI0GJojTtON8jAAO0dogSV2jumIwcHl+5jwrQ1RDlbPd6GUTEC3jMir6ElGRdIk8ASGL9xY1L83Bhbm5je5uaI23E6aIUq3uQRMrFRYLdZfGpxtemmmc3t7fUcJwSNJhUWDFoImSzYDgHjxE6IpRKVpMIdnWOTNAGroNNuV3hVWm45mhYc+ul3bEK0uON09OKOTUxGeGDQbbdp00RJg0DT57DiUcm89PAyOzSJTKOxlcPzl2bEb1GCUHLEbRqhI7Bg1n15nMOm7wQwjVVeC5pBwjSL0aKmK/41kCzGoBc41gyaAZeVL8ZOBD0cKh0HzQDvE6EiDHpDJgw2AxOOMWZB7+vU3S9kg1X+irVgX3Bm0NAvN3/8cOMWc5wQ9IL+x84+dPf3g4eHZgGP4DG3S8JTh+KEVjAg03iAunqRTXF5rMqOsAXvcchSYY3ngxacIUbuywBBoDFgx0wSh7SCOuJuWtDrtJtBzO55nMb0hb5xmX2rILtVwzE/3BfheYRqpFky5iGESumIS2aRwLVgEgz5kBOmYwRkxm7cZbzGnRBVQydnuLQ1rCy3bv+TCoB2ktBPnpxB08HGbNALIpUOBFZPdKPd6nTfvtnbqZJkt0qSjc5uu0aJjLFXZsAC4nKhpwGe4pdyaoHJTqe1097a2a4gslfDY6+GhmYRT82fxrXt+DG+7Tbb9HTuIV/mQGcE49LiyFGsJAPxc4XVq7zebdeZvUqPOx6hV14vPtiP1aUySAdKCWRy5iT7Xl96od5tf4nBH0wTBqkFkw5+x9DSMwYZGkToTjvTG6YFfS5DBOFMGwPqFkkiEzYkT5lTKgOEW5LteJ+QwiR1eYdrtwihRqdYbEW50l5CqDuYqBTCsVLGCceYfUF3Na1mEYIaDgu9mul8D7gT6CVLFGBWj99RrgUfSQ2gZAOBUbM6XXjGcrh02k4v8JFUGqNWTRpbnfq7kZ124BauyeYhF9YxyMuO9Md8mew4jdVcjmZOc59MspiBQdJcTmWPucXcPGPWaj5ILeZc7+9GblkUxoByp94w603A1qgFHokf8uvVLIRxs9SyMhWi0OvGq/5QSctliuU1dMNacDwEqarguPs6C0ITyCTxhojnRG4KoGtHkcMWPDx8bgYFHETDbrs9q3f7aRiioatMQKK0NISR7vdmx+bvhsZ9nXMWhaUPl9k25bl4KAOC4I+Ua4zINTCWWSc1PG7kICSaXASymdwefgDtMS1XCknMpd3qEsqSRMdv3Xb780OxYjmTac2cbWIxdisqiedDZ70sArEgXzNQaf6Jy+zDHykT3NKypBe5HBEyUmk7zj6HKpXWcbYcm+sxC5oBi2Iur92DSfE14sS4bnf/AxnBQbOm3Sv6LWFacBajtExPrkMlDT1CGTpQUqIhk9coMLRKM3GtcUSnS+TlsZvCNF5bnRqPb/6UaW5INgqjCNTY/xc6lgpDulYytR6vzKGrn1dBrTlc8eQd/fBLaTj70+1Bd2MbwjHTLLQktjI/wd01YN6NaHpfCrY2yoGZE+F9BrqpTcgNxPUWfEgiJwJiJe1YTGCoVQyXasIEnDIuWo8YliUHVLA7z0A6eA6G5FYMuSbjiWmbG04ZygMcKu0lufehGjXkzXpmsI9QonbeHY/IvyhMM1qJCbDqTpJ3krPULDqESsbCFUyO5XKIGAyVjOZhwoZ0BhVEMk9nq47NTygSkyMxye3MEIzViKRlNAxSLiK6Ss774TLbhQmnQuuYdfwZ5VeyzoHOUmUC/uGfwrGMSJ4pPc9kmXFEHp0Njc7G3noL+mN15w/BS6zccWXG8BGpkZHm5GIPUaMM0UUu/g6dHnz0aNHYHNd8rrfUImBRpMkGC4UyZHdbVfeJY2RutW4P9r3f12kC3oeYWBhM4JablAly2xMMc3v9hMlIcEmbJAYa/VBZQbdISTFZp8W2erCfJFrd89g5Aio/gJ02mSMaDY3a7hWxEUgltw4WaLBb1GyEkb9YGfzozxAMi0vg3V47PTg01m0UEcTnZ31IDVHCpFqrVDqqFCYsTXlT2dg4IZdtHTMuxQQuzuGdukfj1t/twRXq2Lk0lShLQzBj4Yuk60Jb1o/IzdzrwZmqOEQG2C3jguwi5wUXzNd5qGiACucdllrhaQVGFgAtHfTIfJp35c6noYRsU2j8x0YJ5rqz5P05kdmgREqLtOASBctsHGKhd5pbbsZwxjL+PqLFiYOO3jmhSoOO9fwhZ6TlUEs41ki804KPZNkM0Bs8NORgzKREAceGBngL8tgIslHhlMna9d3Zare33z5UtWeFjmcVlfo6hMy3hcav/88p2Xm7t7dDDJnbHhU6HhTmyNPy/cMvUBoWFrLVHDjOKykv0qEcEVhNyOVIEz4ygaY5g1pzGpMmSfkKJut1mZ6tTHI9s58qyPQtWfIjHsJPyIQdw35qx0p7e2wav6d54uynPoz9QixfyHtqMyjXgTxRMlKSYKyZdtNkXw0qtyRpckbRVH8Kcw6hBadsUgYnXfRPI/MyV6XZ8U02BN6iqC2q6twTlHgUNmkFk/elnfpiXPL1iQVIezAKoxeUf4LoH9HYmEtDzt9DzWiu+vveiF4e0sJy3pyC2ZlIT4DWty34mcVo1gyBVprwKwfFFgP88ai/u10J8lYCeI3ZcN16wSpOuvBhLSGSykLDteZE40hAF27IqhGzZ2GTLVhDxsnoDaNSO34hOnlIjsTkAl+qykolv8FFdQYc1L2v5Zntwy9TK1ZheIrZDlx+wdl0Tgw51TB1OR53CKumSjYIDvNBcOkGQePw8HJ9JcweX/PZInWOw1q17P1TOKBI1BU9hcbFwdVq0HrhTxtNS6pHtAC850NnP1iQLCbjIVTyltwZJQ1QzGQCLNTKGDpjT3KzUIzNHstl7psvj49fjAmIkLwQfyPmqG+6oajFBI4orieJC+F8OOQhZqflXLGj80uz/ugp+cBB9WTcL5sHKo5Jtq92M0J+ywX4xQszw2Vzw3xdaDhTY30JfdGEVPo1ybvSyJyUplBHTUDfoYYTNkEN/TRBDeepTVIL+zRhWWS67W4HDlCa1MBJ/3w/i0yYmAmB2jmN3FgeZo5tE+wkoW9iAh2Kum90mjs+O+jcZfKez9SdT7oYH6Dudnze+DGsod3ZPSBM4ylMT3kUCXwVVE9LVGMebRj+n7gQ1x2H61v698W4EqoUuJoxwyrC6EXWTGaKFTIVIn7LTX7HiFmJa8s086xVX2ZlciuNTbslimJZoFzu+BEZQss9+PBcFVfBpaMx3UBuCC4SUEdauTqL5dAl03jRgnl4mw8EeswEk+5xRaYa1Lc89HUF2VWuHyDt4hwGp7+gIl2GU2FmQbLpR6VDXI1HfcmIW2XoVnmOmX+KViuaZZkEDwMBR6HEazW85tJqFaWhnRLg78l0UUM4rj5fBeDIZ2QrkZ87RsT0y/pUxa+//vrr6WkWPZ0Kj+3tttudKsQ2C4o8AvBV5fG3g9eWkZgZeOEsvxmCtG55deawO5cR3hMWcSosTwReR5hofjuDzjENdN5lNhDeVwa+PJxAoaOFe0Dj+PT9Omgmv8yy2JrXBy3w+oYGGQiV9hfK5fxiigp75DJ9ReUkucudOdpFBI/+TnvdkLq6nQgTlCRS4fj0PZiQZsL//Nd/wy0TKcW2NIVBLERcY2jFxFUxMU2o52aMDwLwqSPpbO9uby20pK+77e728uY0NGjeatbcklY1DJihSicJP6diQjpmGwYUe2Qz6D7L5jYoMYoedSf67jEcTGKdvtyDqK3W+IjCjCvIrz/lUMA5xUyzHB+dtlXgFymu4L96rYXC4N0YNc67knNQvpbqWVjDWe4ufovo3lLkyDLir0YVilvNmvWk67I7DC8w8WeXeSYis+bJI5a9tXc15XulGUWQiBZKf1ld/c5ZZx7oV1cf971kysJZRGaIFQU0UJGkHSg79vqCiHCn9JfHUJFZ5PU6YfpL7TDykOwFPVjpHKorTAmWIRMiz181KUDB5GQeowzSGqHfpVzYjTRZncS1FZwo7c5zk8pxnsREbMdQvlR0zKhOEyWsca3xFjVZeRNI9YBJbjBaq5P7yBWu6Ir1xsNBXR9bHPkSDOe1v1OrBumI+eeuNmOOVqzQwjLNS0ZnE4lz7dD5Ozkng8kQ9TUTgtOnmhHuHsF+/mgVLKfWmHeAU0MMDGh1sGqEznEghBKtbnmE2ucOwsKGp1+sAh7TAASPDBCp6kS5PCXetm58o0KX9dx57nSe7T4TL3Y6y6t1mjXjRWdloRldENYImDUYchRRC45laRrZvNx1jPCeWQb/VJLqk+WswURD+uScO3if51PXCbDYq/4WFDh9lALxcyhA/KxjjKj23FHiSW+aCNtd7pS7K+E4J1byXU+yu+RJvhTL06exXP60ptH4xjBXl3NqbsOXP7iIlrEQ+mGjrK64rvGCw3a73d7u7O64oGca1u/OZaqZ2PhAGgYOBNVQDHn+wsZq94YEafXuLNjhiSiAnxOz310QUpIadHt4PLpL4LHKCXg8uq+Lh8Bk6pZT2OeQODDR3GChCMY8gUYWgl8Nlyy6Dwu3mKPxTg4vvKGSlOPK10mEWy1PJfLsBZcB1ZS4QpTHDESBSff5iPdd/dPKqJt8+pLIOxOS25pZ6QpyBUsSUvsnhxdZlGCeN0Lle1PWmM4NYwr5aG6V5kzACWWKDTSOr06WR7BfCfIWIgDyyj4KWlV29WEGbijRUCYjzj5c9WEDzlSMMhTMptpFpT5Inr1DVAW22M/493f2nXf+M5MpEZhuTBOGioqniULvNN5z2/RbUFBKYyJY6KuPjq9OoPEUWdbzuuAPv7Q+yR+pUo2FX7Kawzhhlg84VYo1izIles2oKPt1JldmkfnTpXA2pDLK6uY+uYP6FHglTtmlxelvX45ZOdf9egLrwD2fLcatn9qBkpZx6TXOUb8PjUpGqHqkfR/KXYfKu0azGTNDgXuLPcjfUlq7MJhGys9aywszT/ayP/MqXZpwWntcKRVpwlnt0WytSb/2PNer69XqCOdOMl+1Z5WeVLg1UmhcPAzvubEtCoATHYSiihMzVqmIYEx1dC7Kmb2yZYAZWDtTlsrnMn97DTRzdrh7i8KSg+TM8zHGNPqWCR7B8Xt3X+vltE/XYbhjeqRk84m4JWX4iKP3KnWztFpxS717NL9mY1qd75FC39p6ugjmewPs4ZgCN+eLxZUj3xtUgmGarjvtztZu+82iHOurg+k3noJse6vdbne3HGTTqaeDo1eHaVE2agrSrV2CdCeH9JpH08Aev19ewY2Vth6mogpbrwLex+6HrX/Oy1Uevn99Ij6WD11wXWYMiKuTF8JYh+kJzTsnXHN1crzVdeYbS+vm2/6H7mqweYtsSoeS5QG+fq47fZFngKpJxJnaAvL3Xvtwp93oafg6VG/r7+9MRcD3hu90Dnz0SuDe27fz8r8/vj50MznmKfC6JP6yfOrzCsgWZLleHZkFCbZ52a71akTJG69PpPamqNPZbrfbb7b2FlNnJin4DBKtmhF8OaWWyA/W8H88/5MlbF779GdzRNOq3LFye2tuuufq4/5q0M1L8MyGIQ7dPepubT8/QfP6BKvutmymZjXI5qZq5lFrm6T27pt5eZWDd69Ombk5kCkQdxw7dd8ulxp5fVunvt800G/cFdh7JJlB+tCFD19fKdYzHLOCmKB7QpVPJSL+FOBP5wIfzwG+oufnJBg88N3vAfxS5lJ3Ho2/M5hPWE2LEgB+mVXgXJQD+EYxfs9HqwH3rBD/LKz7nWUD+N+GgisAOROdP7wog/Cvy3/Pi9dPq6y3xAc7nbkBdoK9jKO/NvTPC7nPavyHB7KMpl9nf6A2A1NdJqjHgIvyMu4c/qJBVfFGCpe+oKlM0VCh/h8pmtrLqUrP9nQKHvyfZnC/QT/0fRcs18JAMDkKegH1vXKdAgYoiv5pHy5PqLOGSjWp4CDvjcUS3qo1wSp7Y9FL4t39/U+UFSnWDv069bUPTo6ra4epFrBxBBtf4NOnT3Jjg76vPX/HtfqWU+icZRRZGqF/ozZWRUOhf6H+VvkbQAtxzDf8RlguAMMh/rkZ+FYvQS8YoXUNGew46AXlEgQG6tu871aqxQICzHZBuTh2sXtXWHfLNKcbReEc1xuEWJNup6vxceM7u612q00E4ZTPdQZc1r7l9PgqaE7tr6iJjSNSS+nRZjbJbNLYyg0iKC6LCveNWoqEbj7q2JwPsxxDZfkaUSMVmmKHee/sl1kXCtDAUGOlEtk35QGChNyiESr6WRc30qV1XO+1Qxm5Nw9cVkmIsoo9a9/DXLeU/F13mlvmmTCb69a6ubn5JB87qeyxbzznoArp/X0DR4dXDsKL8/5VLidMy3/1vGJcdW/Wq4XepUC4mW7XcpNjk/dlMfT9kFFvoLLhXJy/os8kVQtqlWhXbvDT1dWFS/+kJu+o4bsLELV+7p+fXRSQuR4V6KqNQ0Gv71FPO9fwz3eVacJ29gODAYvyefTztvuZ8i1Dcqsd1jv5bMezgFor7XaYhYkOWRiVb1xt3OPxG6hokpOBXhSmoG3ZSK/GMEXmJ2sE41LJ5XjfAc9JeZ+UwZhxugfUIk9p++9TrQZboWqlVFeYXZ2+HzZzfeZO28wWpd5Jrr1KzGTlGu6nVhXNJrOWVQwqLVdq9+Jr2dPnr96af/XW/Ku35v/J3pqZ6Wvx3m4mgnFXm+JExdfMICjbUrkeTGNFb8X+Fnz9SkHKD1o8PNDPvqcamQkRN66XW9FH7QtOKk3X3Psf/tX/OWMflSCv2BtzLgk80HlPzxWB/maNLheBWHm5fzGY2fjy7fk/4Sie0/BxAbJFu8rnYFrr5ficCUWXwHLw59J0DXq/kRM2RhahdpzuZ+0766kya6Z/Xc3WPjq8Ch4e/hczgyvo","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Lookup Postcode","permalink":"/docs/api/lookup-postcode"},"next":{"title":"Find the Nearest Postcodes","permalink":"/docs/api/nearest-postcode"}}');var a=i(31325),n=i(31736),r=i(47812),l=i.n(r),s=i(38616),c=i.n(s),d=i(67994),p=i.n(d),u=i(54768),m=i.n(u),h=(i(24909),i(96847),i(78121));const f={id:"postcode-lookup",title:"Autocomplete Search a Postcode",description:"Query for a postcode either by:",sidebar_label:"Autocomplete Search a Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJztPA1PG8mSf6U0TzrMkzG2gQR8Wt0RwrLs8vUwUW7fJoL2TNnuTU/3bHcP4IuQ7kfcL7xfcqru+bSNwSZk76SNlMT29EdVdXV9T30NLBuZoPdbcKGMDVWEJvjcDFSCmlmu5HEU9IpHcKLUlzQJmkGEJtQ8oRFBL/hHinoCQ6WBQZKPRW7HqGEw6X2Sn+QGXI2xfMitQTGExh23Y7j5g+b/cLMOisY3afQ+jFAJFTogoHEjmP3hBpiM4EYo+cPNeotW/dvfwO/t1snBpCf9dBBzW4XHbeJW0Bgiv0VgEKo4EWgRBDcW1LAcHTMbjtG48UwIYMaokDOLUTkmYpa14GrMDXADVvPRCDVGcDdGWSBFj0yaJIJj5GDOx6MxKC1nQkyqYBpkOhzD3ZiHY0g0Dvl9DRiNNtXSFBMMcAlGaYJM6Qg1NEJmELg0KA23/BbXy31jtGMVOZgSFtJu2Zgm8Ba2gFuI0GJojTtON8jAAO0dogSV2jumIwcHl+5jwrQ1RDlbPd6GUTEC3jMir6ElGRdIk8ASGL9xY1L83Bhbm5je5uaI23E6aIUq3uQRMrFRYLdZfGpxtemmmc3t7fUcJwSNJhUWDFoImSzYDgHjxE6IpRKVpMIdnWOTNAGroNNuV3hVWm45mhYc+ul3bEK0uON09OKOTUxGeGDQbbdp00RJg0DT57DiUcm89PAyOzSJTKOxlcPzl2bEb1GCUHLEbRqhI7Bg1n15nMOm7wQwjVVeC5pBwjSL0aKmK/41kCzGoBc41gyaAZeVL8ZOBD0cKh0HzQDvE6EiDHpDJgw2AxOOMWZB7+vU3S9kg1X+irVgX3Bm0NAvN3/8cOMWc5wQ9IL+x84+dPf3g4eHZgGP4DG3S8JTh+KEVjAg03iAunqRTXF5rMqOsAXvcchSYY3ngxacIUbuywBBoDFgx0wSh7SCOuJuWtDrtJtBzO55nMb0hb5xmX2rILtVwzE/3BfheYRqpFky5iGESumIS2aRwLVgEgz5kBOmYwRkxm7cZbzGnRBVQydnuLQ1rCy3bv+TCoB2ktBPnpxB08HGbNALIpUOBFZPdKPd6nTfvtnbqZJkt0qSjc5uu0aJjLFXZsAC4nKhpwGe4pdyaoHJTqe1097a2a4gslfDY6+GhmYRT82fxrXt+DG+7Tbb9HTuIV/mQGcE49LiyFGsJAPxc4XVq7zebdeZvUqPOx6hV14vPtiP1aUySAdKCWRy5iT7Xl96od5tf4nBH0wTBqkFkw5+x9DSMwYZGkToTjvTG6YFfS5DBOFMGwPqFkkiEzYkT5lTKgOEW5LteJ+QwiR1eYdrtwihRqdYbEW50l5CqDuYqBTCsVLGCceYfUF3Na1mEYIaDgu9mul8D7gT6CVLFGBWj99RrgUfSQ2gZAOBUbM6XXjGcrh02k4v8JFUGqNWTRpbnfq7kZ124BauyeYhF9YxyMuO9Md8mew4jdVcjmZOc59MspiBQdJcTmWPucXcPGPWaj5ILeZc7+9GblkUxoByp94w603A1qgFHokf8uvVLIRxs9SyMhWi0OvGq/5QSctliuU1dMNacDwEqarguPs6C0ITyCTxhojnRG4KoGtHkcMWPDx8bgYFHETDbrs9q3f7aRiioatMQKK0NISR7vdmx+bvhsZ9nXMWhaUPl9k25bl4KAOC4I+Ua4zINTCWWSc1PG7kICSaXASymdwefgDtMS1XCknMpd3qEsqSRMdv3Xb780OxYjmTac2cbWIxdisqiedDZ70sArEgXzNQaf6Jy+zDHykT3NKypBe5HBEyUmk7zj6HKpXWcbYcm+sxC5oBi2Iur92DSfE14sS4bnf/AxnBQbOm3Sv6LWFacBajtExPrkMlDT1CGTpQUqIhk9coMLRKM3GtcUSnS+TlsZvCNF5bnRqPb/6UaW5INgqjCNTY/xc6lgpDulYytR6vzKGrn1dBrTlc8eQd/fBLaTj70+1Bd2MbwjHTLLQktjI/wd01YN6NaHpfCrY2yoGZE+F9BrqpTcgNxPUWfEgiJwJiJe1YTGCoVQyXasIEnDIuWo8YliUHVLA7z0A6eA6G5FYMuSbjiWmbG04ZygMcKu0lufehGjXkzXpmsI9QonbeHY/IvyhMM1qJCbDqTpJ3krPULDqESsbCFUyO5XKIGAyVjOZhwoZ0BhVEMk9nq47NTygSkyMxye3MEIzViKRlNAxSLiK6Ss774TLbhQmnQuuYdfwZ5VeyzoHOUmUC/uGfwrGMSJ4pPc9kmXFEHp0Njc7G3noL+mN15w/BS6zccWXG8BGpkZHm5GIPUaMM0UUu/g6dHnz0aNHYHNd8rrfUImBRpMkGC4UyZHdbVfeJY2RutW4P9r3f12kC3oeYWBhM4JablAly2xMMc3v9hMlIcEmbJAYa/VBZQbdISTFZp8W2erCfJFrd89g5Aio/gJ02mSMaDY3a7hWxEUgltw4WaLBb1GyEkb9YGfzozxAMi0vg3V47PTg01m0UEcTnZ31IDVHCpFqrVDqqFCYsTXlT2dg4IZdtHTMuxQQuzuGdukfj1t/twRXq2Lk0lShLQzBj4Yuk60Jb1o/IzdzrwZmqOEQG2C3jguwi5wUXzNd5qGiACucdllrhaQVGFgAtHfTIfJp35c6noYRsU2j8x0YJ5rqz5P05kdmgREqLtOASBctsHGKhd5pbbsZwxjL+PqLFiYOO3jmhSoOO9fwhZ6TlUEs41ki804KPZNkM0Bs8NORgzKREAceGBngL8tgIslHhlMna9d3Zare33z5UtWeFjmcVlfo6hMy3hcav/88p2Xm7t7dDDJnbHhU6HhTmyNPy/cMvUBoWFrLVHDjOKykv0qEcEVhNyOVIEz4ygaY5g1pzGpMmSfkKJut1mZ6tTHI9s58qyPQtWfIjHsJPyIQdw35qx0p7e2wav6d54uynPoz9QixfyHtqMyjXgTxRMlKSYKyZdtNkXw0qtyRpckbRVH8Kcw6hBadsUgYnXfRPI/MyV6XZ8U02BN6iqC2q6twTlHgUNmkFk/elnfpiXPL1iQVIezAKoxeUf4LoH9HYmEtDzt9DzWiu+vveiF4e0sJy3pyC2ZlIT4DWty34mcVo1gyBVprwKwfFFgP88ai/u10J8lYCeI3ZcN16wSpOuvBhLSGSykLDteZE40hAF27IqhGzZ2GTLVhDxsnoDaNSO34hOnlIjsTkAl+qykolv8FFdQYc1L2v5Zntwy9TK1ZheIrZDlx+wdl0Tgw51TB1OR53CKumSjYIDvNBcOkGQePw8HJ9JcweX/PZInWOw1q17P1TOKBI1BU9hcbFwdVq0HrhTxtNS6pHtAC850NnP1iQLCbjIVTyltwZJQ1QzGQCLNTKGDpjT3KzUIzNHstl7psvj49fjAmIkLwQfyPmqG+6oajFBI4orieJC+F8OOQhZqflXLGj80uz/ugp+cBB9WTcL5sHKo5Jtq92M0J+ywX4xQszw2Vzw3xdaDhTY30JfdGEVPo1ybvSyJyUplBHTUDfoYYTNkEN/TRBDeepTVIL+zRhWWS67W4HDlCa1MBJ/3w/i0yYmAmB2jmN3FgeZo5tE+wkoW9iAh2Kum90mjs+O+jcZfKez9SdT7oYH6Dudnze+DGsod3ZPSBM4ylMT3kUCXwVVE9LVGMebRj+n7gQ1x2H61v698W4EqoUuJoxwyrC6EXWTGaKFTIVIn7LTX7HiFmJa8s086xVX2ZlciuNTbslimJZoFzu+BEZQss9+PBcFVfBpaMx3UBuCC4SUEdauTqL5dAl03jRgnl4mw8EeswEk+5xRaYa1Lc89HUF2VWuHyDt4hwGp7+gIl2GU2FmQbLpR6VDXI1HfcmIW2XoVnmOmX+KViuaZZkEDwMBR6HEazW85tJqFaWhnRLg78l0UUM4rj5fBeDIZ2QrkZ87RsT0y/pUxa+//vrr6WkWPZ0Kj+3tttudKsQ2C4o8AvBV5fG3g9eWkZgZeOEsvxmCtG55deawO5cR3hMWcSosTwReR5hofjuDzjENdN5lNhDeVwa+PJxAoaOFe0Dj+PT9Omgmv8yy2JrXBy3w+oYGGQiV9hfK5fxiigp75DJ9ReUkucudOdpFBI/+TnvdkLq6nQgTlCRS4fj0PZiQZsL//Nd/wy0TKcW2NIVBLERcY2jFxFUxMU2o52aMDwLwqSPpbO9uby20pK+77e728uY0NGjeatbcklY1DJihSicJP6diQjpmGwYUe2Qz6D7L5jYoMYoedSf67jEcTGKdvtyDqK3W+IjCjCvIrz/lUMA5xUyzHB+dtlXgFymu4L96rYXC4N0YNc67knNQvpbqWVjDWe4ufovo3lLkyDLir0YVilvNmvWk67I7DC8w8WeXeSYis+bJI5a9tXc15XulGUWQiBZKf1ld/c5ZZx7oV1cf971kysJZRGaIFQU0UJGkHSg79vqCiHCn9JfHUJFZ5PU6YfpL7TDykOwFPVjpHKorTAmWIRMiz181KUDB5GQeowzSGqHfpVzYjTRZncS1FZwo7c5zk8pxnsREbMdQvlR0zKhOEyWsca3xFjVZeRNI9YBJbjBaq5P7yBWu6Ir1xsNBXR9bHPkSDOe1v1OrBumI+eeuNmOOVqzQwjLNS0ZnE4lz7dD5Ozkng8kQ9TUTgtOnmhHuHsF+/mgVLKfWmHeAU0MMDGh1sGqEznEghBKtbnmE2ucOwsKGp1+sAh7TAASPDBCp6kS5PCXetm58o0KX9dx57nSe7T4TL3Y6y6t1mjXjRWdloRldENYImDUYchRRC45laRrZvNx1jPCeWQb/VJLqk+WswURD+uScO3if51PXCbDYq/4WFDh9lALxcyhA/KxjjKj23FHiSW+aCNtd7pS7K+E4J1byXU+yu+RJvhTL06exXP60ptH4xjBXl3NqbsOXP7iIlrEQ+mGjrK64rvGCw3a73d7u7O64oGca1u/OZaqZ2PhAGgYOBNVQDHn+wsZq94YEafXuLNjhiSiAnxOz310QUpIadHt4PLpL4LHKCXg8uq+Lh8Bk6pZT2OeQODDR3GChCMY8gUYWgl8Nlyy6Dwu3mKPxTg4vvKGSlOPK10mEWy1PJfLsBZcB1ZS4QpTHDESBSff5iPdd/dPKqJt8+pLIOxOS25pZ6QpyBUsSUvsnhxdZlGCeN0Lle1PWmM4NYwr5aG6V5kzACWWKDTSOr06WR7BfCfIWIgDyyj4KWlV29WEGbijRUCYjzj5c9WEDzlSMMhTMptpFpT5Inr1DVAW22M/493f2nXf+M5MpEZhuTBOGioqniULvNN5z2/RbUFBKYyJY6KuPjq9OoPEUWdbzuuAPv7Q+yR+pUo2FX7Kawzhhlg84VYo1izIles2oKPt1JldmkfnTpXA2pDLK6uY+uYP6FHglTtmlxelvX45ZOdf9egLrwD2fLcatn9qBkpZx6TXOUb8PjUpGqHqkfR/KXYfKu0azGTNDgXuLPcjfUlq7MJhGys9aywszT/ayP/MqXZpwWntcKRVpwlnt0WytSb/2PNer69XqCOdOMl+1Z5WeVLg1UmhcPAzvubEtCoATHYSiihMzVqmIYEx1dC7Kmb2yZYAZWDtTlsrnMn97DTRzdrh7i8KSg+TM8zHGNPqWCR7B8Xt3X+vltE/XYbhjeqRk84m4JWX4iKP3KnWztFpxS717NL9mY1qd75FC39p6ugjmewPs4ZgCN+eLxZUj3xtUgmGarjvtztZu+82iHOurg+k3noJse6vdbne3HGTTqaeDo1eHaVE2agrSrV2CdCeH9JpH08Aev19ewY2Vth6mogpbrwLex+6HrX/Oy1Uevn99Ij6WD11wXWYMiKuTF8JYh+kJzTsnXHN1crzVdeYbS+vm2/6H7mqweYtsSoeS5QG+fq47fZFngKpJxJnaAvL3Xvtwp93oafg6VG/r7+9MRcD3hu90Dnz0SuDe27fz8r8/vj50MznmKfC6JP6yfOrzCsgWZLleHZkFCbZ52a71akTJG69PpPamqNPZbrfbb7b2FlNnJin4DBKtmhF8OaWWyA/W8H88/5MlbF779GdzRNOq3LFye2tuuufq4/5q0M1L8MyGIQ7dPepubT8/QfP6BKvutmymZjXI5qZq5lFrm6T27pt5eZWDd69Ombk5kCkQdxw7dd8ulxp5fVunvt800G/cFdh7JJlB+tCFD19fKdYzHLOCmKB7QpVPJSL+FOBP5wIfzwG+oufnJBg88N3vAfxS5lJ3Ho2/M5hPWE2LEgB+mVXgXJQD+EYxfs9HqwH3rBD/LKz7nWUD+N+GgisAOROdP7wog/Cvy3/Pi9dPq6y3xAc7nbkBdoK9jKO/NvTPC7nPavyHB7KMpl9nf6A2A1NdJqjHgIvyMu4c/qJBVfFGCpe+oKlM0VCh/h8pmtrLqUrP9nQKHvyfZnC/QT/0fRcs18JAMDkKegH1vXKdAgYoiv5pHy5PqLOGSjWp4CDvjcUS3qo1wSp7Y9FL4t39/U+UFSnWDv069bUPTo6ra4epFrBxBBtf4NOnT3Jjg76vPX/HtfqWU+icZRRZGqF/ozZWRUOhf6H+VvkbQAtxzDf8RlguAMMh/rkZ+FYvQS8YoXUNGew46AXlEgQG6tu871aqxQICzHZBuTh2sXtXWHfLNKcbReEc1xuEWJNup6vxceM7u612q00E4ZTPdQZc1r7l9PgqaE7tr6iJjSNSS+nRZjbJbNLYyg0iKC6LCveNWoqEbj7q2JwPsxxDZfkaUSMVmmKHee/sl1kXCtDAUGOlEtk35QGChNyiESr6WRc30qV1XO+1Qxm5Nw9cVkmIsoo9a9/DXLeU/F13mlvmmTCb69a6ubn5JB87qeyxbzznoArp/X0DR4dXDsKL8/5VLidMy3/1vGJcdW/Wq4XepUC4mW7XcpNjk/dlMfT9kFFvoLLhXJy/os8kVQtqlWhXbvDT1dWFS/+kJu+o4bsLELV+7p+fXRSQuR4V6KqNQ0Gv71FPO9fwz3eVacJ29gODAYvyefTztvuZ8i1Dcqsd1jv5bMezgFor7XaYhYkOWRiVb1xt3OPxG6hokpOBXhSmoG3ZSK/GMEXmJ2sE41LJ5XjfAc9JeZ+UwZhxugfUIk9p++9TrQZboWqlVFeYXZ2+HzZzfeZO28wWpd5Jrr1KzGTlGu6nVhXNJrOWVQwqLVdq9+Jr2dPnr96af/XW/Ku35v/J3pqZ6Wvx3m4mgnFXm+JExdfMICjbUrkeTGNFb8X+Fnz9SkHKD1o8PNDPvqcamQkRN66XW9FH7QtOKk3X3Psf/tX/OWMflSCv2BtzLgk80HlPzxWB/maNLheBWHm5fzGY2fjy7fk/4Sie0/BxAbJFu8rnYFrr5ficCUWXwHLw59J0DXq/kRM2RhahdpzuZ+0766kya6Z/Xc3WPjq8Ch4e/hczgyvo",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},y=void 0,g={},S=[{value:"Query with Postcode",id:"query-with-postcode",level:2},{value:"Query with Geolocation",id:"query-with-geolocation",level:2}];function b(e){const t={a:"a",code:"code",h2:"h2",li:"li",p:"p",ul:"ul",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Autocomplete Search a Postcode"}),"\n",(0,a.jsx)(l(),{method:"get",path:"/postcodes",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"Query for a postcode either by:"}),"\n",(0,a.jsxs)(t.ul,{children:["\n",(0,a.jsxs)(t.li,{children:["The postcode itself (with ",(0,a.jsx)(t.code,{children:"query="}),") or by,"]}),"\n",(0,a.jsxs)(t.li,{children:["A geolocation (",(0,a.jsx)(t.code,{children:"lat="})," and ",(0,a.jsx)(t.code,{children:"lon="}),")."]}),"\n"]}),"\n",(0,a.jsx)(t.h2,{id:"query-with-postcode",children:"Query with Postcode"}),"\n",(0,a.jsxs)(t.p,{children:["Submit a postcode query and receive a complete list of postcode matches and all associated postcode data. This is triggered when ",(0,a.jsx)(t.code,{children:"query="})," is supplied."]}),"\n",(0,a.jsx)(t.p,{children:"This is essentially a postcode search which prefix matches and returns postcodes in sorted order (case insensitive)."}),"\n",(0,a.jsxs)(t.p,{children:["This method is space sensitive, i.e. it detects for spaces between outward and inward parts of the postcode (some examples detailed in this ",(0,a.jsx)(t.a,{href:"https://github.com/ideal-postcodes/postcodes.io/issues/44",children:"issue"}),")."]}),"\n",(0,a.jsx)(t.p,{children:"The result set can either be empty or populated with up to 100 postcode entities. Either way it will always return a 200 response code."}),"\n",(0,a.jsx)(t.h2,{id:"query-with-geolocation",children:"Query with Geolocation"}),"\n",(0,a.jsxs)(t.p,{children:["Returns nearest postcodes for a given longitude and latitude. This is triggered when ",(0,a.jsx)(t.code,{children:"lat="})," and ",(0,a.jsx)(t.code,{children:"lon="})," are supplied."]}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(c(),{parameters:[{name:"query",in:"query",style:"form",explode:!1,schema:{description:"Postcode to query. Aliases to `q=`",example:"SW1A 2AA"}},{name:"limit",in:"query",style:"form",explode:!1,description:"Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100.",schema:{default:10,maximum:100,minimum:1,example:3}},{name:"longitude",in:"query",style:"form",explode:!1,description:"Geographic coordinate that specifies the east-west position of a point",schema:{title:"Longitude",type:"number",format:"double",example:-.127695,maximum:180,minimum:-180}},{name:"latitude",in:"query",style:"form",explode:!1,schema:{title:"Latitude",type:"number",format:"double",description:"Latitude",example:51.50354,maximum:90,minimum:-90}},{name:"radius",in:"query",style:"form",explode:!1,description:"Limits number of postcodes matches to return. Defaults to 100m. Needs to be less than 2,000m.",schema:{title:"Radius",type:"integer",example:500,default:100,maximum:2e3,minimum:1}},{name:"widesearch",in:"query",style:"form",explode:!1,schema:{title:"Widesearch",type:"boolean",description:"Search up to 20km radius, but subject to a maximum of 10 results. Since lookups over a wide area can be very expensive, we've created this method to allow you choose to make the trade off between search radius and number of results. Defaults to false. When enabled, radius and limits over 10 are ignored.",example:"true",default:"false"}},{name:"filter",in:"query",style:"form",explode:!1,schema:{title:"Filter",type:"string",description:"A comma separated whitelist of attributes to be returned in the result object(s), e.g. filter=postcode,longitude,latitude. null responses will continue to return null. If no attributes match the result object, an empty object is returned",example:"postcode"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcodes Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{type:"array",items:{oneOf:[{type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. May be empty for areas without county-level administration.",example:""},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}]},description:"Array containing detailed location information for the requested postcode or nearest postcodes"}}}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/36bb8c04.2bbeadde.js b/build/assets/js/36bb8c04.1d5e4613.js
similarity index 54%
rename from build/assets/js/36bb8c04.2bbeadde.js
rename to build/assets/js/36bb8c04.1d5e4613.js
index 8fbcc304b..6ea8dc47c 100644
--- a/build/assets/js/36bb8c04.2bbeadde.js
+++ b/build/assets/js/36bb8c04.1d5e4613.js
@@ -1 +1 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[7031],{88082(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>_,frontMatter:()=>s,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"scottish-postcode/lookup","title":"Lookup a Scottish Postcode","description":"This endpoint returns the full Scottish Postcode Directory (SPD) record for a Scottish postcode: council area, electoral ward, NHS health board and integration authority, data zone and intermediate zone, locality and settlement, civil parish, urban-rural classification, Scottish Index of Multiple Deprivation, census household and population counts, and the equivalent GSS / official codes \u2014 including historical (year-suffixed) values where the upstream record carries them.","source":"@site/docs/scottish-postcode/lookup.mdx","sourceDirName":"scottish-postcode","slug":"/scottish-postcode/lookup","permalink":"/docs/scottish-postcode/lookup","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"sidebar_label":"Lookup","title":"Lookup a Scottish Postcode"},"sidebar":"docsSidebar","previous":{"title":"Schema","permalink":"/docs/scottish-postcode/schema"},"next":{"title":"Libraries","permalink":"/docs/libraries"}}');var a=t(31325),i=t(31736);const s={sidebar_label:"Lookup",title:"Lookup a Scottish Postcode"},r=void 0,l={},c=[{value:"Endpoint",id:"endpoint",level:2},{value:"Example Request",id:"example-request",level:2},{value:"Example Response",id:"example-response",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.p,{children:"This endpoint returns the full Scottish Postcode Directory (SPD) record for a Scottish postcode: council area, electoral ward, NHS health board and integration authority, data zone and intermediate zone, locality and settlement, civil parish, urban-rural classification, Scottish Index of Multiple Deprivation, census household and population counts, and the equivalent GSS / official codes \u2014 including historical (year-suffixed) values where the upstream record carries them."}),"\n",(0,a.jsx)(n.p,{children:"A successful request returns HTTP status code 200 and a JSON object containing the postcode's SPD data."}),"\n",(0,a.jsx)(n.p,{children:'If the postcode is not found in the Scottish Postcode Directory (SPD), the API returns a 404 response. For postcodes that exist in the ONS Postcode Directory (ONSPD) but not in SPD, a 404 response is returned with the message "Postcode exists in ONSPD but not in SPD".'}),"\n",(0,a.jsxs)(n.p,{children:["For the full field listing see the ",(0,a.jsx)(n.a,{href:"/docs/scottish-postcode/schema",children:"Scottish Postcode Schema"}),". The ",(0,a.jsx)(n.a,{href:"/docs/api/get-scottish-postcode",children:"API Documentation"})," details the OpenAPI shape."]}),"\n",(0,a.jsx)(n.h2,{id:"endpoint",children:"Endpoint"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-http",children:"GET https://api.postcodes.io/scotland/postcodes/:postcode\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-request",children:"Example Request"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-http",children:"GET https://api.postcodes.io/scotland/postcodes/AB101XG\n"})}),"\n",(0,a.jsx)(n.p,{children:'The above would match any of these inputs: "AB10 1XG", "ab101xg", "Ab10 1Xg", etc.'}),"\n",(0,a.jsx)(n.h2,{id:"example-response",children:"Example Response"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "status": 200,\n "result": {\n "postcode": "AB10 1XG",\n "pc_compact": "AB101XG",\n "postcode_district": "AB10",\n "postcode_sector": "AB10 1",\n "incode": "1XG",\n "outcode": "AB10",\n "user_type": "0",\n "date_of_introduction": "198001",\n "date_of_deletion": null,\n "linked_small_user_postcode": null,\n "longitude": -2.10250,\n "latitude": 57.14945,\n "eastings": 393859,\n "northings": 806073,\n "split_indicator": "0",\n "grid_link_indicator": "1",\n "grid_link_positional_accuracy": "1",\n "council_area": "Aberdeen City",\n "electoral_ward": "Midstocket/Rosemount",\n "registration_district": "RD20",\n "enterprise_region": "Highlands and Islands",\n "strategic_development_planning_area": "SD01",\n "local_government_district": "Aberdeen City",\n "local_government_district_1991": "City of Aberdeen",\n "uk_parliamentary_constituency": "Aberdeen South",\n "scottish_parliamentary_region": "North East Scotland",\n "scottish_parliamentary_constituency": "Aberdeen Central",\n "health_board_area": "Grampian",\n "health_board_area_2006": "Grampian",\n "health_board_area_1995": "Grampian",\n "integration_authority": "Aberdeen City",\n "output_area": "S00136537",\n "output_area_2011": "S00088970",\n "output_area_2001": "S00000700",\n "output_area_1991": null,\n "data_zone": "West End North - 01",\n "data_zone_2011": "S01006571",\n "data_zone_2001": "S01000125",\n "intermediate_zone": "West End North",\n "intermediate_zone_2011": "S02000007",\n "intermediate_zone_2001": "S02000017",\n "locality": "Aberdeen",\n "locality_2020": "Aberdeen",\n "locality_2001": "Aberdeen",\n "locality_1991": null,\n "settlement": "Aberdeen, Milltimber, and Peterculter",\n "settlement_2020": "Aberdeen Settlement",\n "settlement_2001": "Aberdeen Settlement",\n "civil_parish": "Old Machar",\n "island": "Mainland of Scotland",\n "national_park": null,\n "travel_to_work_area": "Aberdeen",\n "lau_level_1": "Aberdeen City",\n "itl_level_2": "North Eastern Scotland",\n "itl_level_3": "Aberdeen City and Aberdeenshire",\n "urban_rural_6_fold": "1",\n "urban_rural_8_fold": "1",\n "scottish_index_of_multiple_deprivation": 6414,\n "roa_community_planning_partnership": "Aberdeen City",\n "roa_local": "Aberdeen City",\n "census_household_count": 0,\n "census_household_count_2011": 8,\n "census_household_count_2001": 12,\n "census_household_count_1991": null,\n "census_population_count": 0,\n "census_population_count_2011": 18,\n "census_population_count_2001": 26,\n "census_population_count_1991": null,\n "never_digitised": false,\n "codes": {\n "council_area": "S12000033",\n "electoral_ward": "S13002841",\n "enterprise_region": "S99999999",\n "local_government_district": "S12000033",\n "local_government_district_1991": "S99999999",\n "uk_parliamentary_constituency": "S14000061",\n "scottish_parliamentary_region": "S17000016",\n "scottish_parliamentary_constituency": "S16000094",\n "health_board_area": "S08000020",\n "health_board_area_2006": "S08000006",\n "health_board_area_1995": "0",\n "integration_authority": "S37000002",\n "data_zone": "S01013550",\n "data_zone_2011": "S01006571",\n "data_zone_2001": "S01000125",\n "intermediate_zone": "S02002527",\n "intermediate_zone_2011": "S02000007",\n "intermediate_zone_2001": "S02000017",\n "locality": "S19000001",\n "settlement": "S20000001",\n "civil_parish": "S07000001",\n "island": "S20000001",\n "national_park": null,\n "travel_to_work_area": "S22000047",\n "lau_level_1": "TLM50",\n "itl_level_2": "TLM5",\n "itl_level_3": "TLM50",\n "registration_district": "RD20",\n "strategic_development_planning_area": "SD01",\n "roa_community_planning_partnership": "S12000033",\n "roa_local": "S12000033"\n }\n }\n}\n'})})]})}function _(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},31736(e,n,t){t.d(n,{R:()=>s,x:()=>r});var o=t(20489);const a={},i=o.createContext(a);function s(e){const n=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[7031],{88082(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>_,frontMatter:()=>s,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"scottish-postcode/lookup","title":"Lookup a Scottish Postcode","description":"This endpoint returns the full Scottish Postcode Directory (SPD) record for a Scottish postcode: council area, electoral ward, NHS health board and integration authority, data zone and intermediate zone, locality and settlement, civil parish, urban-rural classification, Scottish Index of Multiple Deprivation, census household and population counts, and the equivalent GSS / official codes \u2014 including historical (year-suffixed) values where the upstream record carries them.","source":"@site/docs/scottish-postcode/lookup.mdx","sourceDirName":"scottish-postcode","slug":"/scottish-postcode/lookup","permalink":"/docs/scottish-postcode/lookup","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"sidebar_label":"Lookup","title":"Lookup a Scottish Postcode"},"sidebar":"docsSidebar","previous":{"title":"Schema","permalink":"/docs/scottish-postcode/schema"},"next":{"title":"Libraries","permalink":"/docs/libraries"}}');var a=t(31325),i=t(31736);const s={sidebar_label:"Lookup",title:"Lookup a Scottish Postcode"},r=void 0,l={},c=[{value:"Endpoint",id:"endpoint",level:2},{value:"Example Request",id:"example-request",level:2},{value:"Example Response",id:"example-response",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.p,{children:"This endpoint returns the full Scottish Postcode Directory (SPD) record for a Scottish postcode: council area, electoral ward, NHS health board and integration authority, data zone and intermediate zone, locality and settlement, civil parish, urban-rural classification, Scottish Index of Multiple Deprivation, census household and population counts, and the equivalent GSS / official codes \u2014 including historical (year-suffixed) values where the upstream record carries them."}),"\n",(0,a.jsx)(n.p,{children:"A successful request returns HTTP status code 200 and a JSON object containing the postcode's SPD data."}),"\n",(0,a.jsx)(n.p,{children:'If the postcode is not found in the Scottish Postcode Directory (SPD), the API returns a 404 response. For postcodes that exist in the ONS Postcode Directory (ONSPD) but not in SPD, a 404 response is returned with the message "Postcode exists in ONSPD but not in SPD".'}),"\n",(0,a.jsxs)(n.p,{children:["For the full field listing see the ",(0,a.jsx)(n.a,{href:"/docs/scottish-postcode/schema",children:"Scottish Postcode Schema"}),". The ",(0,a.jsx)(n.a,{href:"/docs/api/get-scottish-postcode",children:"API Documentation"})," details the OpenAPI shape."]}),"\n",(0,a.jsx)(n.h2,{id:"endpoint",children:"Endpoint"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-http",children:"GET https://api.postcodes.io/scotland/postcodes/:postcode\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-request",children:"Example Request"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-http",children:"GET https://api.postcodes.io/scotland/postcodes/AB101XG\n"})}),"\n",(0,a.jsx)(n.p,{children:'The above would match any of these inputs: "AB10 1XG", "ab101xg", "Ab10 1Xg", etc.'}),"\n",(0,a.jsx)(n.h2,{id:"example-response",children:"Example Response"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "status": 200,\n "result": {\n "postcode": "AB10 1XG",\n "pc_compact": "AB101XG",\n "postcode_district": "AB10",\n "postcode_sector": "AB10 1",\n "incode": "1XG",\n "outcode": "AB10",\n "user_type": "0",\n "date_of_introduction": "198001",\n "date_of_deletion": null,\n "linked_small_user_postcode": null,\n "longitude": -2.10250,\n "latitude": 57.14945,\n "eastings": 393859,\n "northings": 806073,\n "split_indicator": "0",\n "grid_link_indicator": "1",\n "grid_link_positional_accuracy": "1",\n "council_area": "Aberdeen City",\n "electoral_ward": "Midstocket/Rosemount",\n "registration_district": "RD20",\n "enterprise_region": "Highlands and Islands",\n "strategic_development_planning_area": "SD01",\n "local_government_district": "Aberdeen City",\n "local_government_district_1991": "City of Aberdeen",\n "uk_parliamentary_constituency": "Aberdeen South",\n "scottish_parliamentary_region": "North East Scotland",\n "scottish_parliamentary_region_2021": "North East Scotland",\n "scottish_parliamentary_constituency": "Aberdeen Central",\n "scottish_parliamentary_constituency_2021": "Aberdeen Central",\n "health_board_area": "Grampian",\n "health_board_area_2006": "Grampian",\n "health_board_area_1995": "Grampian",\n "integration_authority": "Aberdeen City",\n "output_area": "S00136537",\n "output_area_2011": "S00088970",\n "output_area_2001": "S00000700",\n "output_area_1991": null,\n "data_zone": "West End North - 01",\n "data_zone_2011": "S01006571",\n "data_zone_2001": "S01000125",\n "intermediate_zone": "West End North",\n "intermediate_zone_2011": "S02000007",\n "intermediate_zone_2001": "S02000017",\n "locality": "Aberdeen",\n "locality_2020": "Aberdeen",\n "locality_2001": "Aberdeen",\n "locality_1991": null,\n "settlement": "Aberdeen, Milltimber, and Peterculter",\n "settlement_2020": "Aberdeen Settlement",\n "settlement_2001": "Aberdeen Settlement",\n "civil_parish": "Old Machar",\n "island": "Mainland of Scotland",\n "national_park": null,\n "travel_to_work_area": "Aberdeen",\n "lau_level_1": "Aberdeen City",\n "itl_level_2": "North Eastern Scotland",\n "itl_level_3": "Aberdeen City and Aberdeenshire",\n "urban_rural_6_fold": "1",\n "urban_rural_8_fold": "1",\n "scottish_index_of_multiple_deprivation": 6414,\n "roa_community_planning_partnership": "Aberdeen City",\n "roa_local": "Aberdeen City",\n "census_household_count": 0,\n "census_household_count_2011": 8,\n "census_household_count_2001": 12,\n "census_household_count_1991": null,\n "census_population_count": 0,\n "census_population_count_2011": 18,\n "census_population_count_2001": 26,\n "census_population_count_1991": null,\n "never_digitised": false,\n "codes": {\n "council_area": "S12000033",\n "electoral_ward": "S13002841",\n "enterprise_region": "S99999999",\n "local_government_district": "S12000033",\n "local_government_district_1991": "S99999999",\n "uk_parliamentary_constituency": "S14000061",\n "scottish_parliamentary_region": "S17000026",\n "scottish_parliamentary_region_2021": "S17000014",\n "scottish_parliamentary_constituency": "S16000151",\n "scottish_parliamentary_constituency_2021": "S16000074",\n "health_board_area": "S08000020",\n "health_board_area_2006": "S08000006",\n "health_board_area_1995": "0",\n "integration_authority": "S37000002",\n "data_zone": "S01013550",\n "data_zone_2011": "S01006571",\n "data_zone_2001": "S01000125",\n "intermediate_zone": "S02002527",\n "intermediate_zone_2011": "S02000007",\n "intermediate_zone_2001": "S02000017",\n "locality": "S19000001",\n "settlement": "S20000001",\n "civil_parish": "S07000001",\n "island": "S20000001",\n "national_park": null,\n "travel_to_work_area": "S22000047",\n "lau_level_1": "TLM50",\n "itl_level_2": "TLM5",\n "itl_level_3": "TLM50",\n "registration_district": "RD20",\n "strategic_development_planning_area": "SD01",\n "roa_community_planning_partnership": "S12000033",\n "roa_local": "S12000033"\n }\n }\n}\n'})})]})}function _(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},31736(e,n,t){t.d(n,{R:()=>s,x:()=>r});var o=t(20489);const a={},i=o.createContext(a);function s(e){const n=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/4c458f53.97238a6b.js b/build/assets/js/4c458f53.97238a6b.js
new file mode 100644
index 000000000..366efa409
--- /dev/null
+++ b/build/assets/js/4c458f53.97238a6b.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[595],{64570(e,t,a){a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>C,frontMatter:()=>f,metadata:()=>i,toc:()=>S});const i=JSON.parse('{"id":"api/bulk-postcode-lookup","title":"Bulk Postcode Lookup","description":"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.","source":"@site/docs/api/bulk-postcode-lookup.api.mdx","sourceDirName":"api","slug":"/api/bulk-postcode-lookup","permalink":"/docs/api/bulk-postcode-lookup","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"bulk-postcode-lookup","title":"Bulk Postcode Lookup","description":"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.","sidebar_label":"Bulk Postcode Lookup","hide_title":true,"hide_table_of_contents":true,"api":"eJztPO1SIzmSr5JR8wO4sI1toLvx/tilaYZhhq/FEOzsMAFylWxrUEk1kgra20HEPcQ94T3JRaaqylVlY7C76buL2I6Ywa6SUvkl5af1JXBsZIPeb8G5ti7UEYe/p9xMgt8bgU64YU5odRQFveBjKu+hGHSs9X2aBI0g4jY0IsFhQS/YC0OeOAsMfu6fnYIe/MFDB6FWjgkl1AiYAmYMm4AeQpIBsy244C41CudJYR2+jJkLxzijGAVMRWC4TXjoxAMH9sCEZAPJIWKOtW7UjfrIwaaGg9Ng00EsnEfD8D9Tbp0Fy51DmHf7WjmuXPNykvA7HH7HkkSKkMjd/MNqdUcAc3rSBAd12u0S0vj+hx9+IJ7AJ+YYPrgcCwsxd2Md0bLC8GW5gSsNOH3nUQN4a0RL3d3dIV436suNArgJivE3QQ9+uwnOL7ag3T+8CRpwE5xs78C7w1P/5eAfnXew8/H4Jvj9Rj0RJI87kEwv+AM3lsMh16GOhBoRJ/GNM0xZyRy3MOJaas8eC0I5XaiCbcEsl8rDWzcqaAQJMyzmjhtUtt8bAQpSK8tt0PsSdNtt/FPVpX4ahtzaoBGEXlo4pC4mfGbDMY8ZfnLCSR70prp8ka0SNAI3SfCVF0KACJB0ItR965hLLT20qXSo/IlB9XfCI5gNwCU8GKEcH3ETNIKhNjFz/tFWN2gEXKVx0Put227//lRAnKFuX8eJ4WOuLOpyzixSZRAqlClKAvk4MiwZixBCrU0kFEqjASyKhRLW4f584DDQqYqYEfRKRcAlD502TIJQHj+EPdQG3Jjn24FHhc69wJ7SMJ3mn4TKPvyZMincBClnFrcXMlJp48bZ51CnyhkcoMb2dsyCRkD439KLSfE1QoIEre4fPDITBY1AajUSLqXFJHP5x4QZKVjMlWNmchtqZfEVVyGhkqL8mLotWHFr+AhZj6IVMU1hht86k1pPb/6WGWHHuJTViGrs/4QcUQnDEQ4Z4pOIOX6rh7dCOaOjNHR+fv7YcROjuPxToSL+GR/HqXQikfw24okRD/n754m57ba720EjsFzxKKrTOefprdIZqwuanHtEjD02TN4mzNwHjWCQ4lMRDpAypkJubpmUAj9l9Hc6GQfoAz7p5k/oQ/bHpGEn+0vfJU+yP7ghVOq8GkTczm6tQrnm7N+pXqJmqNGMvbn6pdBh8Ireg25zG8IxMyx03IBOHaoR4JAGMLAJC7nfJQy2mtOBQhXjYB0P3Qb0rzt70N3b22jBVYJyjSDWyo3lBIZGx3ChJ0zCCROyhSr3mcUJoZ/PC56mG6ZE3VmG0v5rKLwccxgKYx0kzJBlZFOSB3yo0dyNuacL1ivE240WkEEaccUNk3ICIuLKiaFAMzP2RoZJcPpRgTaQ78BZcpCUbMeXKDlSyxFieahVNI8SNkQZlAhh8pFNLGxVqfmJy8TmREwAfQExFCFYZzh3FmkYpELi2WnhUeARlK3CJDDDWZWyjpdRfoJVNVD4zQJ/92/hSEVoebSZkjq1AlVaF82G9U5zd6MF/bF+9ELwxgUZgt+YtWKkeAQjI9CHGHLDVch7aJX/Azo9uPZk4dic1nwuOU08AhZFhlsLodSWW4dWOZc2cTvmjKB1e7BnyS50GsA/oxWHwQQehE3JdnhfSyuEf8xUJIXCRRIL6/1QO4m7SCs52UBgWz3YSxKjP4uYOfLBMgHstNEjMtziqO3e1IlMlXCEC6yzB27YiEd+Y2X4cy9DsCyeIk9r7fTgwDpaKEKMz077kFrkhE2NQWtYcR1xyrvSwpZsQrZ0zISSEzg/g4/6M7cE/0MPLrPzu2QmYV0y6+Be4XbBJasiopm7PTjVZWM99VPJDyqUr/NUMpglzTuYGtGXfQ2VSgId9JxJ+bwtd1bHErJFYf0fzSmaG+S5eTmhk61likDQM/cOYKZCH41wwo7hNDMlcIjAUYMOP9KhioOOzPwhp+gUcKPgyHDUnRZcCynR2UU6aMj+mCnFJRxZHOB9/iMrOWrgCVOV7buz1W5vv38qOxslPp6WPJC3YWS+LKz/+v+ck533u7s7qJC5q1bi437hvb18vl/9AlNPBCMdmpo5nsKWNtKBGiFaDcjPkQZcM4n+a520Rp2SBp7yJUo2qmd6BhnP9czdLBHTR4+Zj0QIP3Em3Rj2UjfWxruvdfpe1onTn/ow9oBYDojMzCzJVSSPtYq0QhwrnnCd7athVQsOPOw5GMEp6srjmGcuxNSTYlJa9JysQNOcQWhK/sBlidB1nJSqiBs5wW1w2O9790mQXSPLa3kaYTAejoFZuDvYzf7dNfCkHrKQRx4E3PlgssyPu6pokfKnmWChxLNP0wDiq7mWw0dlQzvFzKRE+gvivebWxUJZx81UxhTNlLC99tHN8pgWIc1mDWdyxl5Are9a8DOLuV2ziNo0tiphdlwKuDL0VBoPqidnpFPE8iWErw/7H7ahWKZkGWEdLVHzER2UJHOYNlpwwibFOSaG5UwCpKqwpRWimu1Wp/v+HZqCIj4skzONGb8RNRnACjFkDZpWp278leTsdFo77a2dbTyQFwS5ZVWa6hucl2fAfjVcXF7Zrn6pQSzj8JKy7QuM8sh7pAOPjFBtczwfqZedomwQHBSZjQsaBOsHBxcbK1H2PMxXH95zMgnlGMK/hX1mOFziW1g/379cDVtvZnCh+kn1jL2BT2JInooDxWI8n0OtHjBwwhQe5tEmwEKjrUUZe5bbhcfYrFguigTD0vR4YExCxDHeKWeoKo4C7lA0MHCoH7hRqIVwNhyKkGfSoqDv8OzCbjwrJZ/RKUuGnmzu6zjGs321nRGKByHBAy8cmg3EJszhwjo5NRtL2IsGpMrDxDjOcEanNOagKgf0IzdwzCbcQD9NuIGz1CWpgz2csCwx3Xa3A/tc2dTCcf9sL8uB2JhJyQ2Fp8I6EWYhdAPcJMFvcgKdRrvdbnYaO+02+roUmGOcfqofIdFCOXJ3aQFK0j9HNbQ7H/aR0rhG6YmIIsnfhNSTKamxiJpW/IsvpHWHaH2P//9qWpFUzCjOOHylw+irvJnM6ZsmgiPxIGy+x1BZUWtLFZiZ+GFaj8AYXKcOWD0A0pg1A43u+nNnSOazYd60TKsUiniMO1BYxIscSKOpprQcueiELwIIWalBYKmIKJNM0evSmWq5eRAhx9oGZFu5KkBchUITsl9QOl2GtdKDxLPpR21CvpqOXpIrTlCGBOU1AcUJd0bjLMcUeBwQubk56rLHjK6LHsJRNYe9PMIRpXzKQcQjo0IRgeUR8vXXX3/99eQky9PWEnG7H9rtThnjcvp8DsKXlez6t8LXTXM+M/j6aAnFINHqTrfOHHVfnO2vJFAj/pni2GwgfKqUBb42cYFJqoVrwPrRyacNMEzdz6rYmrcHLfD2BgdZCLXxGyrC4y7G/LMnLrNXtgVFcJ+F9EWuEP+rx/eQWg7IsIQrPFLh6OQT2BBnwn//53/BA5MpZtEMJlwcRMLw0En0Q2OsKeKmztwYn24QNZF0tj9sby30pH2FZWl3GtZx3mre3JJeNQyY5ZhqhZ9TOUEbs12q+S3vc8+rJZWzJPQa9iexSb8+gqhAW7/m0o5LxG+8FFDAGWZns7ovSttp8ECKLfgXb7W4tJyyGTWGMG6iSRTBOVfMuPEzDMCy2Wt4AKd58PgtsopLMceHrW/Ao872U6ViWE6j/tTP9zN8hbs/C+aVZMy6Ks94+VTjLCF+aRimq5AT2tyvbornwJmH+uXl9Z4/pegQzNJqMfaGJFzjqTvQbuxtBzLhUZv750ip1mnLwsgTwee+gLuCHMoQaoeMT/v5ok0DkxVMTeZZNywbl5D6mArpmmmyOosrEOhY7c4LmabjPIuR2aRQj2MRjmHMLAw4V7AmjKGeFjGQE0jNgClhebRWZfeh4QwP+CnbsRBesc2Ojww5AxTBf9SrJuxQ+edCm3FNSx5p4aVSrU/YOeXLuT7p/JUo4KiV+MsOOb2CvWn1f3kqazDmCbA2xMIAoYPTI05BBBKUGP0gIm58xSIs/Hl84jSIGAdw8MQAsqrKlIsT1G1H49dLfNnIA+lO59WhNOpip7O8icdZMxF1C/akYLZow1lDZNZgKLiMWnCkpm4Scc0n0amxDP6pFW+gIsw4Tzikj4E64fu6+LrKgMUR9rfgwMmzHIhfwwHUZxPzSKDLjpx4MbLO+lSWkXJ3JRrn5E2+qyS7S0rya6k8eZnK5aVVJ+Mb41wGR2au6ZsuKLtlHYR+WN5pV7V4wUG73W5vdz7sUAKU2pzK+c/UMNm8QgsD+xI7N4ZZc+Kq+wYP0vLeWbDCCxkBPydmf1BCUqEZpDWe8jatV9OxigQ8Hd23pYPazCq7HFNAB6iBiRGWF4ZgLBJYz9Lxq9GSZfph4RJzLN7xwbl3VJLpOHRT3CN6KpKg5WVFkfU4D7CThdpfnnMQqbHu1YT3qetqZdJtPn1J4smFFK7iVgIm8SVLEjT7xwfnWcZgjpNJTYM1b8zkjjGmf4xw2ggm4RjL0hbWjy6PlyewX0r4FkcA5P2EmMAqrepTDsJi0WFamDi9uuxDE051zFUomcMGdD2EKyWcN3VlZIv17IZvMKdI/WemUmQw7pgGDLWU+hE59NHwz8I1/BKYoDI8kVQzH0zg6PIY1l9iywZkrWJXv7Ru1I/YH8fC+6zTMU6YEwOB/WmNUj+30NSjLlTqu1Uyj8xLlxqUfcUewd6QoG4Cb8Sx0rS4FO6bQEty3asWs/bp/Ww7cr15mlrovcXBtoP1UnWoLNK+T+tugM9kozTmVM8sJvEd7xU/Q1g7930LNGstbwc9zpsX5vXXNOCk8rrUoNKA08qr2Q6XfuV9bld9DFQOJ5nvFXTaTEraGmluKTfGPwvrWpgMRz5IjX0udqxTGcEYu/co42l5xgxmYe1UO2zay+LtNTCM/HA3ZgocBkjkno95jKMfmBQRHH2i/VruD3+mfbvW3p11cxf91b6XOgxHtyIqGqyzXmHJ0u5MC7Zvu17Y9v1yG/X/mb7omUbol/taSNWfabZ9IQ+MFVM8FXZLHc9Fv05xdD/TA1N3iXbRKdraerl96Xsj7PGooZvvrcWdON8bVcShzteddmfrQ/vdopr1m6PpF65htr3Vbre7W4RZvZS3f/jmOC2q7tUw3fqAmO7kmOLRUkP26NPyTsJYG5e1tuX982YV9K67V1v/nFf7Pfj09kx8rr68YLvMOGGXx1+JYxWnF7yXOSmvy+OjrS65wGghyi7w3lV3Ndy8V1vzQ9B7A9/w2K1v5BmkKifiTK8GxsxvLdx6KqKOXwc7pf3+nemw+N74nczBr9tut3ffv59XT//x7bGbqdnX0Ovi8ZfVp1/XkLegavjmxCwoWM6rHm6Us3I+AHjBi6pxp7Pdbrffbe0u5s5MkfUVLFq1wvr1nFqi3lqh//kaWlb0emvpz9bZ6qacVLm9Nbdkdnm9txp284pks6mcA9pH3a3t1xe53p5h5dWWrXathtncctc8bm3jqf3h3bza1P7HN+fM3DpSDcUdUqfu++XKS2/v61TXqyP9jrbA7jMFIbSHlIJ9e6NYrRLNHsSI3QumvFbM+V9B/mQu8vEc5Et2fk6RxiPf/R7IL+Uudefx+Duj+YLXtKiI4sGsgueiOso3qpN4PVoNuVeVSWZx3essWwT5NhxcAcmZCsfB+bSQ8bb697qaR91kvUc92OnMLVIg7tNaxFtj/7qyxazFf3pCz6h+EcGT/9cIPjfxe59m4FUmXwLJ1CjoBWPnEspcDrgMegHdogNXF8d4SYNODRpEGmN7m5ssEa2klG/fLL5s3mCBpwAaegBVoPvHR2WgYWokNA+heQ83Nzeq2cTva69Yaq26Vo2AU84M1keXJuGvC0nIwX4jIv5KRPzeCPydO0GP7pOgTLAbB71gOpIuyzAP/gKaL0Fq5AJqZi82Oj+iYgL1+T0wI1A9MTfyhIvjLSuo6tR0ROM7H1rtVhvpFlhgJm8IiyNoP44ug0ZtfZ1w5XnR0ma0mU2ymzi2pI6IxUXRft+s1GxwG3ET27NhVvQoga/wLtKhLVaYd3XBtAyE2Q4YGl5qk5Z08RMgJhhjjOjSoCIbltWZ6HKhAxXRzyKozCXltMU+ZAp/acDoep/8J/84d1r44tnc/OajG/WcpIrrjLBUSVhllxEdHlwShudn/cviBqiW/+qVxVLrcXa5EP7Qgz93DdQPPxQ3CVn8fsDCcd67hRDi/KYCvNAJ70BIDPU//HR5eU71qNTmF4v4SxaQW3gn1HmBGV3VwakVGi//wep5m4ZZfw1SA7azBwwGLMrn4eNteowFoCHGqET1Tj6bdBa4MdrQCrM4oZCl1fnCUV4xLOgb6GiSswF/L40ZUM8ifFhRmKIUlZWHqLY9He+vgqILsHyFg8dM4D6waZJo4/4mIs5kcyrfULfSe6rQ0Nbp+2Ez22futM0MaIDHNr6LmSptw9fcZ/ZlevXUv682+/fVZs9cbZZ5L45/dpuJZIJaNEhBv2RmaHqFFl2ANEYT1fst+PIF80xXRj494eM/6eI9uh0ttzD47akRjDmLuCG7dc8nhTKSKZIpLj5zL1rFJuKhFzw9/Q8TBmkx","sidebar_class_name":"post api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Retrieve a Random Place","permalink":"/docs/api/random-place"}}');var o=a(31325),n=a(31736),r=a(47812),s=a.n(r),l=a(38616),c=a.n(l),p=a(67994),d=a.n(p),u=a(54768),m=a.n(u),h=(a(24909),a(96847),a(78121));const f={id:"bulk-postcode-lookup",title:"Bulk Postcode Lookup",description:"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.",sidebar_label:"Bulk Postcode Lookup",hide_title:!0,hide_table_of_contents:!0,api:"eJztPO1SIzmSr5JR8wO4sI1toLvx/tilaYZhhq/FEOzsMAFylWxrUEk1kgra20HEPcQ94T3JRaaqylVlY7C76buL2I6Ywa6SUvkl5af1JXBsZIPeb8G5ti7UEYe/p9xMgt8bgU64YU5odRQFveBjKu+hGHSs9X2aBI0g4jY0IsFhQS/YC0OeOAsMfu6fnYIe/MFDB6FWjgkl1AiYAmYMm4AeQpIBsy244C41CudJYR2+jJkLxzijGAVMRWC4TXjoxAMH9sCEZAPJIWKOtW7UjfrIwaaGg9Ng00EsnEfD8D9Tbp0Fy51DmHf7WjmuXPNykvA7HH7HkkSKkMjd/MNqdUcAc3rSBAd12u0S0vj+hx9+IJ7AJ+YYPrgcCwsxd2Md0bLC8GW5gSsNOH3nUQN4a0RL3d3dIV436suNArgJivE3QQ9+uwnOL7ag3T+8CRpwE5xs78C7w1P/5eAfnXew8/H4Jvj9Rj0RJI87kEwv+AM3lsMh16GOhBoRJ/GNM0xZyRy3MOJaas8eC0I5XaiCbcEsl8rDWzcqaAQJMyzmjhtUtt8bAQpSK8tt0PsSdNtt/FPVpX4ahtzaoBGEXlo4pC4mfGbDMY8ZfnLCSR70prp8ka0SNAI3SfCVF0KACJB0ItR965hLLT20qXSo/IlB9XfCI5gNwCU8GKEcH3ETNIKhNjFz/tFWN2gEXKVx0Put227//lRAnKFuX8eJ4WOuLOpyzixSZRAqlClKAvk4MiwZixBCrU0kFEqjASyKhRLW4f584DDQqYqYEfRKRcAlD502TIJQHj+EPdQG3Jjn24FHhc69wJ7SMJ3mn4TKPvyZMincBClnFrcXMlJp48bZ51CnyhkcoMb2dsyCRkD439KLSfE1QoIEre4fPDITBY1AajUSLqXFJHP5x4QZKVjMlWNmchtqZfEVVyGhkqL8mLotWHFr+AhZj6IVMU1hht86k1pPb/6WGWHHuJTViGrs/4QcUQnDEQ4Z4pOIOX6rh7dCOaOjNHR+fv7YcROjuPxToSL+GR/HqXQikfw24okRD/n754m57ba720EjsFzxKKrTOefprdIZqwuanHtEjD02TN4mzNwHjWCQ4lMRDpAypkJubpmUAj9l9Hc6GQfoAz7p5k/oQ/bHpGEn+0vfJU+yP7ghVOq8GkTczm6tQrnm7N+pXqJmqNGMvbn6pdBh8Ireg25zG8IxMyx03IBOHaoR4JAGMLAJC7nfJQy2mtOBQhXjYB0P3Qb0rzt70N3b22jBVYJyjSDWyo3lBIZGx3ChJ0zCCROyhSr3mcUJoZ/PC56mG6ZE3VmG0v5rKLwccxgKYx0kzJBlZFOSB3yo0dyNuacL1ivE240WkEEaccUNk3ICIuLKiaFAMzP2RoZJcPpRgTaQ78BZcpCUbMeXKDlSyxFieahVNI8SNkQZlAhh8pFNLGxVqfmJy8TmREwAfQExFCFYZzh3FmkYpELi2WnhUeARlK3CJDDDWZWyjpdRfoJVNVD4zQJ/92/hSEVoebSZkjq1AlVaF82G9U5zd6MF/bF+9ELwxgUZgt+YtWKkeAQjI9CHGHLDVch7aJX/Azo9uPZk4dic1nwuOU08AhZFhlsLodSWW4dWOZc2cTvmjKB1e7BnyS50GsA/oxWHwQQehE3JdnhfSyuEf8xUJIXCRRIL6/1QO4m7SCs52UBgWz3YSxKjP4uYOfLBMgHstNEjMtziqO3e1IlMlXCEC6yzB27YiEd+Y2X4cy9DsCyeIk9r7fTgwDpaKEKMz077kFrkhE2NQWtYcR1xyrvSwpZsQrZ0zISSEzg/g4/6M7cE/0MPLrPzu2QmYV0y6+Be4XbBJasiopm7PTjVZWM99VPJDyqUr/NUMpglzTuYGtGXfQ2VSgId9JxJ+bwtd1bHErJFYf0fzSmaG+S5eTmhk61likDQM/cOYKZCH41wwo7hNDMlcIjAUYMOP9KhioOOzPwhp+gUcKPgyHDUnRZcCynR2UU6aMj+mCnFJRxZHOB9/iMrOWrgCVOV7buz1W5vv38qOxslPp6WPJC3YWS+LKz/+v+ck533u7s7qJC5q1bi437hvb18vl/9AlNPBCMdmpo5nsKWNtKBGiFaDcjPkQZcM4n+a520Rp2SBp7yJUo2qmd6BhnP9czdLBHTR4+Zj0QIP3Em3Rj2UjfWxruvdfpe1onTn/ow9oBYDojMzCzJVSSPtYq0QhwrnnCd7athVQsOPOw5GMEp6srjmGcuxNSTYlJa9JysQNOcQWhK/sBlidB1nJSqiBs5wW1w2O9790mQXSPLa3kaYTAejoFZuDvYzf7dNfCkHrKQRx4E3PlgssyPu6pokfKnmWChxLNP0wDiq7mWw0dlQzvFzKRE+gvivebWxUJZx81UxhTNlLC99tHN8pgWIc1mDWdyxl5Are9a8DOLuV2ziNo0tiphdlwKuDL0VBoPqidnpFPE8iWErw/7H7ahWKZkGWEdLVHzER2UJHOYNlpwwibFOSaG5UwCpKqwpRWimu1Wp/v+HZqCIj4skzONGb8RNRnACjFkDZpWp278leTsdFo77a2dbTyQFwS5ZVWa6hucl2fAfjVcXF7Zrn6pQSzj8JKy7QuM8sh7pAOPjFBtczwfqZedomwQHBSZjQsaBOsHBxcbK1H2PMxXH95zMgnlGMK/hX1mOFziW1g/379cDVtvZnCh+kn1jL2BT2JInooDxWI8n0OtHjBwwhQe5tEmwEKjrUUZe5bbhcfYrFguigTD0vR4YExCxDHeKWeoKo4C7lA0MHCoH7hRqIVwNhyKkGfSoqDv8OzCbjwrJZ/RKUuGnmzu6zjGs321nRGKByHBAy8cmg3EJszhwjo5NRtL2IsGpMrDxDjOcEanNOagKgf0IzdwzCbcQD9NuIGz1CWpgz2csCwx3Xa3A/tc2dTCcf9sL8uB2JhJyQ2Fp8I6EWYhdAPcJMFvcgKdRrvdbnYaO+02+roUmGOcfqofIdFCOXJ3aQFK0j9HNbQ7H/aR0rhG6YmIIsnfhNSTKamxiJpW/IsvpHWHaH2P//9qWpFUzCjOOHylw+irvJnM6ZsmgiPxIGy+x1BZUWtLFZiZ+GFaj8AYXKcOWD0A0pg1A43u+nNnSOazYd60TKsUiniMO1BYxIscSKOpprQcueiELwIIWalBYKmIKJNM0evSmWq5eRAhx9oGZFu5KkBchUITsl9QOl2GtdKDxLPpR21CvpqOXpIrTlCGBOU1AcUJd0bjLMcUeBwQubk56rLHjK6LHsJRNYe9PMIRpXzKQcQjo0IRgeUR8vXXX3/99eQky9PWEnG7H9rtThnjcvp8DsKXlez6t8LXTXM+M/j6aAnFINHqTrfOHHVfnO2vJFAj/pni2GwgfKqUBb42cYFJqoVrwPrRyacNMEzdz6rYmrcHLfD2BgdZCLXxGyrC4y7G/LMnLrNXtgVFcJ+F9EWuEP+rx/eQWg7IsIQrPFLh6OQT2BBnwn//53/BA5MpZtEMJlwcRMLw0En0Q2OsKeKmztwYn24QNZF0tj9sby30pH2FZWl3GtZx3mre3JJeNQyY5ZhqhZ9TOUEbs12q+S3vc8+rJZWzJPQa9iexSb8+gqhAW7/m0o5LxG+8FFDAGWZns7ovSttp8ECKLfgXb7W4tJyyGTWGMG6iSRTBOVfMuPEzDMCy2Wt4AKd58PgtsopLMceHrW/Ao872U6ViWE6j/tTP9zN8hbs/C+aVZMy6Ks94+VTjLCF+aRimq5AT2tyvbornwJmH+uXl9Z4/pegQzNJqMfaGJFzjqTvQbuxtBzLhUZv750ip1mnLwsgTwee+gLuCHMoQaoeMT/v5ok0DkxVMTeZZNywbl5D6mArpmmmyOosrEOhY7c4LmabjPIuR2aRQj2MRjmHMLAw4V7AmjKGeFjGQE0jNgClhebRWZfeh4QwP+CnbsRBesc2Ojww5AxTBf9SrJuxQ+edCm3FNSx5p4aVSrU/YOeXLuT7p/JUo4KiV+MsOOb2CvWn1f3kqazDmCbA2xMIAoYPTI05BBBKUGP0gIm58xSIs/Hl84jSIGAdw8MQAsqrKlIsT1G1H49dLfNnIA+lO59WhNOpip7O8icdZMxF1C/akYLZow1lDZNZgKLiMWnCkpm4Scc0n0amxDP6pFW+gIsw4Tzikj4E64fu6+LrKgMUR9rfgwMmzHIhfwwHUZxPzSKDLjpx4MbLO+lSWkXJ3JRrn5E2+qyS7S0rya6k8eZnK5aVVJ+Mb41wGR2au6ZsuKLtlHYR+WN5pV7V4wUG73W5vdz7sUAKU2pzK+c/UMNm8QgsD+xI7N4ZZc+Kq+wYP0vLeWbDCCxkBPydmf1BCUqEZpDWe8jatV9OxigQ8Hd23pYPazCq7HFNAB6iBiRGWF4ZgLBJYz9Lxq9GSZfph4RJzLN7xwbl3VJLpOHRT3CN6KpKg5WVFkfU4D7CThdpfnnMQqbHu1YT3qetqZdJtPn1J4smFFK7iVgIm8SVLEjT7xwfnWcZgjpNJTYM1b8zkjjGmf4xw2ggm4RjL0hbWjy6PlyewX0r4FkcA5P2EmMAqrepTDsJi0WFamDi9uuxDE051zFUomcMGdD2EKyWcN3VlZIv17IZvMKdI/WemUmQw7pgGDLWU+hE59NHwz8I1/BKYoDI8kVQzH0zg6PIY1l9iywZkrWJXv7Ru1I/YH8fC+6zTMU6YEwOB/WmNUj+30NSjLlTqu1Uyj8xLlxqUfcUewd6QoG4Cb8Sx0rS4FO6bQEty3asWs/bp/Ww7cr15mlrovcXBtoP1UnWoLNK+T+tugM9kozTmVM8sJvEd7xU/Q1g7930LNGstbwc9zpsX5vXXNOCk8rrUoNKA08qr2Q6XfuV9bld9DFQOJ5nvFXTaTEraGmluKTfGPwvrWpgMRz5IjX0udqxTGcEYu/co42l5xgxmYe1UO2zay+LtNTCM/HA3ZgocBkjkno95jKMfmBQRHH2i/VruD3+mfbvW3p11cxf91b6XOgxHtyIqGqyzXmHJ0u5MC7Zvu17Y9v1yG/X/mb7omUbol/taSNWfabZ9IQ+MFVM8FXZLHc9Fv05xdD/TA1N3iXbRKdraerl96Xsj7PGooZvvrcWdON8bVcShzteddmfrQ/vdopr1m6PpF65htr3Vbre7W4RZvZS3f/jmOC2q7tUw3fqAmO7kmOLRUkP26NPyTsJYG5e1tuX982YV9K67V1v/nFf7Pfj09kx8rr68YLvMOGGXx1+JYxWnF7yXOSmvy+OjrS65wGghyi7w3lV3Ndy8V1vzQ9B7A9/w2K1v5BmkKifiTK8GxsxvLdx6KqKOXwc7pf3+nemw+N74nczBr9tut3ffv59XT//x7bGbqdnX0Ovi8ZfVp1/XkLegavjmxCwoWM6rHm6Us3I+AHjBi6pxp7Pdbrffbe0u5s5MkfUVLFq1wvr1nFqi3lqh//kaWlb0emvpz9bZ6qacVLm9Nbdkdnm9txp284pks6mcA9pH3a3t1xe53p5h5dWWrXathtncctc8bm3jqf3h3bza1P7HN+fM3DpSDcUdUqfu++XKS2/v61TXqyP9jrbA7jMFIbSHlIJ9e6NYrRLNHsSI3QumvFbM+V9B/mQu8vEc5Et2fk6RxiPf/R7IL+Uudefx+Duj+YLXtKiI4sGsgueiOso3qpN4PVoNuVeVSWZx3essWwT5NhxcAcmZCsfB+bSQ8bb697qaR91kvUc92OnMLVIg7tNaxFtj/7qyxazFf3pCz6h+EcGT/9cIPjfxe59m4FUmXwLJ1CjoBWPnEspcDrgMegHdogNXF8d4SYNODRpEGmN7m5ssEa2klG/fLL5s3mCBpwAaegBVoPvHR2WgYWokNA+heQ83Nzeq2cTva69Yaq26Vo2AU84M1keXJuGvC0nIwX4jIv5KRPzeCPydO0GP7pOgTLAbB71gOpIuyzAP/gKaL0Fq5AJqZi82Oj+iYgL1+T0wI1A9MTfyhIvjLSuo6tR0ROM7H1rtVhvpFlhgJm8IiyNoP44ug0ZtfZ1w5XnR0ma0mU2ymzi2pI6IxUXRft+s1GxwG3ET27NhVvQoga/wLtKhLVaYd3XBtAyE2Q4YGl5qk5Z08RMgJhhjjOjSoCIbltWZ6HKhAxXRzyKozCXltMU+ZAp/acDoep/8J/84d1r44tnc/OajG/WcpIrrjLBUSVhllxEdHlwShudn/cviBqiW/+qVxVLrcXa5EP7Qgz93DdQPPxQ3CVn8fsDCcd67hRDi/KYCvNAJ70BIDPU//HR5eU71qNTmF4v4SxaQW3gn1HmBGV3VwakVGi//wep5m4ZZfw1SA7azBwwGLMrn4eNteowFoCHGqET1Tj6bdBa4MdrQCrM4oZCl1fnCUV4xLOgb6GiSswF/L40ZUM8ifFhRmKIUlZWHqLY9He+vgqILsHyFg8dM4D6waZJo4/4mIs5kcyrfULfSe6rQ0Nbp+2Ez22futM0MaIDHNr6LmSptw9fcZ/ZlevXUv682+/fVZs9cbZZ5L45/dpuJZIJaNEhBv2RmaHqFFl2ANEYT1fst+PIF80xXRj494eM/6eI9uh0ttzD47akRjDmLuCG7dc8nhTKSKZIpLj5zL1rFJuKhFzw9/Q8TBmkx",sidebar_class_name:"post api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},y=void 0,g={},S=[{value:"Post Data",id:"post-data",level:3},{value:"Bulk Reverse Geocoding",id:"bulk-reverse-geocoding",level:2}];function b(e){const t={code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Bulk Postcode Lookup"}),"\n",(0,o.jsx)(s(),{method:"post",path:"/postcodes",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data."}),"\n",(0,o.jsxs)(t.p,{children:["Be sure to submit JSON requests setting ",(0,o.jsx)(t.code,{children:"Content-Type"})," to ",(0,o.jsx)(t.code,{children:"application/json"}),"."]}),"\n",(0,o.jsx)(t.p,{children:"Accepts up to 100 postcodes."}),"\n",(0,o.jsx)(t.h3,{id:"post-data",children:"Post Data"}),"\n",(0,o.jsx)(t.p,{children:"This method requires a JSON object containing an array of postcodes to be posted, e.g."}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-json",children:'{\n "postcodes": ["PR3 0SG", "M45 6GN", "EX16 5BL"]\n}\n'})}),"\n",(0,o.jsx)(t.h2,{id:"bulk-reverse-geocoding",children:"Bulk Reverse Geocoding"}),"\n",(0,o.jsx)(t.p,{children:"Bulk translates geolocations into Postcodes. Accepts up to 100 geolocations."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:[]}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive location data including geographic coordinates, administrative boundaries, and electoral information for the requested postcode",type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","pfa","date_of_introduction","date_of_termination","index_of_multiple_deprivation","parliamentary_constituency_2024","senedd_constituency","senedd_constituency_no","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. Null where the postcode falls outside a county-level authority (the underlying GSS code is then a pseudo such as `E99999999`, surfaced under `codes.admin_county`).",example:null},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:"Caerdydd Penarth"},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:14},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",required:["admin_district","admin_county","admin_ward","parish","ccg","ccg_id","ced","nuts","lau2","lsoa","msoa","pfa","parliamentary_constituency","parliamentary_constituency_2024","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2"],properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}}}}}}}})]})}function C(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/4c458f53.a87fee80.js b/build/assets/js/4c458f53.a87fee80.js
deleted file mode 100644
index a9044649f..000000000
--- a/build/assets/js/4c458f53.a87fee80.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[595],{64570(e,t,i){i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>E,frontMatter:()=>g,metadata:()=>a,toc:()=>S});const a=JSON.parse('{"id":"api/bulk-postcode-lookup","title":"Bulk Postcode Lookup","description":"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.","source":"@site/docs/api/bulk-postcode-lookup.api.mdx","sourceDirName":"api","slug":"/api/bulk-postcode-lookup","permalink":"/docs/api/bulk-postcode-lookup","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"bulk-postcode-lookup","title":"Bulk Postcode Lookup","description":"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.","sidebar_label":"Bulk Postcode Lookup","hide_title":true,"hide_table_of_contents":true,"api":"eJztPO1y2ziSr9LF+WH7SpIl2U5i3Y89x/F4POOvteTyZsdTDkS2JExAgAOAdnQpV91D3BPek1w1QFIkJcuWEufqqjZVSSQSaHQ3Gv0tfA0sG5ug93twqYwNVYTw9xT1NPijEagENbNcyZMo6AXvU/EZikGnSn1Ok6ARRGhCzRMaFvSCgzDExBpg8Gv/4hzU8E8MLYRKWsYll2NgEpjWbApqBEkGzLTgCm2qJc0T3Fh6GTMbTmhGMQqYjECjSTC0/B6B3TMu2FAgRMyy1q28le8RTKoRrAKTDmNuPRoa/0rRWAMGrSWYnw6VtChtczBN8BMN/8SSRPDQkbv9p1HykwOY05MmNKjTbpeQpvc//fST4wl8YJbRg8GEG4jRTlTkluUaV+UGrTRE9x2jBmBr7Jb69OkT4XUrv95KgNugGH8b9OD32+Dyagfa/ePboAG3wdnuHrw5Pvdfjv7ReQN7709vgz9u5aOD5HEHt6dXeI/aIByjClXE5dhxkt5YzaQRzKKBMSqhPHsMcGlVIQqmBfNcKg9v3cqgESRMsxgtahK2PxoBbaSSBk3Q+xp02236rypL/TQM0ZigEYR+t2hIfZvomQknGDP6ZLkVGPRmsnyVrRI0AjtN6JXfhIAQcLsTkewby2xq3EOTCkvCn2gSf8s9gtkAWsKD4dLiGHXQCEZKx8z6RzvdoBGgTOOg93u33f7jsYA4R92hihONE5SGZDlnlhNl4DIUKe0E8XGsWTLhIYRK6YhL2o0GsCjmkhtL5/MeYahSGTHN3SsZAQoMrdJMAJceP4I9UhrsBPPjgFEhc8+wpzRMpfknLrMPf6VMcDslypmh40WMlErbSfY5VKm0mgbIibmbsKAROPzv3Itp8TUigrhb3T94YDoKGoFQcsxt6hYTzOYfE6YFZzFKy/T0LlTS0CuUoUMlpf1j8q5gxZ3GMbGetpbHbgrTeGd1ajy9+VumuZnQUkYRqrH/L0RCJQzHREZqPV0RmnlZKbi1QCBnjCZS5XhOgV7/VmwK+J3rQbe5C+GEaRZa1KBSS3wBGtIABiZhIfptZ7DTnA3kshgHm6RFGtC/6RxA9+BgqwXXScRIBGIl7URMYaRVDFdqygScMS5axMMvLE4c+vm84HEmASXqLjKUDl9C4WCCMOLaWEiYdqqezUge4kiR/p6gpws2K8SbrRY4DTtGiZoJMQUeobR8xElvTrzWZAKsepCgNOQiNU8OkZKJcImSE7kaIQZDJaNFlLAR7UGJECYe2NTATpWaX1AkJidiCmTc+IiHYKxGtIZoGKZckDIw8MDpTGWrMAFMI6tS1vF7lB/JqgRyQpwJ+Lt/CycyIlWq9IzUmVqr0rpsNmx2mvtbLehP1IPfBK8tiSH0jRnDxxIjGGtORnGEGmWIPTIz/wadHtx4smhsTms+13kBGAGLIo3GQCiUQWPJzOS77bgdI3PQuj04ME7RdRqAX8gswXAK99ykThl650FJgn/KZCS4pEUSA5v9UFlBp0hJMd0iYDs9OEgSrb7wmFnnVGQbsNcmE6/R0Kjd3swrSiW3DhfYZPeo2Rgjf7Ay/NHvIRgWz5B3a+314MhYt1BEGF+c9yE1xAmTak3qveIL0ZQ3pYWNU3LZ0jHjUkzh8gLeqy9oHPx3PRigjp39mOl92BTMWPgs6bjQktUtcjP3e3CuytZn5ng5w14IX+exZAFKknc0swrPG0+ZCgc66Fmd4qIjd1HHErJFYfMfzRmaW84V8ftEXqMSKQEhV9N7NJkIvdfccjOBc5bJ9zEBJwk6fu+UKg060YuHnJOVQy3hRCPJTgtuuBDkvREdbsjhhEmJAk4MDfBO7IkRSBJ4xmTl+O7ttNu7bx/L1rPEx/OSSX0dRubLwubH/+ec7Lzd398jgcx9jxIfDwt35Hn9fv0bzBwLct3d1MyT4qZ0kI7kmNBqQK5HGnDDBDlkddIadUoapOVLlGxVdXoGmfR65j+ViOmTC4hjHsIvyISdwEFqJ0p7f6xO3/Mycf5LHyYeEMsBOTMzT3IVyVMlIyUJx4prV2f7eljVvF0PewFGcMamJDIYJ9l7Qt3rXJVm2zdtCrxHUQGqqtITzOgofNISJR9mfuo305LDJxEg68H0tMT5Z5h+g8bGXBqLeoaxc5pL2N54J3p1TAvPebuGs3ORnkGtb1vwK4vRbBhCbebClzA7Lfn1GXoyjYdVfRaplLB8DuGb4/67XSiWKdkr2CT70HwgtyHJ3JitQlScduGjcsAKqSwsXIWoZrvV6b59Qwq6CEPK5MxCk+9ETQawQozT0U2jUjv5RnL2Oq299s7eLqnJJbFUWZRm8gaX5RlwWI2+Vhe2699qEMs4PCdsh5xiL+fTOTXkTEPtcDwdEJZdlWwQHBUB9JUbBJtHR1dba1H2NMwXq9QFAWvZs/dv4ZBphAG9hc3Lw8F62HrlTwvVNdUTVgA+8JHzHyxIFpPzECp5T+EMZYooXTMFFmplDO2xZ7lZqsbmt+Uqj81Xp8cDYwIipCiknAipmG86oajFFI7VPWpJUggXoxEPMdstF4odX1yZrSd3yScOyjvjnmwfqjgm3b7eyQj5PRfggRduxhZhE+ZwYdO5Glsr2IsGpNLDpOhKI3NamlIdFQX9gBpO2RQ19NMENVykNkktHNCEVYnptrsdOERpUgOn/YuDLDNhYiYEahc0cmN5mAW2DbDThL6JKXQa7Xa72WnstdvkgbpwmaLnc/UAieLSOifULeBywU9RDe3Ou0OiNK5ResajSOCrkHo2IzXmUdPw/8SltO45Wt/Sv99MK5FKias5N6ykjL7Jm8lcsVm+MeL33ORnjISVpLaU6J/z6mdp79xLY/WwRFEuCxQ50U/pEAL36NNzZVoFl47HdAK5IbxIQR1r5UoXq5FLrvEygJBltDlVJBxlgkn3uqRTDep7HiKl0CE7ytUNpFVcwODsF5S0y6iW4Rakm35WOsT1ZHTg8icOyshBeYmbf4ZWK5plmQSPAyFHqcQ7Nbrj0moVpaGtKfAP5LqoEZyU36+DcOQSMeXMzwNz9QgHFiPi68ePHz+enWXZ01p6bP9du90pY2yzpMgTCA9Kr78fvnaWiZnDF87zkyHI6s6OzgJx5zLCL0RFnArLE4F3ESaa38+Rc0IDXXSZDYQPpYHfnk6g1NHSNWDz5OzDFmgmP8+L2Ia3By3w9oYGGQiV9gcqInUXU1bYE5fZK9OCIuTOAu0ig0d/61E3pAaBGJagJJUKJ2cfwIQ0E/7nv/4b7plIKbelKQ1iIeIaQyvID42pdEWHOnNjfBKA17aks/tud2epJ33XbXd3V3enYZPmrefNrehVw5AZpAQo/JqKKdmY3VJpaXWf26DEKHoynOi713A4jXX67RFEBdrmDQozKRG/9VxAAReUM83Ki7TbVoEHUhzBf/dWC4XBhwlqXHQkF5B8J9WLqIbzPFz8Htm9ldjhA9XX4wrlrebderJ12RmGb3Dx58G8kJB59+QJz97ah4rxHWhGGSTihdKf1ze/C+AsQn0wuDnwmilLZxGbIaa2gwQVadqhshNvL4gJD0p/fooUmWVe7xKmP1c2I0/JXtKLtfahDKGmWEZMiLx+1aAEBZPTRYIyTCuMfp9yYZtpsj6LKxCcKu0uCpNm4zyLidlOoB4mPJzAhBkYIkrY4Fq7dgk+FFNI9ZBJbjDaqLL7WCMjpT5jOw+HVXtscaydA+Ci9vdq3SQdCf9CaHPuaMkLLTxTV3XjZkEhcaEfunglF2QwGaK+Y0Jw+lRxwt0rOMhfrUNlDcaiDawNMTAk6GDVGF3gQAQlWt3zCLWvHYSFD09PrAIe0wAETwwQq6pMuToj2bZu/GaJL1t58NzpvDh8JlnsdFY36zRrLopuwYHgzBQdHhuEzAaMOIqoBSdy5ho5rnFfpqWeJfinktggQZhzmGhIn4Jzh+/LYuoqA5ZH1d+DA2dPciB+CQdInnWMESc3nTjxbDRNjO2utsvdtWhckCv5oTvZXXEnv5XKs+epXH236mR8Z5zL4JyZa/r2B5fRMhZCPyxv4qpavOCo3W63dzvv9lzSMw2rZ+cq1Uw0r8nCwKGgHopR1ve27rkhRVo+O0tWeCYL4OfE7E+XhJRkBt0ano7uCnSsswOeju7r0iEwqZ1ySvsckQQmmhssDMGEJ7CZpeDXoyXL7sPSJRZYvNOjS++oJLNx5KbYB/JUhIOWlxJ51j47pJ4S14jylIMoMOm+nPC+639am3STT1+ReOdCcltxK4ES94IlCZn906PLLEuwKBqh9r2aN6Zzx5hSPppbpTkTcEqVYgObJ4PT1Qnsl5K8hQqAvLOPklalVX2agRsqNMyKEefXgz404VzFKEPBLPU2qxFcS269qSsjW6xntnzvsovOf2UyJQbTiWnASAmhHohD7zV+4bbhl6CklMZEsNB3H50MTmHzObZsQda0df1b61b+TJ1qLPyc9RzGCbN8yKlTrFFqFebKtT9zmfq+kcwj87vrel9TGWV9c7duo24Db8SpurS8/O3bMUv7elAtYB269/OdrvW+XNed7S3Ocb8Pm6WKUHlL+z6VuwU+e+26DeYrZoYS9xZ7RYf7xqXBNFJ+1kbemHm6n/1Z1OnSgLPK61KrSAPOK6/me036lfe5Xd0qd0e4cJL5rj2r9LQkrZFC4/Jh+IUb26IEOPFBKOo4MROViggm1EfnspwGM2YwAxvnylL7XBZvb4Bmzg+3EybBUoDk3PMJxjT6ngkewckHd16r7bTP92G4bXqiZfOZvCVV+Eii90t9swStOKU+PFrcs1E35/tk0Hd2nm+C+dEIezxq6OZysbxz5EejSjjU+brX7uy8a79ZVmN9dTT9wjXMdnfa7XZ3x2FWLz0dHr86TsuqUTVMd94Rpns5pnc8qiN78mF1AzdR2nqcii5svQ56N93rnX8uqlUefXh9Jj5VD11yXOYciMHpN+JYxekZy7sgXTM4PdnpOveNpVX37eC6ux5u3iOr2VDyPMD3z3XrB3kOqYpGnOstoHjvtTe3HkbX8etQv60/v3MdAT8av7MF+HXb7fb+27eL6r8/vz52czXmGnpdUn9ZPfVlDWRLqlyvTsySAtuiatdWOaPknddnSns17nR22+32m5395dyZKwq+gEXrVgS/nVMr1Acr9D9d/8kKNq+9+/M1oropd6Lc3llY7hncHKyH3aICz3wa4sido+7O7ssLNK/PsPJqq1Zq1sNsYalmEbd2SWu/e7OornL4/tU5s7AGUkNxz4lT9+1qpZHX93Wq69WRfuOOwP4TxQyyhy59+PpGsVrhmFfEhN0zprxWiPg/Qf5sIfLxAuRLdn5BgcEj3/0RyK/kLnUX8fgHo/mM17SsAODBrIPnshrAd8rxezlaD7kXpfjncT3orJrA/z4cXAPJuez80eUsCf+68veyfH3dZL0lOdjrLEywE+6zPPprY/+ylPu8xX98JM+o/nP2R/+nEXxp0ve+m0E3PHwNBJPjoBdMrE3c7/aHKIJe4C4Xgeur06ARGJVqMohujOltb7OEt5JSrni7+LJ9S8WJAmjoAVSBHp6elIGGqRbQPIbmZ7i9vZXNJn3feMFSG9W1agScI9NU21uZhL8tJSEH+52I+Jsj4o9G4K8iCXruVgJ3u4GdBL1gNpJWQ33v7+X4GqRaLKFm/r6XyxOXCHddavdMcxJPyo080uJ0+QSJumuYceM771rtVpvo5lQcdd4QJfbJfpwMgkZtfZWg9LxoKT3eziaZbRpbEkfC4qpoF29W6g10jFDH5mKUJexL4Cu8i1RoihUW/QB+VsKgbAeMNJbaeoW7DwcIE4oxxu4ulSIbltVI3J0rRzJybfyuRCPErCU8ZJI645m79ST/4TjNnRVtMJubXwhzK5/aqeKWFyqzOayyO1qOjwYOw8uL/qC4GKflv3phMa5VNrtzhX6YgE/djvPTT8UFK4a+H7FwkvcdEYQ4/7073XNDv6RPtKvd/zIYXLpaSmry6yn8T/WJW3RVzmWBmbvwAV3rLt2JQpXfthtm/O0wDdjNHjAYsiifR4933WMqXowoRnVU7+WzncwCaq20W2EeJ9pkYVS+cJRXuwr6hiqa5mygX91SBtSziB5WBKYoo2S3qri67Gy8vyHH3QvkKxwYM07nwKRJorT9Dx4hE83Z/oaqlVKTXnZ0+n7Y3PFZOG07AxqQ2qZ3MZOlY/iSa56+zm7k+deNT/+68emJG58y78XiF7udCMZde4ET0K+ZGZrdLOSu0ZmQier9Hnz9Snmmay0eH+nxX+4+MndpVG5h6NtjI5ggi1A7u/UZp4UwOlMkUlp87rqoik0kpRc8Pv4v4oxusw==","sidebar_class_name":"post api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Retrieve a Random Place","permalink":"/docs/api/random-place"}}');var n=i(31325),o=i(31736),r=i(47812),s=i.n(r),l=i(38616),d=i.n(l),c=i(67994),p=i.n(c),u=i(54768),h=i.n(u),m=(i(24909),i(96847),i(78121));const g={id:"bulk-postcode-lookup",title:"Bulk Postcode Lookup",description:"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.",sidebar_label:"Bulk Postcode Lookup",hide_title:!0,hide_table_of_contents:!0,api:"eJztPO1y2ziSr9LF+WH7SpIl2U5i3Y89x/F4POOvteTyZsdTDkS2JExAgAOAdnQpV91D3BPek1w1QFIkJcuWEufqqjZVSSQSaHQ3Gv0tfA0sG5ug93twqYwNVYTw9xT1NPijEagENbNcyZMo6AXvU/EZikGnSn1Ok6ARRGhCzRMaFvSCgzDExBpg8Gv/4hzU8E8MLYRKWsYll2NgEpjWbApqBEkGzLTgCm2qJc0T3Fh6GTMbTmhGMQqYjECjSTC0/B6B3TMu2FAgRMyy1q28le8RTKoRrAKTDmNuPRoa/0rRWAMGrSWYnw6VtChtczBN8BMN/8SSRPDQkbv9p1HykwOY05MmNKjTbpeQpvc//fST4wl8YJbRg8GEG4jRTlTkluUaV+UGrTRE9x2jBmBr7Jb69OkT4XUrv95KgNugGH8b9OD32+Dyagfa/ePboAG3wdnuHrw5Pvdfjv7ReQN7709vgz9u5aOD5HEHt6dXeI/aIByjClXE5dhxkt5YzaQRzKKBMSqhPHsMcGlVIQqmBfNcKg9v3cqgESRMsxgtahK2PxoBbaSSBk3Q+xp02236rypL/TQM0ZigEYR+t2hIfZvomQknGDP6ZLkVGPRmsnyVrRI0AjtN6JXfhIAQcLsTkewby2xq3EOTCkvCn2gSf8s9gtkAWsKD4dLiGHXQCEZKx8z6RzvdoBGgTOOg93u33f7jsYA4R92hihONE5SGZDlnlhNl4DIUKe0E8XGsWTLhIYRK6YhL2o0GsCjmkhtL5/MeYahSGTHN3SsZAQoMrdJMAJceP4I9UhrsBPPjgFEhc8+wpzRMpfknLrMPf6VMcDslypmh40WMlErbSfY5VKm0mgbIibmbsKAROPzv3Itp8TUigrhb3T94YDoKGoFQcsxt6hYTzOYfE6YFZzFKy/T0LlTS0CuUoUMlpf1j8q5gxZ3GMbGetpbHbgrTeGd1ajy9+VumuZnQUkYRqrH/L0RCJQzHREZqPV0RmnlZKbi1QCBnjCZS5XhOgV7/VmwK+J3rQbe5C+GEaRZa1KBSS3wBGtIABiZhIfptZ7DTnA3kshgHm6RFGtC/6RxA9+BgqwXXScRIBGIl7URMYaRVDFdqygScMS5axMMvLE4c+vm84HEmASXqLjKUDl9C4WCCMOLaWEiYdqqezUge4kiR/p6gpws2K8SbrRY4DTtGiZoJMQUeobR8xElvTrzWZAKsepCgNOQiNU8OkZKJcImSE7kaIQZDJaNFlLAR7UGJECYe2NTATpWaX1AkJidiCmTc+IiHYKxGtIZoGKZckDIw8MDpTGWrMAFMI6tS1vF7lB/JqgRyQpwJ+Lt/CycyIlWq9IzUmVqr0rpsNmx2mvtbLehP1IPfBK8tiSH0jRnDxxIjGGtORnGEGmWIPTIz/wadHtx4smhsTms+13kBGAGLIo3GQCiUQWPJzOS77bgdI3PQuj04ME7RdRqAX8gswXAK99ykThl650FJgn/KZCS4pEUSA5v9UFlBp0hJMd0iYDs9OEgSrb7wmFnnVGQbsNcmE6/R0Kjd3swrSiW3DhfYZPeo2Rgjf7Ay/NHvIRgWz5B3a+314MhYt1BEGF+c9yE1xAmTak3qveIL0ZQ3pYWNU3LZ0jHjUkzh8gLeqy9oHPx3PRigjp39mOl92BTMWPgs6bjQktUtcjP3e3CuytZn5ng5w14IX+exZAFKknc0swrPG0+ZCgc66Fmd4qIjd1HHErJFYfMfzRmaW84V8ftEXqMSKQEhV9N7NJkIvdfccjOBc5bJ9zEBJwk6fu+UKg060YuHnJOVQy3hRCPJTgtuuBDkvREdbsjhhEmJAk4MDfBO7IkRSBJ4xmTl+O7ttNu7bx/L1rPEx/OSSX0dRubLwubH/+ec7Lzd398jgcx9jxIfDwt35Hn9fv0bzBwLct3d1MyT4qZ0kI7kmNBqQK5HGnDDBDlkddIadUoapOVLlGxVdXoGmfR65j+ViOmTC4hjHsIvyISdwEFqJ0p7f6xO3/Mycf5LHyYeEMsBOTMzT3IVyVMlIyUJx4prV2f7eljVvF0PewFGcMamJDIYJ9l7Qt3rXJVm2zdtCrxHUQGqqtITzOgofNISJR9mfuo305LDJxEg68H0tMT5Z5h+g8bGXBqLeoaxc5pL2N54J3p1TAvPebuGs3ORnkGtb1vwK4vRbBhCbebClzA7Lfn1GXoyjYdVfRaplLB8DuGb4/67XSiWKdkr2CT70HwgtyHJ3JitQlScduGjcsAKqSwsXIWoZrvV6b59Qwq6CEPK5MxCk+9ETQawQozT0U2jUjv5RnL2Oq299s7eLqnJJbFUWZRm8gaX5RlwWI2+Vhe2699qEMs4PCdsh5xiL+fTOTXkTEPtcDwdEJZdlWwQHBUB9JUbBJtHR1dba1H2NMwXq9QFAWvZs/dv4ZBphAG9hc3Lw8F62HrlTwvVNdUTVgA+8JHzHyxIFpPzECp5T+EMZYooXTMFFmplDO2xZ7lZqsbmt+Uqj81Xp8cDYwIipCiknAipmG86oajFFI7VPWpJUggXoxEPMdstF4odX1yZrSd3yScOyjvjnmwfqjgm3b7eyQj5PRfggRduxhZhE+ZwYdO5Glsr2IsGpNLDpOhKI3NamlIdFQX9gBpO2RQ19NMENVykNkktHNCEVYnptrsdOERpUgOn/YuDLDNhYiYEahc0cmN5mAW2DbDThL6JKXQa7Xa72WnstdvkgbpwmaLnc/UAieLSOifULeBywU9RDe3Ou0OiNK5ResajSOCrkHo2IzXmUdPw/8SltO45Wt/Sv99MK5FKias5N6ykjL7Jm8lcsVm+MeL33ORnjISVpLaU6J/z6mdp79xLY/WwRFEuCxQ50U/pEAL36NNzZVoFl47HdAK5IbxIQR1r5UoXq5FLrvEygJBltDlVJBxlgkn3uqRTDep7HiKl0CE7ytUNpFVcwODsF5S0y6iW4Rakm35WOsT1ZHTg8icOyshBeYmbf4ZWK5plmQSPAyFHqcQ7Nbrj0moVpaGtKfAP5LqoEZyU36+DcOQSMeXMzwNz9QgHFiPi68ePHz+enWXZ01p6bP9du90pY2yzpMgTCA9Kr78fvnaWiZnDF87zkyHI6s6OzgJx5zLCL0RFnArLE4F3ESaa38+Rc0IDXXSZDYQPpYHfnk6g1NHSNWDz5OzDFmgmP8+L2Ia3By3w9oYGGQiV9gcqInUXU1bYE5fZK9OCIuTOAu0ig0d/61E3pAaBGJagJJUKJ2cfwIQ0E/7nv/4b7plIKbelKQ1iIeIaQyvID42pdEWHOnNjfBKA17aks/tud2epJ33XbXd3V3enYZPmrefNrehVw5AZpAQo/JqKKdmY3VJpaXWf26DEKHoynOi713A4jXX67RFEBdrmDQozKRG/9VxAAReUM83Ki7TbVoEHUhzBf/dWC4XBhwlqXHQkF5B8J9WLqIbzPFz8Htm9ldjhA9XX4wrlrebderJ12RmGb3Dx58G8kJB59+QJz97ah4rxHWhGGSTihdKf1ze/C+AsQn0wuDnwmilLZxGbIaa2gwQVadqhshNvL4gJD0p/fooUmWVe7xKmP1c2I0/JXtKLtfahDKGmWEZMiLx+1aAEBZPTRYIyTCuMfp9yYZtpsj6LKxCcKu0uCpNm4zyLidlOoB4mPJzAhBkYIkrY4Fq7dgk+FFNI9ZBJbjDaqLL7WCMjpT5jOw+HVXtscaydA+Ci9vdq3SQdCf9CaHPuaMkLLTxTV3XjZkEhcaEfunglF2QwGaK+Y0Jw+lRxwt0rOMhfrUNlDcaiDawNMTAk6GDVGF3gQAQlWt3zCLWvHYSFD09PrAIe0wAETwwQq6pMuToj2bZu/GaJL1t58NzpvDh8JlnsdFY36zRrLopuwYHgzBQdHhuEzAaMOIqoBSdy5ho5rnFfpqWeJfinktggQZhzmGhIn4Jzh+/LYuoqA5ZH1d+DA2dPciB+CQdInnWMESc3nTjxbDRNjO2utsvdtWhckCv5oTvZXXEnv5XKs+epXH236mR8Z5zL4JyZa/r2B5fRMhZCPyxv4qpavOCo3W63dzvv9lzSMw2rZ+cq1Uw0r8nCwKGgHopR1ve27rkhRVo+O0tWeCYL4OfE7E+XhJRkBt0ano7uCnSsswOeju7r0iEwqZ1ySvsckQQmmhssDMGEJ7CZpeDXoyXL7sPSJRZYvNOjS++oJLNx5KbYB/JUhIOWlxJ51j47pJ4S14jylIMoMOm+nPC+639am3STT1+ReOdCcltxK4ES94IlCZn906PLLEuwKBqh9r2aN6Zzx5hSPppbpTkTcEqVYgObJ4PT1Qnsl5K8hQqAvLOPklalVX2agRsqNMyKEefXgz404VzFKEPBLPU2qxFcS269qSsjW6xntnzvsovOf2UyJQbTiWnASAmhHohD7zV+4bbhl6CklMZEsNB3H50MTmHzObZsQda0df1b61b+TJ1qLPyc9RzGCbN8yKlTrFFqFebKtT9zmfq+kcwj87vrel9TGWV9c7duo24Db8SpurS8/O3bMUv7elAtYB269/OdrvW+XNed7S3Ocb8Pm6WKUHlL+z6VuwU+e+26DeYrZoYS9xZ7RYf7xqXBNFJ+1kbemHm6n/1Z1OnSgLPK61KrSAPOK6/me036lfe5Xd0qd0e4cJL5rj2r9LQkrZFC4/Jh+IUb26IEOPFBKOo4MROViggm1EfnspwGM2YwAxvnylL7XBZvb4Bmzg+3EybBUoDk3PMJxjT6ngkewckHd16r7bTP92G4bXqiZfOZvCVV+Eii90t9swStOKU+PFrcs1E35/tk0Hd2nm+C+dEIezxq6OZysbxz5EejSjjU+brX7uy8a79ZVmN9dTT9wjXMdnfa7XZ3x2FWLz0dHr86TsuqUTVMd94Rpns5pnc8qiN78mF1AzdR2nqcii5svQ56N93rnX8uqlUefXh9Jj5VD11yXOYciMHpN+JYxekZy7sgXTM4PdnpOveNpVX37eC6ux5u3iOr2VDyPMD3z3XrB3kOqYpGnOstoHjvtTe3HkbX8etQv60/v3MdAT8av7MF+HXb7fb+27eL6r8/vz52czXmGnpdUn9ZPfVlDWRLqlyvTsySAtuiatdWOaPknddnSns17nR22+32m5395dyZKwq+gEXrVgS/nVMr1Acr9D9d/8kKNq+9+/M1oropd6Lc3llY7hncHKyH3aICz3wa4sido+7O7ssLNK/PsPJqq1Zq1sNsYalmEbd2SWu/e7OornL4/tU5s7AGUkNxz4lT9+1qpZHX93Wq69WRfuOOwP4TxQyyhy59+PpGsVrhmFfEhN0zprxWiPg/Qf5sIfLxAuRLdn5BgcEj3/0RyK/kLnUX8fgHo/mM17SsAODBrIPnshrAd8rxezlaD7kXpfjncT3orJrA/z4cXAPJuez80eUsCf+68veyfH3dZL0lOdjrLEywE+6zPPprY/+ylPu8xX98JM+o/nP2R/+nEXxp0ve+m0E3PHwNBJPjoBdMrE3c7/aHKIJe4C4Xgeur06ARGJVqMohujOltb7OEt5JSrni7+LJ9S8WJAmjoAVSBHp6elIGGqRbQPIbmZ7i9vZXNJn3feMFSG9W1agScI9NU21uZhL8tJSEH+52I+Jsj4o9G4K8iCXruVgJ3u4GdBL1gNpJWQ33v7+X4GqRaLKFm/r6XyxOXCHddavdMcxJPyo080uJ0+QSJumuYceM771rtVpvo5lQcdd4QJfbJfpwMgkZtfZWg9LxoKT3eziaZbRpbEkfC4qpoF29W6g10jFDH5mKUJexL4Cu8i1RoihUW/QB+VsKgbAeMNJbaeoW7DwcIE4oxxu4ulSIbltVI3J0rRzJybfyuRCPErCU8ZJI645m79ST/4TjNnRVtMJubXwhzK5/aqeKWFyqzOayyO1qOjwYOw8uL/qC4GKflv3phMa5VNrtzhX6YgE/djvPTT8UFK4a+H7FwkvcdEYQ4/7073XNDv6RPtKvd/zIYXLpaSmry6yn8T/WJW3RVzmWBmbvwAV3rLt2JQpXfthtm/O0wDdjNHjAYsiifR4933WMqXowoRnVU7+WzncwCaq20W2EeJ9pkYVS+cJRXuwr6hiqa5mygX91SBtSziB5WBKYoo2S3qri67Gy8vyHH3QvkKxwYM07nwKRJorT9Dx4hE83Z/oaqlVKTXnZ0+n7Y3PFZOG07AxqQ2qZ3MZOlY/iSa56+zm7k+deNT/+68emJG58y78XiF7udCMZde4ET0K+ZGZrdLOSu0ZmQier9Hnz9Snmmay0eH+nxX+4+MndpVG5h6NtjI5ggi1A7u/UZp4UwOlMkUlp87rqoik0kpRc8Pv4v4oxusw==",sidebar_class_name:"post api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},y=void 0,f={},S=[{value:"Post Data",id:"post-data",level:3},{value:"Bulk Reverse Geocoding",id:"bulk-reverse-geocoding",level:2}];function b(e){const t={code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Bulk Postcode Lookup"}),"\n",(0,n.jsx)(s(),{method:"post",path:"/postcodes",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data."}),"\n",(0,n.jsxs)(t.p,{children:["Be sure to submit JSON requests setting ",(0,n.jsx)(t.code,{children:"Content-Type"})," to ",(0,n.jsx)(t.code,{children:"application/json"}),"."]}),"\n",(0,n.jsx)(t.p,{children:"Accepts up to 100 postcodes."}),"\n",(0,n.jsx)(t.h3,{id:"post-data",children:"Post Data"}),"\n",(0,n.jsx)(t.p,{children:"This method requires a JSON object containing an array of postcodes to be posted, e.g."}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-json",children:'{\n "postcodes": ["PR3 0SG", "M45 6GN", "EX16 5BL"]\n}\n'})}),"\n",(0,n.jsx)(t.h2,{id:"bulk-reverse-geocoding",children:"Bulk Reverse Geocoding"}),"\n",(0,n.jsx)(t.p,{children:"Bulk translates geolocations into Postcodes. Accepts up to 100 geolocations."}),"\n",(0,n.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[]}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive location data including geographic coordinates, administrative boundaries, and electoral information for the requested postcode",type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. May be empty for areas without county-level administration.",example:""},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}}}}}}}})]})}function E(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/4c84271f.2abffb28.js b/build/assets/js/4c84271f.2abffb28.js
deleted file mode 100644
index f1a223823..000000000
--- a/build/assets/js/4c84271f.2abffb28.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[1516],{26652(e,t,i){i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>C,frontMatter:()=>y,metadata:()=>o,toc:()=>S});const o=JSON.parse('{"id":"api/get-scottish-postcode","title":"Lookup Scottish Postcode","description":"Lookup a Scottish postcode.","source":"@site/docs/api/get-scottish-postcode.api.mdx","sourceDirName":"api","slug":"/api/get-scottish-postcode","permalink":"/docs/api/get-scottish-postcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-scottish-postcode","title":"Lookup Scottish Postcode","description":"Lookup a Scottish postcode.","sidebar_label":"Lookup Scottish Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJztXP1u4ziSf5WC9oBJFrIj2/n0YbCXSXq7s5N0gjjZudlOn5uWaJsbmdSQVLqzgYF7h33DfZJDkfqW/BE7fQccpv/pmKLIX5FVRbLqJ744mkyU0//kDHyhNVNTuBFK+yKgyvnsOgFVvmSRZoI7fedSiMc4AgJZ5Sip3H7gD/yW6lhyBbWm4JxJ6mshn2FncHO+CwHRBIhSwmdE0wC+Mj0FPaV5e3A3pSCpigRXFHzxRKUyNcZxGMLg5hzGjIYBKKr74IuY+ywEIilxgYamLxLCVyIDN4dDeAD3P0NEZMjIjHJN5DNMqJhIEk0ZVS5MKQn1FEbCvMi4phNJUHggsZ4KyfSza8H/Q3Bqa8gZDVCKpEjEOop1AiUUPgnNS4pqHVLs1AWfPbEQYTA1dYGpkPDABW46IubBowtakicatrRofRXyMWnv4u5y7/L03oVYjghvyRil9EOiFBsz3zTgwuDi6hwk4Y8u3F6fuuBTrmJlBkkr14wCDqQvpB3fgPEJvB8MYA/EeMx8hm2iAkDMAypN5S+m4AuI0d+pr81s34moFdInGtqZUDAVoW05JJoqDTs+4YIzn4S78ETCmMJYSKDEn5ohjATjug2/UiJbKh6P2TcapE2pWI6JTyGSTEjAuWeCK/g6pZKaLlABongUMjWlRi9mJQ38su/tfwE2LukUBIIq4EID/caUBsZNM0ICs8VPJGSBaefPQmav2WdJ5VGsIZJUUW6Krj9i4Q5r0zZwwVs1u1C7LpAUjgJp8BUVnkopJMyoUmRC4cHJTMZgVHkn2HMOpP3gIM6BiKVP+8st7mOqWLfUFzJQIMbmBVS73fYDd1xHRNTq+UXg9J0J1WmDaXuO60REkhnVVKK7eHE4mVGn70R5BYYuIiJ66lT9xiCiPhszO1P5fDyLGL4iai3gt5jKZ8d1JP0tZpIGTl/LmLqO0s8h9qPYLAqxF/otCrG//piECiv4UzojTv/F0c+Rqakl4xNnPv+MrVkHovB51/Pwvwq02PepUo7r+IJryjVWIVEUJua093eF9V6K/TBtINUH/TbpznFTMNZeSnJ9cpQmOlamUMWhRj8bSZwCzSzSpEIuk/FEVDquMxZyRrQt6nVxPHg8c/qfup73eZ61WBdzPZeMBqqN4/0tpgo9c+aQV8hU0INQ8AnTsf2b6PTPxEkP0ZMh7tRLD9FLO65jfe/Q+N60EoIaol816pX72rTMOtu0tkqEHJY8/NAXXCEKyv3nxbUkneBQIc5k7SvPSSZgQQMK1lFWvqoB4GJ2K55JCFcEXX86CTu0PWm7cPpTx4POf77fbRsFJ0bV+05abIxPayqxqf/6dNr62+eXjtudf/JaJ5/xJ/7/J/hT9vvzS3f+b87cdSJ/6ItZRHxdhH1mi2Bt+JnSGLdFwhBURHyK/mwmnmhQh42o52Z+qmN2HWuccDhbp+M/M6k0LoganVbJeeyM6Fgkq4FB0zB4CIHxKoILvj6AAfUFDxYgIGOdLI9NAJIhSKsPA4Z9lGeiYI3Jw1WA3v0WsycS4vqjhelbJAOaWml9CDIIyphcI4CBfbSq++tCZxCFcbInM9PkT4kkPg5JMlKMLwEGHYQWKyqHtssc1L2iEu6wsA6Hx2FIRljNrg+V6bo5B2yyha8B4wF6cSFh58HxHhz4EdQMtReruPDgdExZSOSEmrLKDJrBC9DdiPGQcS1FEPu2pxzsOW79xBguis9fi9s0UlKurwTXftskDWDn119//fXqqqpiJ8ee1ymiDGhIFyE8T5+9DTrTVREafMStOS4hIXvKK6sSZuxp7joh4480GJrpGBolaPKvl6YWDMykGa1Y4rKWy4A7OjPRLewtB+faHavtyMApV4AdNgbCn3cbpchWuiLowvKXYOTxbFRevQMRj8x2ZjnqX94Pjvch66aEodVtd7zuwbywyBZR5AvvG4FIGixhODhqd/ZP9hEEJUozPlFFEO/SMneNjcxyENcDyPax7yULIOkPdjozPCeKMMan5WnqnfSOD07mrsOF1NMquo9Z4XeAl/a4FN+xd+gd9eauo6KQ6WHmr0q7THwEF9mjTVyiaT53h224IvJRFU44eko0LmIcZnZNJRwEp0CCGeO4NBGNJh1zphtc5ESyYIgm1CyBGQ805S2k+CC+1j1QYrVaANMKEAVIOqaScp/CTgd+hBnR/hRGz0CCQFKlXOgWS5+YikkIjKuI+vbw3IMfgUSRFN/YDN2eqesC1X676nzLokdCMasAQ+L7sST+c/Mg3GQV4TSt+NrhKLSRdpYuuuVhaIBc2oeXdoU2iHJqN9OvA9T1OielMAzg+dBGcfxYStyvKMYnIW1pRqUNjORBlcr2YERlQCmHM6afEXLlrFD0MFms5xd7ingt7G63Ei+ywEt4rligtPAfqd67FYrOMJDimMPWJLENwRu3d7eFCsu2eKtAekdQ7AvSvuzWCk/4M6pw2E2EIJLiiQU0SEMFuyVhbs+7xmgpHqciyRRNjz7FYc0ewm16Lno16GPI+wDbR8PgfmCTKUYilAlMXZhgmEKARlo6Yf4wwCiTiPCkNoxCwjnjk5r6DtLqcJ5Xh5uk+sZa3YPB+c1pMtDLx7kk1uDcbsyMog8nGL/kRoAmPbk01vA+q7S5rnROTg4S48r7zPUFhx920E3MhNIgqY+PRyLmAcZCkyMVunn8WbRnVT1eVW10oaDDzslJZy1pYQer7m4idGel0FOmtJAmGlmWBAVA55lKZI4lj8tiCMWjys9wUwonnxUqwk7X6+6/Xh58C2otFyE02FE2IQMR66kxoKWBjsZAVqlDa/lGiA0mBd+CBS0vdAZmSwa4bcwilEskWTQpC3qtTc0bS7XuBJ1RriUJUbB6zKsgxgebjPgJHxr/haA7J5uA7pzAxw+DUnqjuEqfJSt0FgYmYeYUykK8l2QWMcIbwQ+7nne4UgLvcBMJvMMF6JdY9nKw6CpXgMUqG7mjg+3AFhJPw2yPVA5h5Zmp07TCVuqR4MU12GTlQvBxnWtMgS1V7mQ5KEZmy9E/zI6lutDtbmSC3TSnVWwuTxuaYzxmoJJaaYqvossDz+v0Dg96RxW8w67X6SwB3dnIb3Q6C0FXUXnHxydHXh2VtwyVtxEq7xWoPO/Iq6GqLu4lVFss5+ugSqIweZKgHPQi8Dc8w26jZnkr1lFmnp/mYVgxhsvB9Wl5vH5B9XvHA7ArWguyMJ2FWtOxEt6NNSxvpWkKO553eHBUA+ItBrKxUq0E4nW6B6mrK2d1Km4uS69vPZn11pZO6tWKSW1EX5vXRhE2nt96a03D27XGugigtxrgxvP+CoCdo+zYUFndLpOyrWZ7kBEuWoQHrazNtMMli1gR17Drdb2F4LyNwHllEEs2BQsQefXzVIJo44nbClHjCc8g2vZAtxpRsgjk/JrSSSAr3UqX8saXaI0LVywMNcMou2XZ3CBbwo9DTaVTglhTqgrOTdWqgnONaSyYSQ1iWcvKEDfWs60hGvLU0JKnSuFLQ6q6MeWod70NBhHfypeDIk2rEDlJ2E05bhgRRUPG6b+XXqEKviJdiYyEoSkFQFRTQN1wfDonRwcV+a/DAK4IJlWNIzeBsZLjtiWvldG+ZuXJ+VRZXJ0pY3iaBm14cK4I46Z6gTL04JgcH9KdLKgFmb7Gl1GUlOiGk/hYSsikZ88bIh/NOrmRIXS8MpcumbszwiSfCDlTsAeXwp/CpZhhcj8lxN1JoRTxp6qYykQxTSNL05mWrDfUYohkvdqp5848xkTFL8jl2/og0dTeiuWMxEND1hs2hOJOy0p5z5mGS8Ps6xh3tMEZGN+Cy9N7CJN27FbrlkahIY4YnZP0iYlYwcf7u0GFxahWHC+ZDhN5urXNTDb5d1RKhkZKwkSe7lbyXNxdJvJ0E3muWGDzGfc/A5K2mNLGI2QnTtiRqchGyu7uooAXlbxkJbmEvddI2HsjCXuFBI6JFU8k4XFIpKmzUL7esjCxsbS0RE2ZpCbWilTWoaGyDg+HYxGWvNy9IbreGqLrWUlFYOewhbVd2GaXmDr7QjjaNruEYmv2tH3kX/4ROn24NPwRA9SYosLybh+u9RQ1o1ze62PWjyrFRiFNmA134is3D/f7cEtnQtceHJTeMqOBxYdZ/aSonu0rju7xq0b3+PuM7vFaows7nX/99z+Pd9tg8t8KHhwr6YMDuDpNhEQ6KeNaFB+hgj04f6Umem3LGjKgWTiZ8YB+Q9rMLA41i0I6DGgk2ROpUmgyQS7wDXM6TN6A8/yN2t5tYzqBoXCbLR3yuDNaZroG/aAKB2yb6EYTteBp4MLhydEhMpuQJJEVl03zcL+zjzlMQZAiOMOdyHOeXUPCG6dSTVlUYQ7amnli7SavCTu316ewRYR3RfN2HbdpCRJibMgXMwqnE0ntjjJzS6uSVSi1OV80LIZ5OHVLaZYAraS/1wmo2oDYcCpiRZFpPzR8/tLk2JDZh7QGYEa/fvDZWCk/GgIRKn8GAhmgyCnHze2EMK406CnLmSVAtFHcQswWySeYaQTPfg4wizD9JuEfVIqWiiNk1yu6aFPpLRyJWuRl8XCU9l3fazhSwbO4b5n5s0wOb005vP9NObxGOTrdxYJUowKLBKnECL6vIIXgctNGPhElElEc2vzLIjO7yaq8tZ3dUsUC9BI5ig3MbIHVVCVbZDZN4r2N3SwXb7nZdI6XStJoOE2SvI3lrCdJs+F0D5dIssBy6pK8lemsI8kKy+H0icphwCZMM0VLu8yP+AjOs0cZ3pEQISW8/rmEjGnt660pUWA6gRGui1lPsMNFlfxHlSb247DKrsd8NDRPP/Io7WywoP6NSxlY41dy6e6s/EGd2awkn7ORkXgy63v5k5J1mHjmM4VNM7snrZyTj9DNOKZwa5S9SpS+Y6L0vd5rCHgZ2k2ODCvQ1ph6Vbw9z+se73deT27LUHvHr0d9VkbZxHqrAD1J/m1PD0uAb0ZTKAFfzhtbohlvQfvKpNggHlaVYgkRbMk0vBHfK9P+DUhfq7R/BSOsOkX7OEWH5ePudjywTLgNZmmVcCuYYlXhjkz+8PA7UcP+TwRdNpeHKO7JfvkzwIH52u/l2H7o90oi2fddVBqpZtUc8DEKZanImxDJMpe9wem8AXUTvawRsXe4KZvsbX31CrTeFjSy76scjYyyylD3jIF7XWc1u2ebDUfzJiNru85a6fQODjxnTR5PNowbuJGmoessQ/YqYk9mO9uut2Wqz9uxfN5+Umt9NFBSugfdhZyZVaSet5/sdRBvw/J5WyVYD+0alJ9tpv6sNu1pV9UV9cSMXcdZhzjytojy7iqY7HRaTGtxHNL1ZBOiQ2U96Xkl5kJ17o5yZItoCIu+pl+Li2BCD3g/iGxiixUHZk3qQGaN2w5NnUzwRtn/bfxFFWEjH6A6iGYU94+WcQFO77Osf6bz2+5VajyA+lbl7vLKLqqLcvp3l1n2/m1xFfP5zbiWJeIzWL3vBqu3bLg2+/ow9/tH2/v9BZ8llgGnHxy+9ns+/OwuM5Pe9mbSgwwBFBBAiqBpz598xPemSVIr0+a5xeokHEIGLZelAG1J8KYxDYrIbKxmmzNWHSW2u/Sz3wK0+RzdauXMnl9MN5/bGvvefv2qo+xKE/xGc4xfMTlY91sLCwemM3uDVUj4xOk7U60jc1PRiIYY4bm9xEuCzMVayVPV39sjEWvnKUkm9lTC1dnLSvcu/to9+stPD0i4ylr3bXtp62eXF8XW/ViG0HoPrUd4eHjgrRb+/uH1ff6AnX52nRnVU5Fc4WXDBVOn7zS995L+OUc8VD6l93rFMlwidi0ifnpzAQPzuuM6T0QyVAmMbpv7txgfC5yh5AY3JGAct722hyPCMJdgDgLJVWJXF3eOW+lfRJTb0WoLOdlLXlJ7WLegIojiNov+t/I7DC1k3Juq6zHiZKVZLY1uIHyV9bDwDiSsiixJAmNJC+mJ0N6NiEhwTzOhAotlZgP3P5ub5f7wB/yCwNx9hz9P8S4lC0uBTzgmxolh+uBleFLM7P06IgzFV7Rrmrxr2vry5csDXzRTyeMHjgwug8r3aaQVvH93Z9nJ14O79KIv1bY/rf4ovAwHkvvQwFyl86V6JdqXVJr0zjOFv9/h5X6FWxvxc2l7ZxS3typE0pwQPtzd3cDA3HKW0H3oN0RnRusvg+uPNxmyXcNBU/gpmh/GgXEmppqyN7e5sJ8UEBiRIH0Pi/cTBmfiBozUB+nbRmft9XuW5VbDhJMcKpF2bL7z1sVbKUcieE6HAcMnuIu1Q4SFJYXJrh5M7kwzPjCvb2/hwxFPruqiM8LQDpAQIaT+DxZQErby+fVFO35EJ2xNZ2Cr1cyn8bW9pFHjFvHZjPCCGSaXfNZujKtaxEt+Y97vF4P+fjHo7xeD/n+8GDTZ9Gn6Te9FIWH2dgRpNox2d/HJSXcXTn7THC6f/exGr8+uMxVKY92XF/xY4l6G8zkW21s/+58+53sHswkJmMK/g+yWz4WeZ+c2uYRyF15xy2ijWEkh4c9mKxPG+MtxnUf6XLzodP7ZJgACKg1W+/jUrK6FF2t3iJb2Z+/f3Tnz+f8APXFeHQ==","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Scottish Postcodes","permalink":"/docs/api/scottish-postcodes"},"next":{"title":"Outward Codes","permalink":"/docs/api/outward-codes"}}');var n=i(31325),a=i(31736),l=i(47812),r=i.n(l),s=i(38616),c=i.n(s),d=i(67994),p=i.n(d),u=i(54768),m=i.n(u),h=(i(24909),i(96847),i(78121));const y={id:"get-scottish-postcode",title:"Lookup Scottish Postcode",description:"Lookup a Scottish postcode.",sidebar_label:"Lookup Scottish Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJztXP1u4ziSf5WC9oBJFrIj2/n0YbCXSXq7s5N0gjjZudlOn5uWaJsbmdSQVLqzgYF7h33DfZJDkfqW/BE7fQccpv/pmKLIX5FVRbLqJ744mkyU0//kDHyhNVNTuBFK+yKgyvnsOgFVvmSRZoI7fedSiMc4AgJZ5Sip3H7gD/yW6lhyBbWm4JxJ6mshn2FncHO+CwHRBIhSwmdE0wC+Mj0FPaV5e3A3pSCpigRXFHzxRKUyNcZxGMLg5hzGjIYBKKr74IuY+ywEIilxgYamLxLCVyIDN4dDeAD3P0NEZMjIjHJN5DNMqJhIEk0ZVS5MKQn1FEbCvMi4phNJUHggsZ4KyfSza8H/Q3Bqa8gZDVCKpEjEOop1AiUUPgnNS4pqHVLs1AWfPbEQYTA1dYGpkPDABW46IubBowtakicatrRofRXyMWnv4u5y7/L03oVYjghvyRil9EOiFBsz3zTgwuDi6hwk4Y8u3F6fuuBTrmJlBkkr14wCDqQvpB3fgPEJvB8MYA/EeMx8hm2iAkDMAypN5S+m4AuI0d+pr81s34moFdInGtqZUDAVoW05JJoqDTs+4YIzn4S78ETCmMJYSKDEn5ohjATjug2/UiJbKh6P2TcapE2pWI6JTyGSTEjAuWeCK/g6pZKaLlABongUMjWlRi9mJQ38su/tfwE2LukUBIIq4EID/caUBsZNM0ICs8VPJGSBaefPQmav2WdJ5VGsIZJUUW6Krj9i4Q5r0zZwwVs1u1C7LpAUjgJp8BUVnkopJMyoUmRC4cHJTMZgVHkn2HMOpP3gIM6BiKVP+8st7mOqWLfUFzJQIMbmBVS73fYDd1xHRNTq+UXg9J0J1WmDaXuO60REkhnVVKK7eHE4mVGn70R5BYYuIiJ66lT9xiCiPhszO1P5fDyLGL4iai3gt5jKZ8d1JP0tZpIGTl/LmLqO0s8h9qPYLAqxF/otCrG//piECiv4UzojTv/F0c+Rqakl4xNnPv+MrVkHovB51/Pwvwq02PepUo7r+IJryjVWIVEUJua093eF9V6K/TBtINUH/TbpznFTMNZeSnJ9cpQmOlamUMWhRj8bSZwCzSzSpEIuk/FEVDquMxZyRrQt6nVxPHg8c/qfup73eZ61WBdzPZeMBqqN4/0tpgo9c+aQV8hU0INQ8AnTsf2b6PTPxEkP0ZMh7tRLD9FLO65jfe/Q+N60EoIaol816pX72rTMOtu0tkqEHJY8/NAXXCEKyv3nxbUkneBQIc5k7SvPSSZgQQMK1lFWvqoB4GJ2K55JCFcEXX86CTu0PWm7cPpTx4POf77fbRsFJ0bV+05abIxPayqxqf/6dNr62+eXjtudf/JaJ5/xJ/7/J/hT9vvzS3f+b87cdSJ/6ItZRHxdhH1mi2Bt+JnSGLdFwhBURHyK/mwmnmhQh42o52Z+qmN2HWuccDhbp+M/M6k0LoganVbJeeyM6Fgkq4FB0zB4CIHxKoILvj6AAfUFDxYgIGOdLI9NAJIhSKsPA4Z9lGeiYI3Jw1WA3v0WsycS4vqjhelbJAOaWml9CDIIyphcI4CBfbSq++tCZxCFcbInM9PkT4kkPg5JMlKMLwEGHYQWKyqHtssc1L2iEu6wsA6Hx2FIRljNrg+V6bo5B2yyha8B4wF6cSFh58HxHhz4EdQMtReruPDgdExZSOSEmrLKDJrBC9DdiPGQcS1FEPu2pxzsOW79xBguis9fi9s0UlKurwTXftskDWDn119//fXqqqpiJ8ee1ymiDGhIFyE8T5+9DTrTVREafMStOS4hIXvKK6sSZuxp7joh4480GJrpGBolaPKvl6YWDMykGa1Y4rKWy4A7OjPRLewtB+faHavtyMApV4AdNgbCn3cbpchWuiLowvKXYOTxbFRevQMRj8x2ZjnqX94Pjvch66aEodVtd7zuwbywyBZR5AvvG4FIGixhODhqd/ZP9hEEJUozPlFFEO/SMneNjcxyENcDyPax7yULIOkPdjozPCeKMMan5WnqnfSOD07mrsOF1NMquo9Z4XeAl/a4FN+xd+gd9eauo6KQ6WHmr0q7THwEF9mjTVyiaT53h224IvJRFU44eko0LmIcZnZNJRwEp0CCGeO4NBGNJh1zphtc5ESyYIgm1CyBGQ805S2k+CC+1j1QYrVaANMKEAVIOqaScp/CTgd+hBnR/hRGz0CCQFKlXOgWS5+YikkIjKuI+vbw3IMfgUSRFN/YDN2eqesC1X676nzLokdCMasAQ+L7sST+c/Mg3GQV4TSt+NrhKLSRdpYuuuVhaIBc2oeXdoU2iHJqN9OvA9T1OielMAzg+dBGcfxYStyvKMYnIW1pRqUNjORBlcr2YERlQCmHM6afEXLlrFD0MFms5xd7ingt7G63Ei+ywEt4rligtPAfqd67FYrOMJDimMPWJLENwRu3d7eFCsu2eKtAekdQ7AvSvuzWCk/4M6pw2E2EIJLiiQU0SEMFuyVhbs+7xmgpHqciyRRNjz7FYc0ewm16Lno16GPI+wDbR8PgfmCTKUYilAlMXZhgmEKARlo6Yf4wwCiTiPCkNoxCwjnjk5r6DtLqcJ5Xh5uk+sZa3YPB+c1pMtDLx7kk1uDcbsyMog8nGL/kRoAmPbk01vA+q7S5rnROTg4S48r7zPUFhx920E3MhNIgqY+PRyLmAcZCkyMVunn8WbRnVT1eVW10oaDDzslJZy1pYQer7m4idGel0FOmtJAmGlmWBAVA55lKZI4lj8tiCMWjys9wUwonnxUqwk7X6+6/Xh58C2otFyE02FE2IQMR66kxoKWBjsZAVqlDa/lGiA0mBd+CBS0vdAZmSwa4bcwilEskWTQpC3qtTc0bS7XuBJ1RriUJUbB6zKsgxgebjPgJHxr/haA7J5uA7pzAxw+DUnqjuEqfJSt0FgYmYeYUykK8l2QWMcIbwQ+7nne4UgLvcBMJvMMF6JdY9nKw6CpXgMUqG7mjg+3AFhJPw2yPVA5h5Zmp07TCVuqR4MU12GTlQvBxnWtMgS1V7mQ5KEZmy9E/zI6lutDtbmSC3TSnVWwuTxuaYzxmoJJaaYqvossDz+v0Dg96RxW8w67X6SwB3dnIb3Q6C0FXUXnHxydHXh2VtwyVtxEq7xWoPO/Iq6GqLu4lVFss5+ugSqIweZKgHPQi8Dc8w26jZnkr1lFmnp/mYVgxhsvB9Wl5vH5B9XvHA7ArWguyMJ2FWtOxEt6NNSxvpWkKO553eHBUA+ItBrKxUq0E4nW6B6mrK2d1Km4uS69vPZn11pZO6tWKSW1EX5vXRhE2nt96a03D27XGugigtxrgxvP+CoCdo+zYUFndLpOyrWZ7kBEuWoQHrazNtMMli1gR17Drdb2F4LyNwHllEEs2BQsQefXzVIJo44nbClHjCc8g2vZAtxpRsgjk/JrSSSAr3UqX8saXaI0LVywMNcMou2XZ3CBbwo9DTaVTglhTqgrOTdWqgnONaSyYSQ1iWcvKEDfWs60hGvLU0JKnSuFLQ6q6MeWod70NBhHfypeDIk2rEDlJ2E05bhgRRUPG6b+XXqEKviJdiYyEoSkFQFRTQN1wfDonRwcV+a/DAK4IJlWNIzeBsZLjtiWvldG+ZuXJ+VRZXJ0pY3iaBm14cK4I46Z6gTL04JgcH9KdLKgFmb7Gl1GUlOiGk/hYSsikZ88bIh/NOrmRIXS8MpcumbszwiSfCDlTsAeXwp/CpZhhcj8lxN1JoRTxp6qYykQxTSNL05mWrDfUYohkvdqp5848xkTFL8jl2/og0dTeiuWMxEND1hs2hOJOy0p5z5mGS8Ps6xh3tMEZGN+Cy9N7CJN27FbrlkahIY4YnZP0iYlYwcf7u0GFxahWHC+ZDhN5urXNTDb5d1RKhkZKwkSe7lbyXNxdJvJ0E3muWGDzGfc/A5K2mNLGI2QnTtiRqchGyu7uooAXlbxkJbmEvddI2HsjCXuFBI6JFU8k4XFIpKmzUL7esjCxsbS0RE2ZpCbWilTWoaGyDg+HYxGWvNy9IbreGqLrWUlFYOewhbVd2GaXmDr7QjjaNruEYmv2tH3kX/4ROn24NPwRA9SYosLybh+u9RQ1o1ze62PWjyrFRiFNmA134is3D/f7cEtnQtceHJTeMqOBxYdZ/aSonu0rju7xq0b3+PuM7vFaows7nX/99z+Pd9tg8t8KHhwr6YMDuDpNhEQ6KeNaFB+hgj04f6Umem3LGjKgWTiZ8YB+Q9rMLA41i0I6DGgk2ROpUmgyQS7wDXM6TN6A8/yN2t5tYzqBoXCbLR3yuDNaZroG/aAKB2yb6EYTteBp4MLhydEhMpuQJJEVl03zcL+zjzlMQZAiOMOdyHOeXUPCG6dSTVlUYQ7amnli7SavCTu316ewRYR3RfN2HbdpCRJibMgXMwqnE0ntjjJzS6uSVSi1OV80LIZ5OHVLaZYAraS/1wmo2oDYcCpiRZFpPzR8/tLk2JDZh7QGYEa/fvDZWCk/GgIRKn8GAhmgyCnHze2EMK406CnLmSVAtFHcQswWySeYaQTPfg4wizD9JuEfVIqWiiNk1yu6aFPpLRyJWuRl8XCU9l3fazhSwbO4b5n5s0wOb005vP9NObxGOTrdxYJUowKLBKnECL6vIIXgctNGPhElElEc2vzLIjO7yaq8tZ3dUsUC9BI5ig3MbIHVVCVbZDZN4r2N3SwXb7nZdI6XStJoOE2SvI3lrCdJs+F0D5dIssBy6pK8lemsI8kKy+H0icphwCZMM0VLu8yP+AjOs0cZ3pEQISW8/rmEjGnt660pUWA6gRGui1lPsMNFlfxHlSb247DKrsd8NDRPP/Io7WywoP6NSxlY41dy6e6s/EGd2awkn7ORkXgy63v5k5J1mHjmM4VNM7snrZyTj9DNOKZwa5S9SpS+Y6L0vd5rCHgZ2k2ODCvQ1ph6Vbw9z+se73deT27LUHvHr0d9VkbZxHqrAD1J/m1PD0uAb0ZTKAFfzhtbohlvQfvKpNggHlaVYgkRbMk0vBHfK9P+DUhfq7R/BSOsOkX7OEWH5ePudjywTLgNZmmVcCuYYlXhjkz+8PA7UcP+TwRdNpeHKO7JfvkzwIH52u/l2H7o90oi2fddVBqpZtUc8DEKZanImxDJMpe9wem8AXUTvawRsXe4KZvsbX31CrTeFjSy76scjYyyylD3jIF7XWc1u2ebDUfzJiNru85a6fQODjxnTR5PNowbuJGmoessQ/YqYk9mO9uut2Wqz9uxfN5+Umt9NFBSugfdhZyZVaSet5/sdRBvw/J5WyVYD+0alJ9tpv6sNu1pV9UV9cSMXcdZhzjytojy7iqY7HRaTGtxHNL1ZBOiQ2U96Xkl5kJ17o5yZItoCIu+pl+Li2BCD3g/iGxiixUHZk3qQGaN2w5NnUzwRtn/bfxFFWEjH6A6iGYU94+WcQFO77Osf6bz2+5VajyA+lbl7vLKLqqLcvp3l1n2/m1xFfP5zbiWJeIzWL3vBqu3bLg2+/ow9/tH2/v9BZ8llgGnHxy+9ns+/OwuM5Pe9mbSgwwBFBBAiqBpz598xPemSVIr0+a5xeokHEIGLZelAG1J8KYxDYrIbKxmmzNWHSW2u/Sz3wK0+RzdauXMnl9MN5/bGvvefv2qo+xKE/xGc4xfMTlY91sLCwemM3uDVUj4xOk7U60jc1PRiIYY4bm9xEuCzMVayVPV39sjEWvnKUkm9lTC1dnLSvcu/to9+stPD0i4ylr3bXtp62eXF8XW/ViG0HoPrUd4eHjgrRb+/uH1ff6AnX52nRnVU5Fc4WXDBVOn7zS995L+OUc8VD6l93rFMlwidi0ifnpzAQPzuuM6T0QyVAmMbpv7txgfC5yh5AY3JGAct722hyPCMJdgDgLJVWJXF3eOW+lfRJTb0WoLOdlLXlJ7WLegIojiNov+t/I7DC1k3Juq6zHiZKVZLY1uIHyV9bDwDiSsiixJAmNJC+mJ0N6NiEhwTzOhAotlZgP3P5ub5f7wB/yCwNx9hz9P8S4lC0uBTzgmxolh+uBleFLM7P06IgzFV7Rrmrxr2vry5csDXzRTyeMHjgwug8r3aaQVvH93Z9nJ14O79KIv1bY/rf4ovAwHkvvQwFyl86V6JdqXVJr0zjOFv9/h5X6FWxvxc2l7ZxS3typE0pwQPtzd3cDA3HKW0H3oN0RnRusvg+uPNxmyXcNBU/gpmh/GgXEmppqyN7e5sJ8UEBiRIH0Pi/cTBmfiBozUB+nbRmft9XuW5VbDhJMcKpF2bL7z1sVbKUcieE6HAcMnuIu1Q4SFJYXJrh5M7kwzPjCvb2/hwxFPruqiM8LQDpAQIaT+DxZQErby+fVFO35EJ2xNZ2Cr1cyn8bW9pFHjFvHZjPCCGSaXfNZujKtaxEt+Y97vF4P+fjHo7xeD/n+8GDTZ9Gn6Te9FIWH2dgRpNox2d/HJSXcXTn7THC6f/exGr8+uMxVKY92XF/xY4l6G8zkW21s/+58+53sHswkJmMK/g+yWz4WeZ+c2uYRyF15xy2ijWEkh4c9mKxPG+MtxnUf6XLzodP7ZJgACKg1W+/jUrK6FF2t3iJb2Z+/f3Tnz+f8APXFeHQ==",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},g=void 0,b={},S=[];function x(e){const t={code:"code",p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Lookup Scottish Postcode"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/scotland/postcodes/{postcode}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Lookup a Scottish postcode."}),"\n",(0,n.jsxs)(t.p,{children:["Returns Scottish Postcode Directory (SPD) data associated with the postcode. The response covers the full SPD field set: council area, electoral ward, Scottish and UK parliamentary geographies, health board, integration authority, data zone, intermediate zone, output area, locality, settlement, civil parish, island, national park, travel-to-work area, ITL/LAU, urban-rural classification, SIMD rank, ROA, census counts, and the corresponding GSS / official codes under the ",(0,n.jsx)(t.code,{children:"codes"})," object."]}),"\n",(0,n.jsx)(t.p,{children:"Top-level fields hold the latest (canonical) value for each datapoint. Year-suffixed fields surface prior versions where the SPD publishes them."}),"\n",(0,n.jsxs)(t.p,{children:["Returns ",(0,n.jsx)(t.code,{children:"404"})," if the postcode does not exist in SPD or is not valid."]}),"\n",(0,n.jsxs)(t.p,{children:["For postcodes not in SPD but present in ONSPD (i.e. non-Scottish postcodes), a ",(0,n.jsx)(t.code,{children:"404"}),' is returned with the error message "Postcode exists in ONSPD but not in SPD."']}),"\n",(0,n.jsx)(t.p,{children:"Source: Scottish Postcode Directory (National Records of Scotland)."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(c(),{parameters:[{name:"postcode",in:"path",description:"Specifies the postcode you wish to query",required:!0,style:"simple",explode:!1,schema:{type:"string"}}]}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Scottish Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Scottish Postcode Directory (SPD) data for the requested postcode.",type:"object",required:["postcode","longitude","latitude","council_area","electoral_ward","health_board_area","data_zone","intermediate_zone","output_area","scottish_parliamentary_constituency","scottish_parliamentary_region","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"The Royal Mail postcode (e.g., AB10 1XG).",example:"AB10 1XG",pattern:"^[A-Z]{1,2}[0-9][A-Z0-9]? ?[0-9][A-Z]{2}$"},pc_compact:{title:"Compact Postcode",type:"string",description:"Postcode with all spaces removed.",example:"AB101XG"},outcode:{title:"Outward Code",type:"string",description:"First part of the postcode (before the space).",example:"AB10"},incode:{title:"Inward Code",type:"string",description:"Second part of the postcode (after the space).",example:"1XG"},postcode_district:{title:"Postcode District",type:"string",description:"Equivalent to the outward code.",example:"AB10"},postcode_sector:{title:"Postcode Sector",type:"string",description:"Outward code plus the first character of the inward code.",example:"AB10 1"},user_type:{title:"User Type",type:"string",nullable:!0,description:'SPD user-type indicator ("0" = small user, "1" = large user).',example:"0"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"Date the postcode was introduced (YYYYMM).",example:"198001"},date_of_deletion:{title:"Date of Deletion",type:"string",nullable:!0,description:"Date the postcode was deleted (YYYYMM). Null for live postcodes.",example:null},linked_small_user_postcode:{title:"Linked Small User Postcode",type:"string",nullable:!0,description:"For large-user postcodes, the linked small-user postcode (if any).",example:null},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude.",example:-2.1025},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude.",example:57.14945},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"OS National Grid easting (1m resolution).",example:393859},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"OS National Grid northing (1m resolution).",example:806073},split_indicator:{title:"Split Indicator",type:"string",nullable:!0,description:"SPD split indicator. Marks postcodes that span more than one administrative unit.",example:"0"},grid_link_indicator:{title:"Grid Link Indicator",type:"string",nullable:!0,description:"How the postcode was linked to its grid reference (1 = match by address, 2 = match by visual inspection, 3 = approximate match, etc.).",example:"1"},grid_link_positional_accuracy:{title:"Grid Link Positional Accuracy",type:"string",nullable:!0,description:"Positional accuracy of the grid reference.",example:"1"},council_area:{title:"Council Area",type:"string",nullable:!0,description:"2019 council area name. The current single-tier local authority.",example:"Aberdeen City"},electoral_ward:{title:"Electoral Ward",type:"string",nullable:!0,description:"2022 electoral ward name.",example:"Midstocket/Rosemount"},registration_district:{title:"Registration District",type:"string",nullable:!0,description:"2007 registration district code. (Names are not provided in SPD.)",example:"RD20"},enterprise_region:{title:"Enterprise Region",type:"string",nullable:!0,description:"2008 enterprise region name.",example:"Highlands and Islands"},strategic_development_planning_area:{title:"Strategic Development Planning Area",type:"string",nullable:!0,description:"2013 SDPA code. Names are not provided in SPD.",example:"SD01"},local_government_district:{title:"Local Government District",type:"string",nullable:!0,description:"1995 local government district name (the most recent boundary before unitary council areas).",example:"Aberdeen City"},local_government_district_1991:{title:"Local Government District (1991)",type:"string",nullable:!0,description:"1991 local government district name (historical).",example:"City of Aberdeen"},uk_parliamentary_constituency:{title:"UK Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"2024 UK Parliamentary constituency name.",example:"Aberdeen South"},scottish_parliamentary_region:{title:"Scottish Parliamentary Region (2021)",type:"string",nullable:!0,description:"2021 Scottish Parliamentary region name.",example:"North East Scotland"},scottish_parliamentary_constituency:{title:"Scottish Parliamentary Constituency (2021)",type:"string",nullable:!0,description:"2021 Scottish Parliamentary constituency name.",example:"Aberdeen Central"},health_board_area:{title:"Health Board Area (2019)",type:"string",nullable:!0,description:"2019 NHS health board area name. Current operational boundary.",example:"Grampian"},health_board_area_2006:{title:"Health Board Area (2006)",type:"string",nullable:!0,description:"2006 health board area name (historical).",example:"Grampian"},health_board_area_1995:{title:"Health Board Area (1995)",type:"string",nullable:!0,description:"1995 health board area name (historical).",example:"Grampian"},integration_authority:{title:"Integration Authority (2019)",type:"string",nullable:!0,description:"2019 health and social care integration authority name.",example:"Aberdeen City"},output_area:{title:"Output Area (2022)",type:"string",nullable:!0,description:"2022 census Output Area code. The smallest census geography.",example:"S00136537"},output_area_2011:{title:"Output Area (2011)",type:"string",nullable:!0,description:"2011 census Output Area code.",example:"S00088970"},output_area_2001:{title:"Output Area (2001)",type:"string",nullable:!0,description:"2001 census Output Area code.",example:"S00000700"},output_area_1991:{title:"Output Area (1991)",type:"string",nullable:!0,description:"1991 census Output Area code.",example:null},data_zone:{title:"Data Zone (2022)",type:"string",nullable:!0,description:"2022 Data Zone name. Scottish equivalent of LSOA.",example:"West End North - 01"},data_zone_2011:{title:"Data Zone (2011)",type:"string",nullable:!0,description:"2011 Data Zone code.",example:"S01006571"},data_zone_2001:{title:"Data Zone (2001)",type:"string",nullable:!0,description:"2001 Data Zone code.",example:"S01000125"},intermediate_zone:{title:"Intermediate Zone (2022)",type:"string",nullable:!0,description:"2022 Intermediate Zone name. Scottish equivalent of MSOA.",example:"West End North"},intermediate_zone_2011:{title:"Intermediate Zone (2011)",type:"string",nullable:!0,description:"2011 Intermediate Zone code.",example:"S02000007"},intermediate_zone_2001:{title:"Intermediate Zone (2001)",type:"string",nullable:!0,description:"2001 Intermediate Zone code.",example:"S02000017"},locality:{title:"Locality (2022)",type:"string",nullable:!0,description:"2022 Settlement-and-Locality locality name.",example:"Aberdeen"},locality_2020:{title:"Locality (2020)",type:"string",nullable:!0,description:"2020 locality name (historical).",example:"Aberdeen"},locality_2001:{title:"Locality (2001)",type:"string",nullable:!0,description:"2001 locality name (historical).",example:"Aberdeen"},locality_1991:{title:"Locality (1991)",type:"string",nullable:!0,description:"1991 locality name (historical).",example:null},settlement:{title:"Settlement (2022)",type:"string",nullable:!0,description:"2022 settlement name.",example:"Aberdeen, Milltimber, and Peterculter"},settlement_2020:{title:"Settlement (2020)",type:"string",nullable:!0,description:"2020 settlement name (historical).",example:"Aberdeen Settlement"},settlement_2001:{title:"Settlement (2001)",type:"string",nullable:!0,description:"2001 settlement name (historical).",example:"Aberdeen Settlement"},civil_parish:{title:"Civil Parish (1930)",type:"string",nullable:!0,description:"1930 Scottish civil parish name (the latest historical baseline; civil parishes were abolished as administrative units in 1975).",example:"Old Machar"},island:{title:"Island",type:"string",nullable:!0,description:'Island name where the postcode is located. "Mainland of Scotland" for non-island postcodes.',example:"Mainland of Scotland"},national_park:{title:"National Park (2010)",type:"string",nullable:!0,description:"2010 national park name (Cairngorms / Loch Lomond and the Trossachs). Null for non-park postcodes.",example:null},travel_to_work_area:{title:"Travel to Work Area (2011)",type:"string",nullable:!0,description:"2011 Travel to Work Area name.",example:"Aberdeen"},lau_level_1:{title:"Local Administrative Unit Level 1 (2025)",type:"string",nullable:!0,description:"2025 LAU level 1 name. Replaces the previous NUTS classifications.",example:"Aberdeen City"},itl_level_2:{title:"International Territorial Level 2 (2025)",type:"string",nullable:!0,description:"2025 ITL level 2 name. Mid-tier UK statistical geography (replaces NUTS 2).",example:"North Eastern Scotland"},itl_level_3:{title:"International Territorial Level 3 (2025)",type:"string",nullable:!0,description:"2025 ITL level 3 name. The most granular ITL geography (replaces NUTS 3).",example:"Aberdeen City and Aberdeenshire"},urban_rural_6_fold:{title:"Urban-Rural Classification (6-fold, 2022)",type:"string",nullable:!0,description:"2022 Scottish Government 6-fold urban-rural classification code:\n\n* 1: Large Urban Areas\n* 2: Other Urban Areas\n* 3: Accessible Small Towns\n* 4: Remote Small Towns\n* 5: Accessible Rural\n* 6: Remote Rural\n",example:"1"},urban_rural_8_fold:{title:"Urban-Rural Classification (8-fold, 2022)",type:"string",nullable:!0,description:'2022 Scottish Government 8-fold urban-rural classification code (1\u20138). Splits "Remote" categories into "Remote" and "Very Remote".',example:"1"},scottish_index_of_multiple_deprivation:{title:"Scottish Index of Multiple Deprivation (2020)",type:"integer",format:"int32",nullable:!0,description:"SIMD 2020 rank for the postcode's Data Zone (1 = most deprived, 6976 = least deprived).",example:6414},roa_community_planning_partnership:{title:"Community Planning Partnership (ROA 2006)",type:"string",nullable:!0,description:"2006 Community Planning Partnership name (Regional Outcome Agreement geography).",example:"Aberdeen City"},roa_local:{title:"Local Authority (ROA 2006)",type:"string",nullable:!0,description:"2006 Regional Outcome Agreement local authority name.",example:"Aberdeen City"},census_household_count:{title:"Census Household Count (2022)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded against this postcode at the 2022 census. May be 0 for empty or zero-suppressed postcodes.",example:0},census_household_count_2011:{title:"Census Household Count (2011)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded at the 2011 census.",example:8},census_household_count_2001:{title:"Census Household Count (2001)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded at the 2001 census.",example:12},census_household_count_1991:{title:"Census Household Count (1991)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded at the 1991 census.",example:null},census_population_count:{title:"Census Population Count (2022)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded against this postcode at the 2022 census.",example:0},census_population_count_2011:{title:"Census Population Count (2011)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded at the 2011 census.",example:18},census_population_count_2001:{title:"Census Population Count (2001)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded at the 2001 census.",example:26},census_population_count_1991:{title:"Census Population Count (1991)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded at the 1991 census.",example:null},never_digitised:{title:"Never Digitised",type:"boolean",description:"True if the postcode has never been digitised (no grid reference established).",example:!1},codes:{title:"Codes",type:"object",description:"GSS / official codes for the corresponding name fields above.",properties:{council_area:{title:"Council Area Code (2019)",type:"string",nullable:!0,description:"9-character GSS code for the 2019 council area.",example:"S12000033"},electoral_ward:{title:"Electoral Ward Code (2022)",type:"string",nullable:!0,description:"9-character GSS code for the 2022 electoral ward.",example:"S13002841"},enterprise_region:{title:"Enterprise Region Code (2008)",type:"string",nullable:!0,description:"Code for the 2008 enterprise region.",example:"S99999999"},local_government_district:{title:"Local Government District Code (1995)",type:"string",nullable:!0,description:"Code for the 1995 local government district.",example:"S12000033"},local_government_district_1991:{title:"Local Government District Code (1991)",type:"string",nullable:!0,description:"Code for the 1991 local government district.",example:"S99999999"},uk_parliamentary_constituency:{title:"UK Parliamentary Constituency Code (2024)",type:"string",nullable:!0,description:"9-character GSS code for the 2024 UK Parliamentary constituency.",example:"S14000061"},scottish_parliamentary_region:{title:"Scottish Parliamentary Region Code (2021)",type:"string",nullable:!0,description:"9-character GSS code for the 2021 Scottish Parliamentary region.",example:"S17000016"},scottish_parliamentary_constituency:{title:"Scottish Parliamentary Constituency Code (2021)",type:"string",nullable:!0,description:"9-character GSS code for the 2021 Scottish Parliamentary constituency.",example:"S16000094",pattern:"^S[0-9]{8}$"},health_board_area:{title:"Health Board Area Code (2019)",type:"string",nullable:!0,description:"9-character GSS code for the 2019 NHS health board area.",example:"S08000020"},health_board_area_2006:{title:"Health Board Area Code (2006)",type:"string",nullable:!0,description:"GSS code for the 2006 health board area.",example:"S08000006"},health_board_area_1995:{title:"Health Board Area Code (1995)",type:"string",nullable:!0,description:"Code for the 1995 health board area.",example:"0"},integration_authority:{title:"Integration Authority Code (2019)",type:"string",nullable:!0,description:"9-character GSS code for the 2019 integration authority.",example:"S37000002"},data_zone:{title:"Data Zone Code (2022)",type:"string",nullable:!0,description:"GSS code for the 2022 Data Zone.",example:"S01013550"},data_zone_2011:{title:"Data Zone Code (2011)",type:"string",nullable:!0,description:"GSS code for the 2011 Data Zone.",example:"S01006571"},data_zone_2001:{title:"Data Zone Code (2001)",type:"string",nullable:!0,description:"Code for the 2001 Data Zone.",example:"S01000125"},intermediate_zone:{title:"Intermediate Zone Code (2022)",type:"string",nullable:!0,description:"GSS code for the 2022 Intermediate Zone.",example:"S02002527"},intermediate_zone_2011:{title:"Intermediate Zone Code (2011)",type:"string",nullable:!0,description:"GSS code for the 2011 Intermediate Zone.",example:"S02000007"},intermediate_zone_2001:{title:"Intermediate Zone Code (2001)",type:"string",nullable:!0,description:"Code for the 2001 Intermediate Zone.",example:"S02000017"},locality:{title:"Locality Code (2022)",type:"string",nullable:!0,description:"Code for the 2022 locality.",example:"S19000001"},settlement:{title:"Settlement Code (2022)",type:"string",nullable:!0,description:"Code for the 2022 settlement.",example:"S20000001"},civil_parish:{title:"Civil Parish Code (1930)",type:"string",nullable:!0,description:"Code for the 1930 civil parish.",example:"S07000001"},island:{title:"Island Code",type:"string",nullable:!0,description:"Island identifier code.",example:"S20000001"},national_park:{title:"National Park Code (2010)",type:"string",nullable:!0,description:"Code for the 2010 national park.",example:null},travel_to_work_area:{title:"Travel to Work Area Code (2011)",type:"string",nullable:!0,description:"Code for the 2011 Travel to Work Area.",example:"S22000047"},lau_level_1:{title:"LAU Level 1 Code (2025)",type:"string",nullable:!0,description:"Code for the 2025 LAU level 1 area.",example:"TLM50"},itl_level_2:{title:"ITL Level 2 Code (2025)",type:"string",nullable:!0,description:"Code for the 2025 ITL level 2 area.",example:"TLM5"},itl_level_3:{title:"ITL Level 3 Code (2025)",type:"string",nullable:!0,description:"Code for the 2025 ITL level 3 area.",example:"TLM50"},registration_district:{title:"Registration District Code (2007)",type:"string",nullable:!0,description:"Code for the 2007 registration district.",example:"RD20"},strategic_development_planning_area:{title:"SDPA Code (2013)",type:"string",nullable:!0,description:"Code for the 2013 strategic development planning area.",example:"SD01"},roa_community_planning_partnership:{title:"Community Planning Partnership Code (ROA 2006)",type:"string",nullable:!0,description:"Code for the 2006 community planning partnership.",example:"S12000033"},roa_local:{title:"ROA Local Code (2006)",type:"string",nullable:!0,description:"Code for the 2006 ROA local authority.",example:"S12000033"}}}},title:"ScottishPostcodes"}}}}}},404:{description:"Postcode not found"}}})]})}function C(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/4c84271f.d619ac4b.js b/build/assets/js/4c84271f.d619ac4b.js
new file mode 100644
index 000000000..ee5de0424
--- /dev/null
+++ b/build/assets/js/4c84271f.d619ac4b.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[1516],{26652(e,t,i){i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>x,frontMatter:()=>y,metadata:()=>o,toc:()=>S});const o=JSON.parse('{"id":"api/get-scottish-postcode","title":"Lookup Scottish Postcode","description":"Lookup a Scottish postcode.","source":"@site/docs/api/get-scottish-postcode.api.mdx","sourceDirName":"api","slug":"/api/get-scottish-postcode","permalink":"/docs/api/get-scottish-postcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-scottish-postcode","title":"Lookup Scottish Postcode","description":"Lookup a Scottish postcode.","sidebar_label":"Lookup Scottish Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJztXP1u4ziSf5WC9oBJFrIj2/n0YbCX6fR2ZyfpBHGyc7OdPjct0TY3MqkhqaSzgYF7h3vDe5JDkfqW/BE7fXs4TP/TMUWRvyKrisXiT3xxNJkop//ZGfhCa6amcC2U9kVAlfPFdQKqfMkizQR3+s6FEA9xBASyylFSuX3P7/kN1bHkCmpNwRmT1NdCPsPO4PpsFwKiCRClhM+IpgE8MT0FPaV5e3A7pSCpigRXFHzxSKUyNcZxGMLg+gzGjIYBKKr74IuY+ywEIilxgYamLxLCE5GBm8MhPIC7nyEiMmRkRrkm8hkmVEwkiaaMKhemlIR6CiNhXmRc04kkKDyQWE+FZPrZteD/ITi1NeSMBihFUiRiHcU6gRIKn4TmJUW1Dil26oLPHlmIMJiausBUSHjgAjcdEfPgwQUtySMNW1q0noR8SNo7v73Yuzi9cyGWI8JbMkYp/ZAoxcbMNw24MDi/PANJ+IMLN1enLviUq1iZQdLKNaOAA+kLacc3YHwCHwYD2AMxHjOfYZuoABDzgEpT+asp+Api9HfqazPbtyJqhfSRhnYmFExFaFsOiaZKw45PuODMJ+EuPJIwpjAWEijxp2YII8G4bsOvlMiWisdj9o0GaVMqlmPiU4gkExJw7pngCp6mVFLTBSpAFI9CpqbU6MWspIFf9739r8DGJZ2CQFAFXGig35jSwLhpRkhgtviRhCww7fxZyOw1+yypPIo1RJIqyk3R1Scs3GFt2gYueKtmF2rXBZLCUSANvqLCUymFhBlVikwo3DuZyRiMKu8Ee86BtO8dxDkQsfRpf7nFfUoV64b6QgYKxNi8gGq3277njuuIiFo9Pw+cvjOhOm0wbc9xnYhIMqOaSnQXLw4nM+r0nSivwNBFRERPnarfGETUZ2NmZyqfj2cRwxOi1gJ+i6l8dlxH0t9iJmng9LWMqeso/RxiP4rNohB7od+iEPvrj0mosII/pTPi9F8c/RyZmloyPnHm8y/YmnUgCp93PQ//q0CLfZ8q5biOL7imXGMVEkVhYk57f1dY76XYD9MGUn3Qb5LuHDcFY+2lJNdnR2miY2UKVRxq9LORxCnQzCJNKuQyGU9EpeM6YyFnRNuiXhfHg8czp/+563lf5lmLdTHXc8looNo43t9iqtAzZw55hUwFPQgFnzAd27+JTv9MnPQQPRniTr30EL204zrW9w6N700rIagh+lWjXrmvTcuss01rq0TIYcnDD33BFaKg3H9eXEvSCQ4V4kzWvvKcZAIWNKBgHWXlqxoALmY34pmEcEnQ9aeTsEPbk7YLpz91POj8+4fdtlFwYlS976TFxvi0phKb+o/Pp62/fXnpuN35Z6918gV/4v9/gj9lv7+8dOf/4sxdJ/KHvphFxNdF2O9sEawNP1Ma47ZIGIKKiE/Rn83EIw3qsBH13MxPdcyuYo0TDu/W6fjPTCqNC6JGp1VyHjsjOhbJamDQNAweQmC8iuCcrw9gQH3BgwUIyFgny2MTgGQI0urDgGEf5ZkoWGPycBWg97/F7JGEuP5oYfoWyYCmVlofggyCMibXCGBgH63q/qrQGURhnMRkZpr8KZHExyFJRorxJcCgg9BiReXQdpmDulNUwi0W1uHwOAzJCKvZ9aEyXddngE228DVgPEAvLiTs3DvevQM/gpqh9mIVF+6djikLiZxQU1aZQTN4AbobMR4yrqUIYt/2lIM9w9BPjOG8+Py1uE0jJeV6Irj22yZpADu//vrrr5eXVRU7Ofa8ThFlQEO6COFZ+uxt0JmuitDgE4bmuISE7DGvrEqYsae564SMP9BgaKZjaJSgyb9emFowMJNmtGKJy1ouA0Z0ZqJb2FsOzrURq+3IwClXgB02BsKfdxulyFa6IujC8pdg5PFsVF69AxGPTDizHPUvHwbH+5B1U8LQ6rY7XvdgXlhkiyjyhfeNQCQNljAcHLU7+yf7CIISpRmfqCKI92mZu0YgsxzE1QCyOPaDZAEk/cFOZ4b7RBHG+LQ8Tb2T3vHBydx1uJB6WkX3KSv8DvDSHpfiO/YOvaPe3HVUFDI9zPxVKcrER3CePdrEJZrmc3fYhksiH1Rhh6OnROMixmFm11TCQXAKJJgxjksT0WjSMWe6wUVOJAuGaELNEpjxQFPeQoqP4qnugRKr1QKYVoAoQNIxlZT7FHY68CPMiPanMHoGEgSSKuVCt1j6yFRMQmBcRdS3m+ce/AgkiqT4xmbo9kxdF6j221XnWxY9EopZBRgS348l8Z+bB+E6qwinacXXDkehjbSzdNEtD0MD5FIcXooKbRLl1AbTrwPU9TonpTQM4P7QZnH8WEqMVxTjk5C2NKPSJkbypEolPBhRGVDK4R3Tzwi5slcoepgs1/OL3UW8Fna3W8kXWeAlPJcsUFr4D1Tv3QhFZ5hIccxma5LYhuCN4d1NocKyEG8VSO8Iin1B2pcNrXCHP6MKh91kCCIpHllAgzRVsFsS5uasa4yW4nYqkkzRdOtTHNbsIdyk+6JXgz6GvA+wfTQM7kc2mWImQpnE1LlJhikEaKSlE+YPA8wyiQh3asMoJJwzPqmp7yCtDmd5dbhOqm+s1T0YnF2fJgO9fJxLYg3ObGBmFH04wfwlNwI06cmFsYYPWaXNdaVzcnKQGFfeZ64vOPywg25iJpQGSX18PBIxDzAXmmyp0M3jz6I9q+r2qmqjCwUddk5OOmtJCztYdXcToTsrhZ4ypYU02ciyJCgAOs9UIrMteViWQyhuVX6G61I6+V2hIux0ve7+6+XBt6DWchFCgx1lEzIQsZ4aA1qa6GhMZJU6tJZvhDjYSIgDWNBywRnATrLFvqGPjD6lucnKS/CTVVGTpB8MzgFb3+seH7hAx2Ncux8pEG0WwCO4JM9Y4RA+ivBZChFYF2/CL7idMoWpWF1YmQKq2MTm38uDakJEwDA2y5iuHNlh1+t2Xje8G+g8vrXW8Ko4olJR9FOjZyO1mZmCyLvbyLzIMBZAq5nHG2tWzUj+b+tX7kUp15KEaw70uipWG+03VrSG0X61ujUNQT0VXJD1oz2j+wkfmmUdJeucbCJZ5wQ+fRyUTv2Kweu7ZPqy0xESZmtlWYgPkswiRngj+GHX8w5XSuAdbiKBd7gA/ZIFbzlYjCBWgMUqG63SB9uBLZzHDrOtQzmzmx/YnqYVtlKPBC+GpuawOgQfw7/Gk+Fli3IaJRUPLMpJcTw0TnWh293ITrvpUW+xufw03WS38GA2qZWefFd0eeB5nd7hQe+ognfY9TqdJaA7GzmXTmch6Coq7/j45Miro/KWofI2QuW9ApXnHXk1VNWYt4Rqiyh3HVRJcjI/Oyvnggn8DVM726hZ3op1lNnyQPPTCTGGi8HVaXm8fkH1e88DsEFGC7LstYVa07ES3o01LG+laQo7nnd4cFQD4i0GsrFSrQTidboHqasrH3ZW3FzGOtl6MuutLZ3UyxWT2oi+Nq+NImw8v/XWmoa3a411EUBvNcCN5/0VADtH2W66srpdJGVbzfYg4yG1CA9aWZtph0sWsSIujEC9heC8jcB5ZRBLgoIFiLx6miFBtPHEbYWoMfFhEG2b51iNKFkEctpZabuQlW6lS3njS7TGhUsWhprh4ZMln10jiciPQ02lU4JYU6oKzk3VqoJzjWksmEkNYlnLyhA31rOtIRpO4dByCktZfcM1vDblqHe9DQYR38qXgyJ7sZBQTEh/OW4YEUVDxum/ll6hCp6QxUdGwrD3AiCq6ZzJUN86J0cHFfmvwgAuCXINjCM3+eKS47Ylr5XRvmblyWmG2XETU8bwNA3acO9cEsZN9QKT7t4xR9/IArSgFhyAN76MoqT8T5zEh9I5Zbr3vCbywayTGxlCxytTTJO5e0eY5BMhZwr24EL4U7gQM0yYpDzRWymUIv5UFU/4UUzTyNJTfsthHWoxRA5rbddzax7j+d0vSHHdeiPR1N6K5YzEQ8NhHTZkqE/LSnnHmYYLQ3jtbJW6uji9gzBpx4ZaNzQKDZ/K6Jykj0zECj7d3Q4q5F61YnvJdJjI060FM9nk31IpGRopCRN5ulvJc357kcjTTeS5ZIE95rv7GZDLyJQ2HiHbccKOTEU2UnYX5iCp5CUrySXsvUbC3htJ2Cuca5ojlIkkPA6JNHUWytdbdnpiLC0tUVMmqTmCQIb30DC8h4fDsQhLXu7O8L9vDP/7XUlFYOewhbVd2CZKTJ194ZTGNruEeW5i2j7Skv8InT5cGFqVAWpMUWF5tw9XeoqaUS7v9fEwnCrFRiFNCD+34ombh/t9uKEzoWsPDkpvmdHA4sOsflJUPwQvju7xq0b3+PuM7vFaows7nf/+z/863m2DoYUouHespPcO4Oo0EZjCxvSUKD5CBbt3/krNqYMtayAGZIlnxgP6DdlkszjULArpMKCRZI+kyizLBDnHN8zuMHkDzvI3arHbxiwb82WDCenw84aMrZyuQT+owgbb8j/QRC14GrhweHJ0iIQ/5A5lxWXTPNzv7OPRviDInJ1hJPKcHzojD5RTqaYsqhBqbc38vPk6rwk7N1ensEWGd0Xzdh23x0kkxNyQL2YUTieS2ogyc0urznBRarO/aFgM83TqltIsAVphhayTULUJseFUxIriByhD85lLaXJsyuxjWgOQ6FLf+GyslJ8Mrw6VPwOBxGj81AKD2wlhXOHJEcsJV+lRUiFn2zanSiMKnv1KZhbhqbSEf1ApWiqO8KMTRRcFld7CkahlXhYPRynu+l7DkQqe5X3LhLhlcnhryuH9b8rhNcrR6S4WpJoVWCRIJUfwfQUpJJebAvlElEhEcWjPXxaZ2XVW5a3t7IYqFqCXyFFsYGYLrKYq2SKzaRLvbexmuXjLzaZzvFSSRsNpkuRtLGc9SZoNp3u4RJIFllOX5K1MZx1JVlgOp49UDgM2YZopWooyP+EjOMseZXhHQoSU8PpXRDKmtY8ap0SB6QRGuC5mPcEOF1VOLFWa2G8mK1GP+ZZunn77VIpssKD+6VcZWOPHo2l0Vv7O1AQryVeeZCQezfpe/tJqHYKq+Xpn05Pdk1b+qQpCN+OYwq0xWStZ+o7J0vd6r+GlZmg32TKsQFsjsFbx9jyve7zfeT3nM0PtHb8e9bsyyiYyaAXoSfJve9ZkAnwzmkIJ+HI65RLNeAs2ZCbFBvmwqhRL+JFLpuGNaJCZ9m/AhVyl/SuIktUp2scpOixvd7ejR2bCbaBrq4RbRaDcaSCY7VZFPkKRu4dvzVvM5N5AO5fKXWCQrSY5Ngrb2f9OhMV/ylyXSHZrzfghjsFBp/zZ8MB8HfxybD8M/l4kw3+2Viyz/UNz/L+/bFheSTz8vkFIIzWxyhk4NtbtbUo8zJb4DbI5Daib6IiNiL3DTdmHb7u2r0DrbUE7/L7K0chArAx1z3hDr+usZoNtE6A2B6VZ23WWU6d3cOA5a/K+smHcwKM0DV1nGbJXEcEy29k2PitTw96OFfb2k1rro4HC1D3oLuRYrSKBvf1kr4N4G1bY2yrBemjXoIhtM/XvatOedlVdUU/M2HWcdYhGb4so766CyU6nxbQWJyZdTzYhxlTWk55XYrpU5+4oR7aItrLoUpK1uCsmVYXXLMkmdmFxYNakmmTWuO3Q1Mknb8QW2cZfVBE28keqg2hGcf9oGXfk9C5jiWyzX6jqfJk3Ug9Vbi8u7aK6iANye5GxPd4WV5H/0YxrGXEjg9X7brB6y4Zrs4+4c79/tL3fX/B1dxlw+t32az+Lxq+XMzPpbW8mPcgQQAEBpAiaYv7kW+g3PVS3Mm1+Fl2dhEPIoOWyFKAtSfY1HpsjMpvb22aPVUeJ7S69PaEAbT5Ht1rZvuf3e87ntsa+t1+/MS67GQo/dR/jV28O1v3WwsKB6cxeBBgSPnH6zlTryFz4NqIhZgRvLvCuNXM/YfJU9ff2SMTa+RE2E3sq4XbtZaV753/tHv3lp3sk6GWt+7a9tPV3F+fF1v1YhtD6AK0HuL+/560W/v7h9X3+gJ1+cZ0Z1VOR3IRo0wVTp+80vfeS/jlHPFQ+ptcjxjJcInbtBOX0+hwG5nXHdR6JZKgSeBpirjFkfCxwhpKLMJGwc9z22h6OCMOzJ7MRSG5kvDy/ddxK/yKi3I5WW8jJXvKS2sO6BRVBFDfZaVErvwrWQsbYVF2NEScrzWppdAPhq6yHhVfJYVVk1RIYS1o4zgrtFbOIBGOaCRVYLDMbuPvZXND5hz/gFyfmClH8eYpX0llYCnzCkUhBDDMM7xSVYmavKRNhKJ7Qrmnyrmnr69ev93zRTCWP7zky/gwq36eRVvDh/a1ls18NbtP7ElXb/rT6o/BOMUiulQRzI9nX6s2SX1Np0qsjFf5+j3ekFi6/xVsn7NV73F5OE0mzQ/h4e3sNA3NZZEIPo98QnRmtvwyuPl1nyMyXyVThp4t+GAfGmZhqyl6A6cJ+UkBgRIL0PSzeTxi/iRswUh+kbxudtbeYWlZkDRNOcqhE2rG5LkMXL/cdieA5HQZMn2AUa4cIC0sKk93gmlw9aXxgXt9eZoojntx4SGeEoR0ggUZI/W8soCRs5fPri3b8gE7Yms7AVquZT+Nre0mjxi3isxnhBTNM7kquXbxZtYiX/OLR3+9X/v1+5d/vV/7/eL9yEvRp+k3vRSFh9pIZaQJGG118dtLowskv7MTls59djPjFdaZCaaz78oIf19zJcD7HYnt5cv/zlzx2MEFIwBT+HWSXJS/0PDs3yV2+u/CKy5obxUoKCX82oUwY4y/HdR7oc/G+6PkXewAQUGmw2senZnUtvFi7irkUn314f+vM5/8DFJMxpQ==","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Scottish Postcodes","permalink":"/docs/api/scottish-postcodes"},"next":{"title":"Outward Codes","permalink":"/docs/api/outward-codes"}}');var a=i(31325),n=i(31736),l=i(47812),r=i.n(l),s=i(38616),c=i.n(s),p=i(67994),d=i.n(p),u=i(54768),h=i.n(u),m=(i(24909),i(96847),i(78121));const y={id:"get-scottish-postcode",title:"Lookup Scottish Postcode",description:"Lookup a Scottish postcode.",sidebar_label:"Lookup Scottish Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJztXP1u4ziSf5WC9oBJFrIj2/n0YbCX6fR2ZyfpBHGyc7OdPjct0TY3MqkhqaSzgYF7h3vDe5JDkfqW/BE7fXs4TP/TMUWRvyKrisXiT3xxNJkop//ZGfhCa6amcC2U9kVAlfPFdQKqfMkizQR3+s6FEA9xBASyylFSuX3P7/kN1bHkCmpNwRmT1NdCPsPO4PpsFwKiCRClhM+IpgE8MT0FPaV5e3A7pSCpigRXFHzxSKUyNcZxGMLg+gzGjIYBKKr74IuY+ywEIilxgYamLxLCE5GBm8MhPIC7nyEiMmRkRrkm8hkmVEwkiaaMKhemlIR6CiNhXmRc04kkKDyQWE+FZPrZteD/ITi1NeSMBihFUiRiHcU6gRIKn4TmJUW1Dil26oLPHlmIMJiausBUSHjgAjcdEfPgwQUtySMNW1q0noR8SNo7v73Yuzi9cyGWI8JbMkYp/ZAoxcbMNw24MDi/PANJ+IMLN1enLviUq1iZQdLKNaOAA+kLacc3YHwCHwYD2AMxHjOfYZuoABDzgEpT+asp+Api9HfqazPbtyJqhfSRhnYmFExFaFsOiaZKw45PuODMJ+EuPJIwpjAWEijxp2YII8G4bsOvlMiWisdj9o0GaVMqlmPiU4gkExJw7pngCp6mVFLTBSpAFI9CpqbU6MWspIFf9739r8DGJZ2CQFAFXGig35jSwLhpRkhgtviRhCww7fxZyOw1+yypPIo1RJIqyk3R1Scs3GFt2gYueKtmF2rXBZLCUSANvqLCUymFhBlVikwo3DuZyRiMKu8Ee86BtO8dxDkQsfRpf7nFfUoV64b6QgYKxNi8gGq3277njuuIiFo9Pw+cvjOhOm0wbc9xnYhIMqOaSnQXLw4nM+r0nSivwNBFRERPnarfGETUZ2NmZyqfj2cRwxOi1gJ+i6l8dlxH0t9iJmng9LWMqeso/RxiP4rNohB7od+iEPvrj0mosII/pTPi9F8c/RyZmloyPnHm8y/YmnUgCp93PQ//q0CLfZ8q5biOL7imXGMVEkVhYk57f1dY76XYD9MGUn3Qb5LuHDcFY+2lJNdnR2miY2UKVRxq9LORxCnQzCJNKuQyGU9EpeM6YyFnRNuiXhfHg8czp/+563lf5lmLdTHXc8looNo43t9iqtAzZw55hUwFPQgFnzAd27+JTv9MnPQQPRniTr30EL204zrW9w6N700rIagh+lWjXrmvTcuss01rq0TIYcnDD33BFaKg3H9eXEvSCQ4V4kzWvvKcZAIWNKBgHWXlqxoALmY34pmEcEnQ9aeTsEPbk7YLpz91POj8+4fdtlFwYlS976TFxvi0phKb+o/Pp62/fXnpuN35Z6918gV/4v9/gj9lv7+8dOf/4sxdJ/KHvphFxNdF2O9sEawNP1Ma47ZIGIKKiE/Rn83EIw3qsBH13MxPdcyuYo0TDu/W6fjPTCqNC6JGp1VyHjsjOhbJamDQNAweQmC8iuCcrw9gQH3BgwUIyFgny2MTgGQI0urDgGEf5ZkoWGPycBWg97/F7JGEuP5oYfoWyYCmVlofggyCMibXCGBgH63q/qrQGURhnMRkZpr8KZHExyFJRorxJcCgg9BiReXQdpmDulNUwi0W1uHwOAzJCKvZ9aEyXddngE228DVgPEAvLiTs3DvevQM/gpqh9mIVF+6djikLiZxQU1aZQTN4AbobMR4yrqUIYt/2lIM9w9BPjOG8+Py1uE0jJeV6Irj22yZpADu//vrrr5eXVRU7Ofa8ThFlQEO6COFZ+uxt0JmuitDgE4bmuISE7DGvrEqYsae564SMP9BgaKZjaJSgyb9emFowMJNmtGKJy1ouA0Z0ZqJb2FsOzrURq+3IwClXgB02BsKfdxulyFa6IujC8pdg5PFsVF69AxGPTDizHPUvHwbH+5B1U8LQ6rY7XvdgXlhkiyjyhfeNQCQNljAcHLU7+yf7CIISpRmfqCKI92mZu0YgsxzE1QCyOPaDZAEk/cFOZ4b7RBHG+LQ8Tb2T3vHBydx1uJB6WkX3KSv8DvDSHpfiO/YOvaPe3HVUFDI9zPxVKcrER3CePdrEJZrmc3fYhksiH1Rhh6OnROMixmFm11TCQXAKJJgxjksT0WjSMWe6wUVOJAuGaELNEpjxQFPeQoqP4qnugRKr1QKYVoAoQNIxlZT7FHY68CPMiPanMHoGEgSSKuVCt1j6yFRMQmBcRdS3m+ce/AgkiqT4xmbo9kxdF6j221XnWxY9EopZBRgS348l8Z+bB+E6qwinacXXDkehjbSzdNEtD0MD5FIcXooKbRLl1AbTrwPU9TonpTQM4P7QZnH8WEqMVxTjk5C2NKPSJkbypEolPBhRGVDK4R3Tzwi5slcoepgs1/OL3UW8Fna3W8kXWeAlPJcsUFr4D1Tv3QhFZ5hIccxma5LYhuCN4d1NocKyEG8VSO8Iin1B2pcNrXCHP6MKh91kCCIpHllAgzRVsFsS5uasa4yW4nYqkkzRdOtTHNbsIdyk+6JXgz6GvA+wfTQM7kc2mWImQpnE1LlJhikEaKSlE+YPA8wyiQh3asMoJJwzPqmp7yCtDmd5dbhOqm+s1T0YnF2fJgO9fJxLYg3ObGBmFH04wfwlNwI06cmFsYYPWaXNdaVzcnKQGFfeZ64vOPywg25iJpQGSX18PBIxDzAXmmyp0M3jz6I9q+r2qmqjCwUddk5OOmtJCztYdXcToTsrhZ4ypYU02ciyJCgAOs9UIrMteViWQyhuVX6G61I6+V2hIux0ve7+6+XBt6DWchFCgx1lEzIQsZ4aA1qa6GhMZJU6tJZvhDjYSIgDWNBywRnATrLFvqGPjD6lucnKS/CTVVGTpB8MzgFb3+seH7hAx2Ncux8pEG0WwCO4JM9Y4RA+ivBZChFYF2/CL7idMoWpWF1YmQKq2MTm38uDakJEwDA2y5iuHNlh1+t2Xje8G+g8vrXW8Ko4olJR9FOjZyO1mZmCyLvbyLzIMBZAq5nHG2tWzUj+b+tX7kUp15KEaw70uipWG+03VrSG0X61ujUNQT0VXJD1oz2j+wkfmmUdJeucbCJZ5wQ+fRyUTv2Kweu7ZPqy0xESZmtlWYgPkswiRngj+GHX8w5XSuAdbiKBd7gA/ZIFbzlYjCBWgMUqG63SB9uBLZzHDrOtQzmzmx/YnqYVtlKPBC+GpuawOgQfw7/Gk+Fli3IaJRUPLMpJcTw0TnWh293ITrvpUW+xufw03WS38GA2qZWefFd0eeB5nd7hQe+ognfY9TqdJaA7GzmXTmch6Coq7/j45Miro/KWofI2QuW9ApXnHXk1VNWYt4Rqiyh3HVRJcjI/Oyvnggn8DVM726hZ3op1lNnyQPPTCTGGi8HVaXm8fkH1e88DsEFGC7LstYVa07ES3o01LG+laQo7nnd4cFQD4i0GsrFSrQTidboHqasrH3ZW3FzGOtl6MuutLZ3UyxWT2oi+Nq+NImw8v/XWmoa3a411EUBvNcCN5/0VADtH2W66srpdJGVbzfYg4yG1CA9aWZtph0sWsSIujEC9heC8jcB5ZRBLgoIFiLx6miFBtPHEbYWoMfFhEG2b51iNKFkEctpZabuQlW6lS3njS7TGhUsWhprh4ZMln10jiciPQ02lU4JYU6oKzk3VqoJzjWksmEkNYlnLyhA31rOtIRpO4dByCktZfcM1vDblqHe9DQYR38qXgyJ7sZBQTEh/OW4YEUVDxum/ll6hCp6QxUdGwrD3AiCq6ZzJUN86J0cHFfmvwgAuCXINjCM3+eKS47Ylr5XRvmblyWmG2XETU8bwNA3acO9cEsZN9QKT7t4xR9/IArSgFhyAN76MoqT8T5zEh9I5Zbr3vCbywayTGxlCxytTTJO5e0eY5BMhZwr24EL4U7gQM0yYpDzRWymUIv5UFU/4UUzTyNJTfsthHWoxRA5rbddzax7j+d0vSHHdeiPR1N6K5YzEQ8NhHTZkqE/LSnnHmYYLQ3jtbJW6uji9gzBpx4ZaNzQKDZ/K6Jykj0zECj7d3Q4q5F61YnvJdJjI060FM9nk31IpGRopCRN5ulvJc357kcjTTeS5ZIE95rv7GZDLyJQ2HiHbccKOTEU2UnYX5iCp5CUrySXsvUbC3htJ2Cuca5ojlIkkPA6JNHUWytdbdnpiLC0tUVMmqTmCQIb30DC8h4fDsQhLXu7O8L9vDP/7XUlFYOewhbVd2CZKTJ194ZTGNruEeW5i2j7Skv8InT5cGFqVAWpMUWF5tw9XeoqaUS7v9fEwnCrFRiFNCD+34ombh/t9uKEzoWsPDkpvmdHA4sOsflJUPwQvju7xq0b3+PuM7vFaows7nf/+z/863m2DoYUouHespPcO4Oo0EZjCxvSUKD5CBbt3/krNqYMtayAGZIlnxgP6DdlkszjULArpMKCRZI+kyizLBDnHN8zuMHkDzvI3arHbxiwb82WDCenw84aMrZyuQT+owgbb8j/QRC14GrhweHJ0iIQ/5A5lxWXTPNzv7OPRviDInJ1hJPKcHzojD5RTqaYsqhBqbc38vPk6rwk7N1ensEWGd0Xzdh23x0kkxNyQL2YUTieS2ogyc0urznBRarO/aFgM83TqltIsAVphhayTULUJseFUxIriByhD85lLaXJsyuxjWgOQ6FLf+GyslJ8Mrw6VPwOBxGj81AKD2wlhXOHJEcsJV+lRUiFn2zanSiMKnv1KZhbhqbSEf1ApWiqO8KMTRRcFld7CkahlXhYPRynu+l7DkQqe5X3LhLhlcnhryuH9b8rhNcrR6S4WpJoVWCRIJUfwfQUpJJebAvlElEhEcWjPXxaZ2XVW5a3t7IYqFqCXyFFsYGYLrKYq2SKzaRLvbexmuXjLzaZzvFSSRsNpkuRtLGc9SZoNp3u4RJIFllOX5K1MZx1JVlgOp49UDgM2YZopWooyP+EjOMseZXhHQoSU8PpXRDKmtY8ap0SB6QRGuC5mPcEOF1VOLFWa2G8mK1GP+ZZunn77VIpssKD+6VcZWOPHo2l0Vv7O1AQryVeeZCQezfpe/tJqHYKq+Xpn05Pdk1b+qQpCN+OYwq0xWStZ+o7J0vd6r+GlZmg32TKsQFsjsFbx9jyve7zfeT3nM0PtHb8e9bsyyiYyaAXoSfJve9ZkAnwzmkIJ+HI65RLNeAs2ZCbFBvmwqhRL+JFLpuGNaJCZ9m/AhVyl/SuIktUp2scpOixvd7ejR2bCbaBrq4RbRaDcaSCY7VZFPkKRu4dvzVvM5N5AO5fKXWCQrSY5Ngrb2f9OhMV/ylyXSHZrzfghjsFBp/zZ8MB8HfxybD8M/l4kw3+2Viyz/UNz/L+/bFheSTz8vkFIIzWxyhk4NtbtbUo8zJb4DbI5Daib6IiNiL3DTdmHb7u2r0DrbUE7/L7K0chArAx1z3hDr+usZoNtE6A2B6VZ23WWU6d3cOA5a/K+smHcwKM0DV1nGbJXEcEy29k2PitTw96OFfb2k1rro4HC1D3oLuRYrSKBvf1kr4N4G1bY2yrBemjXoIhtM/XvatOedlVdUU/M2HWcdYhGb4so766CyU6nxbQWJyZdTzYhxlTWk55XYrpU5+4oR7aItrLoUpK1uCsmVYXXLMkmdmFxYNakmmTWuO3Q1Mknb8QW2cZfVBE28keqg2hGcf9oGXfk9C5jiWyzX6jqfJk3Ug9Vbi8u7aK6iANye5GxPd4WV5H/0YxrGXEjg9X7brB6y4Zrs4+4c79/tL3fX/B1dxlw+t32az+Lxq+XMzPpbW8mPcgQQAEBpAiaYv7kW+g3PVS3Mm1+Fl2dhEPIoOWyFKAtSfY1HpsjMpvb22aPVUeJ7S69PaEAbT5Ht1rZvuf3e87ntsa+t1+/MS67GQo/dR/jV28O1v3WwsKB6cxeBBgSPnH6zlTryFz4NqIhZgRvLvCuNXM/YfJU9ff2SMTa+RE2E3sq4XbtZaV753/tHv3lp3sk6GWt+7a9tPV3F+fF1v1YhtD6AK0HuL+/560W/v7h9X3+gJ1+cZ0Z1VOR3IRo0wVTp+80vfeS/jlHPFQ+ptcjxjJcInbtBOX0+hwG5nXHdR6JZKgSeBpirjFkfCxwhpKLMJGwc9z22h6OCMOzJ7MRSG5kvDy/ddxK/yKi3I5WW8jJXvKS2sO6BRVBFDfZaVErvwrWQsbYVF2NEScrzWppdAPhq6yHhVfJYVVk1RIYS1o4zgrtFbOIBGOaCRVYLDMbuPvZXND5hz/gFyfmClH8eYpX0llYCnzCkUhBDDMM7xSVYmavKRNhKJ7Qrmnyrmnr69ev93zRTCWP7zky/gwq36eRVvDh/a1ls18NbtP7ElXb/rT6o/BOMUiulQRzI9nX6s2SX1Np0qsjFf5+j3ekFi6/xVsn7NV73F5OE0mzQ/h4e3sNA3NZZEIPo98QnRmtvwyuPl1nyMyXyVThp4t+GAfGmZhqyl6A6cJ+UkBgRIL0PSzeTxi/iRswUh+kbxudtbeYWlZkDRNOcqhE2rG5LkMXL/cdieA5HQZMn2AUa4cIC0sKk93gmlw9aXxgXt9eZoojntx4SGeEoR0ggUZI/W8soCRs5fPri3b8gE7Yms7AVquZT+Nre0mjxi3isxnhBTNM7kquXbxZtYiX/OLR3+9X/v1+5d/vV/7/eL9yEvRp+k3vRSFh9pIZaQJGG118dtLowskv7MTls59djPjFdaZCaaz78oIf19zJcD7HYnt5cv/zlzx2MEFIwBT+HWSXJS/0PDs3yV2+u/CKy5obxUoKCX82oUwY4y/HdR7oc/G+6PkXewAQUGmw2senZnUtvFi7irkUn314f+vM5/8DFJMxpQ==",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},g=void 0,b={},S=[];function C(e){const t={code:"code",p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Lookup Scottish Postcode"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/scotland/postcodes/{postcode}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"Lookup a Scottish postcode."}),"\n",(0,a.jsxs)(t.p,{children:["Returns Scottish Postcode Directory (SPD) data associated with the postcode. The response covers the full SPD field set: council area, electoral ward, Scottish and UK parliamentary geographies, health board, integration authority, data zone, intermediate zone, output area, locality, settlement, civil parish, island, national park, travel-to-work area, ITL/LAU, urban-rural classification, SIMD rank, ROA, census counts, and the corresponding GSS / official codes under the ",(0,a.jsx)(t.code,{children:"codes"})," object."]}),"\n",(0,a.jsx)(t.p,{children:"Top-level fields hold the latest (canonical) value for each datapoint. Year-suffixed fields surface prior versions where the SPD publishes them."}),"\n",(0,a.jsxs)(t.p,{children:["Returns ",(0,a.jsx)(t.code,{children:"404"})," if the postcode does not exist in SPD or is not valid."]}),"\n",(0,a.jsxs)(t.p,{children:["For postcodes not in SPD but present in ONSPD (i.e. non-Scottish postcodes), a ",(0,a.jsx)(t.code,{children:"404"}),' is returned with the error message "Postcode exists in ONSPD but not in SPD."']}),"\n",(0,a.jsx)(t.p,{children:"Source: Scottish Postcode Directory (National Records of Scotland)."}),"\n",(0,a.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(c(),{parameters:[{name:"postcode",in:"path",description:"Specifies the postcode you wish to query",required:!0,style:"simple",explode:!1,schema:{type:"string"}}]}),"\n",(0,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Scottish Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Scottish Postcode Directory (SPD) data for the requested postcode.",type:"object",required:["postcode","longitude","latitude","council_area","electoral_ward","health_board_area","data_zone","intermediate_zone","output_area","scottish_parliamentary_constituency","scottish_parliamentary_region","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"The Royal Mail postcode (e.g., AB10 1XG).",example:"AB10 1XG",pattern:"^[A-Z]{1,2}[0-9][A-Z0-9]? ?[0-9][A-Z]{2}$"},pc_compact:{title:"Compact Postcode",type:"string",description:"Postcode with all spaces removed.",example:"AB101XG"},outcode:{title:"Outward Code",type:"string",description:"First part of the postcode (before the space).",example:"AB10"},incode:{title:"Inward Code",type:"string",description:"Second part of the postcode (after the space).",example:"1XG"},postcode_district:{title:"Postcode District",type:"string",description:"Equivalent to the outward code.",example:"AB10"},postcode_sector:{title:"Postcode Sector",type:"string",description:"Outward code plus the first character of the inward code.",example:"AB10 1"},user_type:{title:"User Type",type:"string",nullable:!0,description:'SPD user-type indicator ("0" = small user, "1" = large user).',example:"0"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"Date the postcode was introduced (YYYYMM).",example:"198001"},date_of_deletion:{title:"Date of Deletion",type:"string",nullable:!0,description:"Date the postcode was deleted (YYYYMM). Null for live postcodes.",example:null},linked_small_user_postcode:{title:"Linked Small User Postcode",type:"string",nullable:!0,description:"For large-user postcodes, the linked small-user postcode (if any).",example:null},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude.",example:-2.1025},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude.",example:57.14945},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"OS National Grid easting (1m resolution).",example:393859},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"OS National Grid northing (1m resolution).",example:806073},split_indicator:{title:"Split Indicator",type:"string",nullable:!0,description:"SPD split indicator. Marks postcodes that span more than one administrative unit.",example:"0"},grid_link_indicator:{title:"Grid Link Indicator",type:"string",nullable:!0,description:"How the postcode was linked to its grid reference (1 = match by address, 2 = match by visual inspection, 3 = approximate match, etc.).",example:"1"},grid_link_positional_accuracy:{title:"Grid Link Positional Accuracy",type:"string",nullable:!0,description:"Positional accuracy of the grid reference.",example:"1"},council_area:{title:"Council Area",type:"string",nullable:!0,description:"2019 council area name. The current single-tier local authority.",example:"Aberdeen City"},electoral_ward:{title:"Electoral Ward",type:"string",nullable:!0,description:"2022 electoral ward name.",example:"Midstocket/Rosemount"},registration_district:{title:"Registration District",type:"string",nullable:!0,description:"2007 registration district code. (Names are not provided in SPD.)",example:"RD20"},enterprise_region:{title:"Enterprise Region",type:"string",nullable:!0,description:"2008 enterprise region name.",example:"Highlands and Islands"},strategic_development_planning_area:{title:"Strategic Development Planning Area",type:"string",nullable:!0,description:"2013 SDPA code. Names are not provided in SPD.",example:"SD01"},local_government_district:{title:"Local Government District",type:"string",nullable:!0,description:"1995 local government district name (the most recent boundary before unitary council areas).",example:"Aberdeen City"},local_government_district_1991:{title:"Local Government District (1991)",type:"string",nullable:!0,description:"1991 local government district name (historical).",example:"City of Aberdeen"},uk_parliamentary_constituency:{title:"UK Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"2024 UK Parliamentary constituency name.",example:"Aberdeen South"},scottish_parliamentary_region:{title:"Scottish Parliamentary Region (2025)",type:"string",nullable:!0,description:"2025 Scottish Parliamentary region name (Second Review of Scottish Parliament Boundaries, SSI 2025/285, effective at the 7 May 2026 Holyrood election). This is the current designation.",example:"North East Scotland"},scottish_parliamentary_region_2021:{title:"Scottish Parliamentary Region (2021)",type:"string",nullable:!0,description:"2021 Scottish Parliamentary region name (superseded by the 2025 designation).",example:"North East Scotland"},scottish_parliamentary_constituency:{title:"Scottish Parliamentary Constituency (2025)",type:"string",nullable:!0,description:"2025 Scottish Parliamentary constituency name (Second Review of Scottish Parliament Boundaries, SSI 2025/285, effective at the 7 May 2026 Holyrood election). This is the current designation.",example:"Aberdeen Central"},scottish_parliamentary_constituency_2021:{title:"Scottish Parliamentary Constituency (2021)",type:"string",nullable:!0,description:"2021 Scottish Parliamentary constituency name (superseded by the 2025 designation).",example:"Aberdeen Central"},health_board_area:{title:"Health Board Area (2019)",type:"string",nullable:!0,description:"2019 NHS health board area name. Current operational boundary.",example:"Grampian"},health_board_area_2006:{title:"Health Board Area (2006)",type:"string",nullable:!0,description:"2006 health board area name (historical).",example:"Grampian"},health_board_area_1995:{title:"Health Board Area (1995)",type:"string",nullable:!0,description:"1995 health board area name (historical).",example:"Grampian"},integration_authority:{title:"Integration Authority (2019)",type:"string",nullable:!0,description:"2019 health and social care integration authority name.",example:"Aberdeen City"},output_area:{title:"Output Area (2022)",type:"string",nullable:!0,description:"2022 census Output Area code. The smallest census geography.",example:"S00136537"},output_area_2011:{title:"Output Area (2011)",type:"string",nullable:!0,description:"2011 census Output Area code.",example:"S00088970"},output_area_2001:{title:"Output Area (2001)",type:"string",nullable:!0,description:"2001 census Output Area code.",example:"S00000700"},output_area_1991:{title:"Output Area (1991)",type:"string",nullable:!0,description:"1991 census Output Area code.",example:null},data_zone:{title:"Data Zone (2022)",type:"string",nullable:!0,description:"2022 Data Zone name. Scottish equivalent of LSOA.",example:"West End North - 01"},data_zone_2011:{title:"Data Zone (2011)",type:"string",nullable:!0,description:"2011 Data Zone code.",example:"S01006571"},data_zone_2001:{title:"Data Zone (2001)",type:"string",nullable:!0,description:"2001 Data Zone code.",example:"S01000125"},intermediate_zone:{title:"Intermediate Zone (2022)",type:"string",nullable:!0,description:"2022 Intermediate Zone name. Scottish equivalent of MSOA.",example:"West End North"},intermediate_zone_2011:{title:"Intermediate Zone (2011)",type:"string",nullable:!0,description:"2011 Intermediate Zone code.",example:"S02000007"},intermediate_zone_2001:{title:"Intermediate Zone (2001)",type:"string",nullable:!0,description:"2001 Intermediate Zone code.",example:"S02000017"},locality:{title:"Locality (2022)",type:"string",nullable:!0,description:"2022 Settlement-and-Locality locality name.",example:"Aberdeen"},locality_2020:{title:"Locality (2020)",type:"string",nullable:!0,description:"2020 locality name (historical).",example:"Aberdeen"},locality_2001:{title:"Locality (2001)",type:"string",nullable:!0,description:"2001 locality name (historical).",example:"Aberdeen"},locality_1991:{title:"Locality (1991)",type:"string",nullable:!0,description:"1991 locality name (historical).",example:null},settlement:{title:"Settlement (2022)",type:"string",nullable:!0,description:"2022 settlement name.",example:"Aberdeen, Milltimber, and Peterculter"},settlement_2020:{title:"Settlement (2020)",type:"string",nullable:!0,description:"2020 settlement name (historical).",example:"Aberdeen Settlement"},settlement_2001:{title:"Settlement (2001)",type:"string",nullable:!0,description:"2001 settlement name (historical).",example:"Aberdeen Settlement"},civil_parish:{title:"Civil Parish (1930)",type:"string",nullable:!0,description:"1930 Scottish civil parish name (the latest historical baseline; civil parishes were abolished as administrative units in 1975).",example:"Old Machar"},island:{title:"Island",type:"string",nullable:!0,description:'Island name where the postcode is located. "Mainland of Scotland" for non-island postcodes.',example:"Mainland of Scotland"},national_park:{title:"National Park (2010)",type:"string",nullable:!0,description:"2010 national park name (Cairngorms / Loch Lomond and the Trossachs). Null for non-park postcodes.",example:null},travel_to_work_area:{title:"Travel to Work Area (2011)",type:"string",nullable:!0,description:"2011 Travel to Work Area name.",example:"Aberdeen"},lau_level_1:{title:"Local Administrative Unit Level 1 (2025)",type:"string",nullable:!0,description:"2025 LAU level 1 name. Replaces the previous NUTS classifications.",example:"Aberdeen City"},itl_level_2:{title:"International Territorial Level 2 (2025)",type:"string",nullable:!0,description:"2025 ITL level 2 name. Mid-tier UK statistical geography (replaces NUTS 2).",example:"North Eastern Scotland"},itl_level_3:{title:"International Territorial Level 3 (2025)",type:"string",nullable:!0,description:"2025 ITL level 3 name. The most granular ITL geography (replaces NUTS 3).",example:"Aberdeen City and Aberdeenshire"},urban_rural_6_fold:{title:"Urban-Rural Classification (6-fold, 2022)",type:"string",nullable:!0,description:"2022 Scottish Government 6-fold urban-rural classification code:\n\n* 1: Large Urban Areas\n* 2: Other Urban Areas\n* 3: Accessible Small Towns\n* 4: Remote Small Towns\n* 5: Accessible Rural\n* 6: Remote Rural\n",example:"1"},urban_rural_8_fold:{title:"Urban-Rural Classification (8-fold, 2022)",type:"string",nullable:!0,description:'2022 Scottish Government 8-fold urban-rural classification code (1\u20138). Splits "Remote" categories into "Remote" and "Very Remote".',example:"1"},scottish_index_of_multiple_deprivation:{title:"Scottish Index of Multiple Deprivation (2020)",type:"integer",format:"int32",nullable:!0,description:"SIMD 2020 rank for the postcode's Data Zone (1 = most deprived, 6976 = least deprived).",example:6414},roa_community_planning_partnership:{title:"Community Planning Partnership (ROA 2006)",type:"string",nullable:!0,description:"2006 Community Planning Partnership name (Regional Outcome Agreement geography).",example:"Aberdeen City"},roa_local:{title:"Local Authority (ROA 2006)",type:"string",nullable:!0,description:"2006 Regional Outcome Agreement local authority name.",example:"Aberdeen City"},census_household_count:{title:"Census Household Count (2022)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded against this postcode at the 2022 census. May be 0 for empty or zero-suppressed postcodes.",example:0},census_household_count_2011:{title:"Census Household Count (2011)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded at the 2011 census.",example:8},census_household_count_2001:{title:"Census Household Count (2001)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded at the 2001 census.",example:12},census_household_count_1991:{title:"Census Household Count (1991)",type:"integer",format:"int32",nullable:!0,description:"Number of households recorded at the 1991 census.",example:null},census_population_count:{title:"Census Population Count (2022)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded against this postcode at the 2022 census.",example:0},census_population_count_2011:{title:"Census Population Count (2011)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded at the 2011 census.",example:18},census_population_count_2001:{title:"Census Population Count (2001)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded at the 2001 census.",example:26},census_population_count_1991:{title:"Census Population Count (1991)",type:"integer",format:"int32",nullable:!0,description:"Resident population recorded at the 1991 census.",example:null},never_digitised:{title:"Never Digitised",type:"boolean",description:"True if the postcode has never been digitised (no grid reference established).",example:!1},codes:{title:"Codes",type:"object",description:"GSS / official codes for the corresponding name fields above.",properties:{council_area:{title:"Council Area Code (2019)",type:"string",nullable:!0,description:"9-character GSS code for the 2019 council area.",example:"S12000033"},electoral_ward:{title:"Electoral Ward Code (2022)",type:"string",nullable:!0,description:"9-character GSS code for the 2022 electoral ward.",example:"S13002841"},enterprise_region:{title:"Enterprise Region Code (2008)",type:"string",nullable:!0,description:"Code for the 2008 enterprise region.",example:"S99999999"},local_government_district:{title:"Local Government District Code (1995)",type:"string",nullable:!0,description:"Code for the 1995 local government district.",example:"S12000033"},local_government_district_1991:{title:"Local Government District Code (1991)",type:"string",nullable:!0,description:"Code for the 1991 local government district.",example:"S99999999"},uk_parliamentary_constituency:{title:"UK Parliamentary Constituency Code (2024)",type:"string",nullable:!0,description:"9-character GSS code for the 2024 UK Parliamentary constituency.",example:"S14000061"},scottish_parliamentary_region:{title:"Scottish Parliamentary Region Code (2025)",type:"string",nullable:!0,description:"9-character GSS code for the 2025 Scottish Parliamentary region (current designation).",example:"S17000026"},scottish_parliamentary_region_2021:{title:"Scottish Parliamentary Region Code (2021)",type:"string",nullable:!0,description:"9-character GSS code for the superseded 2021 Scottish Parliamentary region.",example:"S17000014"},scottish_parliamentary_constituency:{title:"Scottish Parliamentary Constituency Code (2025)",type:"string",nullable:!0,description:"9-character GSS code for the 2025 Scottish Parliamentary constituency (current designation).",example:"S16000151",pattern:"^S[0-9]{8}$"},scottish_parliamentary_constituency_2021:{title:"Scottish Parliamentary Constituency Code (2021)",type:"string",nullable:!0,description:"9-character GSS code for the superseded 2021 Scottish Parliamentary constituency.",example:"S16000074",pattern:"^S[0-9]{8}$"},health_board_area:{title:"Health Board Area Code (2019)",type:"string",nullable:!0,description:"9-character GSS code for the 2019 NHS health board area.",example:"S08000020"},health_board_area_2006:{title:"Health Board Area Code (2006)",type:"string",nullable:!0,description:"GSS code for the 2006 health board area.",example:"S08000006"},health_board_area_1995:{title:"Health Board Area Code (1995)",type:"string",nullable:!0,description:"Code for the 1995 health board area.",example:"0"},integration_authority:{title:"Integration Authority Code (2019)",type:"string",nullable:!0,description:"9-character GSS code for the 2019 integration authority.",example:"S37000002"},data_zone:{title:"Data Zone Code (2022)",type:"string",nullable:!0,description:"GSS code for the 2022 Data Zone.",example:"S01013550"},data_zone_2011:{title:"Data Zone Code (2011)",type:"string",nullable:!0,description:"GSS code for the 2011 Data Zone.",example:"S01006571"},data_zone_2001:{title:"Data Zone Code (2001)",type:"string",nullable:!0,description:"Code for the 2001 Data Zone.",example:"S01000125"},intermediate_zone:{title:"Intermediate Zone Code (2022)",type:"string",nullable:!0,description:"GSS code for the 2022 Intermediate Zone.",example:"S02002527"},intermediate_zone_2011:{title:"Intermediate Zone Code (2011)",type:"string",nullable:!0,description:"GSS code for the 2011 Intermediate Zone.",example:"S02000007"},intermediate_zone_2001:{title:"Intermediate Zone Code (2001)",type:"string",nullable:!0,description:"Code for the 2001 Intermediate Zone.",example:"S02000017"},locality:{title:"Locality Code (2022)",type:"string",nullable:!0,description:"Code for the 2022 locality.",example:"S19000001"},settlement:{title:"Settlement Code (2022)",type:"string",nullable:!0,description:"Code for the 2022 settlement.",example:"S20000001"},civil_parish:{title:"Civil Parish Code (1930)",type:"string",nullable:!0,description:"Code for the 1930 civil parish.",example:"S07000001"},island:{title:"Island Code",type:"string",nullable:!0,description:"Island identifier code.",example:"S20000001"},national_park:{title:"National Park Code (2010)",type:"string",nullable:!0,description:"Code for the 2010 national park.",example:null},travel_to_work_area:{title:"Travel to Work Area Code (2011)",type:"string",nullable:!0,description:"Code for the 2011 Travel to Work Area.",example:"S22000047"},lau_level_1:{title:"LAU Level 1 Code (2025)",type:"string",nullable:!0,description:"Code for the 2025 LAU level 1 area.",example:"TLM50"},itl_level_2:{title:"ITL Level 2 Code (2025)",type:"string",nullable:!0,description:"Code for the 2025 ITL level 2 area.",example:"TLM5"},itl_level_3:{title:"ITL Level 3 Code (2025)",type:"string",nullable:!0,description:"Code for the 2025 ITL level 3 area.",example:"TLM50"},registration_district:{title:"Registration District Code (2007)",type:"string",nullable:!0,description:"Code for the 2007 registration district.",example:"RD20"},strategic_development_planning_area:{title:"SDPA Code (2013)",type:"string",nullable:!0,description:"Code for the 2013 strategic development planning area.",example:"SD01"},roa_community_planning_partnership:{title:"Community Planning Partnership Code (ROA 2006)",type:"string",nullable:!0,description:"Code for the 2006 community planning partnership.",example:"S12000033"},roa_local:{title:"ROA Local Code (2006)",type:"string",nullable:!0,description:"Code for the 2006 ROA local authority.",example:"S12000033"}}}},title:"ScottishPostcodes"}}}}}},404:{description:"Postcode not found"}}})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(C,{...e})}):C(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/4e6ae29d.268c2aa1.js b/build/assets/js/4e6ae29d.268c2aa1.js
deleted file mode 100644
index b437c987f..000000000
--- a/build/assets/js/4e6ae29d.268c2aa1.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[9667],{9342(e,t,i){i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>C,frontMatter:()=>f,metadata:()=>a,toc:()=>S});const a=JSON.parse('{"id":"api/lookup-postcode","title":"Lookup Postcode","description":"### Postcode Data","source":"@site/docs/api/lookup-postcode.api.mdx","sourceDirName":"api","slug":"/api/lookup-postcode","permalink":"/docs/api/lookup-postcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"lookup-postcode","title":"Lookup Postcode","description":"### Postcode Data","sidebar_label":"Lookup Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJztPG1TGzmTf6Vr8gFzZxvbQBJ8X44QlmWXt8NQ3D4hBfJM29ZGI81KGogvRdXzI55feL/kqqUZe2b8AnZCru7q2ardxR5Nq7vV793Wt8CyoQm6n4ILZWyoIjTB53qgEtTMciWPo6AbnCj1JU3yBUE9iNCEmie0IOgGb968gfwhfGSW3cpb6d8BBte/Q5I/ZEPGpbFgRwjnZ73CW1xjaJUeQ+38rHfxcbMJVyMEjSZR0iBwAwwGqRBj+k6JB4xAY6h0BP/9938APqAeA4tiLrmxhPkD1gGFg8lEHYxllhvLQyaAyQhGyIQdwRDVULNkNAY7Yhbc1mBGPDEwUNqhOcGdG9BoUy0xAuZJsCoBgQ8ooD8Gbg2M0pjJhkYWsb5AkCzGOjxyO3LL8a+UPzCB0sJRrwdboAYDHnImwPEdYq610hhBKiP0u9+7J/eg+n9iaJvEWOKLYTGCGbGkjFZ/DPdbOcLmHmr9VHyBfwWDTIejTUe5dWx9QG2wMUQVqojLIaCMEsWlNU2431JpDsBDJt4bTJhmFuvAhkONQ2Yxgk/nfuXn2hvLhlvnqX1kOmoc0MubGX50PEoiaPUICWpQfpEjOeONOzfYgoRpbkawBaGSxnKbogzHwLRmYwMmjWN6TtgWz8UAl4ZH6HhzmeF7v9PauQc+KJ9gpNCAVBbwKzcWlCbm0ecHJnjUvJVBPSAqY7SoSSe+BXSCQTdIpqLPSeITZkczajARZquIcZrjA72g6dg1RkHX6hTrgbFjQTANjxNBC/BrIgh2d8CEoQXhCGMWdL8Fllu3dKHmFbf8K0U9duCYA9wNejftfejs7wdPT58JD69LhiB3Wi36XxlaLw1DNCaoB6GSFqWlJSxJBA+dLdj609C6b0swhMtsl6Ae2HFCj7zolhjxKSB9TI370qTCkslJNBkdyz2C2QLawoPh0uIQdVAPBkrHzPqvtjtEsUzjoPup02p9fppAnKHuQMWJxhFKwx8QhPI0QcQsAy5DkTpFyC0CDyFUSkdcMoumXrEt0FepjJjm7pGMpqYGuPT4EezchhDlaEhjCoK0jD2FZZkyOsnL/vgrZYJbd9bMWC6HxEiptB1lf4cqldYJgxyZuxEL6oHD/849GE8+RkQQd7v7L0gzg3oglBxym7rNBLP5nwnTgrMYpWV6fFdUUkIlpfNj8m7CijuNQ2I9HS2P3StM453VqfH05k+d2tNWRhGqsf9fiIRKGA6JjNR6ujL3VJaVCbfmq0zGaCJVDmdUqOie/Ml1odPYgXDENAvtjMViYBIWoj92BtuN6UIuJ+ughs1hsw65Cm424TqJnNGMlbQjMYaBVjFcqjETcMq4aC5Q3akEFKjLLC0cvIRCchgDro0lA2tBDYBNSe7jQGl0UuroglqJeOMcMTcwRImakf/lEUrLBxzNxLoyAVY9SrKouUjNkkOkZCJcoORYrkaIwVDJaB4lbGAzp5kRwsQjOY7tMjW/okhMTsQYTIIhH/AQjNWI1hAN/ZQLMgbGuScus10odNDIypS1/RnlKlmWQE6IMwH/4Z/CsYzIlCo9JXVq1mYs+8K3odZu7G02oTdSj/4QvLUkhtAnZgwfUjww1JzCpAFqlCF2yUP+C7S7cOPJorU5rfm7MbPhiCKcKNJoDIRCGaSITZV9aYzMQet0Yd8HS+064NcQE0thyAM3qTOGxF9nC9UATpiMBJe0SWKg1guVFaRFSorxJgHb7sJ+kmj1lcfMOqeWHcBuC2K0Gg2t2ulO48ZUcutwgRp7QM2GGHnFyvBHf4Y+YMqRd3vtduHQWLeRC5woHE1ddGFSrcm809+TKINeeVvY2Dgjl20dMy7FGC7O4YP6isbBf9+FK9Sx8x9Tuw81wYyFL5LUhbYsH5F7c68LZ6rofYA9MC4oonQhykT42k8FD1CQvMOpV3jeecpUONB5eDKrcudVLCHbFGr/2ZiiuUnn1fbn5IP0lIA04RKFoyIToQ+aWwrzzlgm30cEnCTo6MMkQj3W85eckZdDLeFYI8lOE264ENBHIDrckoMRkxIFHBtaYBzIYyOQJPCUyZL67m63Wjvvnores8DHs4JLfR1G5ttC7Y//45xsv9vb2yWBzGOPAh8PJuHI8/b9+vdC9G8hg5ZFUtwUFOlQDgmtOuR2pA43TFBAViWtXqWkTla+QMlm2aZnkMmuZ/FTgZgehYA45CH86nPI/dSOlPbxWJW+52Xi7NdenoyyHJBzM7Mkl5E8UTJSknAshXZVtq+HVSXa9bDnYASnbEwig3GSPSfUvc1VaXZ844bPkYtAVVl6gikdk5i0QMnHaZz63bTk8EkEyHswKhxMOP8M02/Q2JgqGKinGLuguYDtjQ+iV8d0EjlvVXB2IdIzqPVsE35jMZoNQ6hNQ/gCZieFuD5DT6Zxv2zPIpX2XV66HOGbo977HZhsU/BXUCP/0HiksCHJwpjNiag468IHlGhNcrBUTjxciahGq9nuvHtLBnqShhTJmaYmP4iaDGCJGGejG0aldvSd5Oy2m7ut7d0dMpNLcqmiKE3lDS6Kb8BBOftaXdiuf69ALBVdnhG2A065l4vpnBlyrqGiHIsTwmKoki2Cw0kCfekWQe3w8HJzLcoWw3yxSZ2TsBYje/8UDphGuKKnULs4uFoPW2/8aaOqpVrgBeAjH7j4wVJ9kYKHUMkHSmcUVeqSRIyBhVoZQ2fsWW6WmrHZY7nMc/PV6fHAmIAIKQspFkJK7ps0FLUYw5F6QC1JCuGc6qGYnZZLxY7OL83mwlPyhYPiybhvtg5UHJNtX08zQv7ARV6MzMOMTcImzOFCzYUamyv4izqk0sOk7Eojc1aaSh0lA/2IGk7YGDX0UiqXnqc2SS3s0wurEtNpddpwgNKkBk565/tZZcLETAjU5Zq4RlYHO07okxhDu95qtRrt+m6rRRGoS5cpez6jKq4rFFMQ6jagAtpCqqHVfn9AlMYVSk95FAl8FVJPp6TGPGoY/l+4lNZdR+s7+u9300qkUuFqJgwrGKPvimayUGxab4z4Aze5jpGwktRO0tY5Uf20cJ5HaayallBlXIKiIHqRDSFwT748V6RVcOl4TBrIDeFFBupIqzRZmVwKjZcBzLtDnFotjjLBpHtcsKkG9QMPXZcAMlUuHyDt4hIG57+gYF0GlQq3INv0i9IhriejV65+4qAMHJSXhPmnaLWityyT4HEg5KiUeKcGd1xaraI0tBUD/pFCFzWA4+LzdRCOXCGmWPl5ZMRMDxYj4usff/zxx+lpVj2tlMf23rda7SLGNiuKLED4qvD4x+Frp5WYGXzhLNcMQV53qjpzxJ3LCL8SFXEqLE8E3kWYaP4wQ84xLXTZZbYQPhYWfn85gUpHS/eA2vHpx03QTH6ZFbEN7w+a4P0NLTIQKu0VKiJzF1NV2BOX+SvThEnKnSXakwoe/VvNuiGlvq2MMEFJJhWOTz+CCelN1xR8YCKl2pZG14OLXAdYUBwaUxOOlDoLY3wRgFeOpL3zfmd7aSR912l1dlYPp6FG760Xza0YVUOfGaQCKPyWijH5mJ1Ca2n1mNugxChamE703GM4GMc6/f4MogStdoPCjArEbz6XUMA51Uyz9iKdtlXggUxU8N+810Jh8HGEGuep5ByS76R6EdVwlqeLP6K6txI7fKL6elyhutVsWE++LtNh+I4QfxbMCwmZDU8WRPbWPpac75VmVEEiXij9ZX33OwfOPNSvrm72vWXKylnEZogVFTRQkaXtKzvy/oKY8Kj0l0WkyKzyepcw/aV0GHlJ9oIerHUORQgVwzJgQuT9qzoVKJgczxOUflpi9IeUC9tIk/VZXILgTGlnXpo0XedZTMx2AvU44uEIRsxAH1HCBtd+WoX3xRhS3WeSG4w2yuw+0sjIqE/ZzsN+2R9bHGoXALis/YNat0hHwj8X2kw4WohCJ5Gp67pxM6eRODcOnb+TSzKYDFHfMSE4/VUKwt0j2M8frUNlBca8A6wsMdDXbjZHDdElDkRQotUDj1D73kE4ieHpG6uAx7QAwRMDxKoyUy5PSbatW18r8GUzT57b7RenzySL7fbqbp3emsmim7AvOJtOiW0QMhsw4CiiJhzLaWjkuMZ9m5Zm4+BvSmKdBGEmYKIlPUrOHb4vy6nLDFieVf8IDpwu5ED8Eg6QPOsYI05hOnHi2WyaGNtZ7ZQ7a9E4p1byU0+ys+JJfi+Vp89TufppVcn4wTgXwTk31/DjD66iZSyEftlkrLPS12u1Wq2d9vtdV/RMw7LuXKaaicY1eRg4EDRDMcjm3tbVGzKkRd1ZssMzVQD/Tsz+dEVISW7Q7eHp6KxAxzon4OnovC4dApOKllPZ55AkMNHc4MQRjHgCtawEvx4tWXUflm4xx+OdHF74QCWZrqMwxT5SpCIctLyVSKkaqVOfZkrcIMqiAFFg0nk54T03/7Q26SZ/fUXiXQjJbSmsBCrcC5Yk5PZPDi+yKsG8bITG9yrRmM4DYyr5aG6VpkHoE+oUG6gdX52sTmCvUOSdTnbnk31UtCrs6ssM3FCjYdqMOLu+6kEDzlSMMhTMptpVpa4lTXcTkCKyk/3Mpps+3nfZ+W9MpsRg0pg6DJQQ6pE49EHjV27rfgsqSmlMBAv99NHx1QnUnmPLJmRDW9e/N2/lLzSpxsIv2cxhnDDL+5wmxeqTMSXT5DRJJC2XqZ8bySIyf7pu9nU6bH7rDuo28E7cTa8v7Rv5cczCue6XG1huDnzOpGt1Llda+lWAQ4Hm4muFjlDxSHu+lLuZTcu7aYPZjpmhwr3FLuSz4BsXBtNI+bc28sHMk73sn3mTLnU4LT0ujIrU4az0aHbWpFd6nvvVzeJ0hEsnmZ/acz96mEpreUa9SQVw4oNQNHFiRioVEYxojs5VOQ1mzGAGNs6UpfG5LN/eAM1cHG5HTIKlBCkbnY9ptRt5h+OPTl/L47TPz2G4Y1owsvlM3TL/xcNeYW6WoE201KdH82c2qu58jxz69vbzQzA/G2GPRwXdXC6WT478bFQJhypfd1vt7fett8t6rK+Opt+4gtnOdqvV6mw7zKqtp4OjV8dpWTeqgun2e8J0N8f0jkdVZI8/ru7gRkpbj9NkCluvg95N53r7b/N6lYcfX5+Ji/qhS9RlJoC4OvlOHMs4PeN555Rrrk6OtzsufGNpOXzbv+6sh5uPyCo+lCKP7DdmnaoizyBVsogzswWU77324VbT6Cp+bZq39fo7MxHws/E7nYNfp9Vq7b17N6//+8vrYzfTY66g1yHzl/VTXzZAtqTL9erELGmwzet2bRYrSj54faa1V+FOe6fVar3d3lvOnZmm4AtYtG5H8Ps5tUJ/sET/4v5P1rB57dOf7RFVXbkT5db23HbP1c3+etjNa/DMliEOnR51tnde3qB5fYYVd1u1U7MeZnNbNfO4tUNW+/3beX2Vgw+vzpm5PZAKirtOnDrvVmuNvH6sU96vivRbpwJ7C5oZ5A9d+fD1nWK5wzFriAm7Z1x5pRHxv4L86Vzk4znIF/z8nAaDR77zM5BfKVzqzOPxT0bzmahpWQPAg1kHz2U9gB9U4/dytB5yLyrxz+K63161gP9jOLgGkjPV+cOLaRH+deXvZfX6qst6R3Kw255bYCfcp3X018b+ZSX3WY//9ESRUfXn7E/+n3rwtUGfe+4Nf1eFYHIYdIORtYn73X4fBbVcLk+CemBUqskVuqemu7XFEt5MClXi6bUhW/Rj7c7+/i11JyZQQw8nh3pwclyEGqZaQOMIGl/g9vZWNhr0eePle23QZp/rQYx2pOjGmSFadzOAHQXdoLD+W/7nE22P+iG/qCPVYgl1M0Xn/YtjV092w14PTHM6ZSoxuKsy6A4Hkhg3d+LWt983W80WMYBTj9EFFdndIKfHV0G9sr9KUHrmNJUebmUvmS1aWzhVwuJyMnXdKJXtSRpRx+Z8kNW9C+BLzIxUaCY7LLwhxHUC/C06GgvTscJf00OYUKjub4SZFJWyVsOtfPMGDrMrYlynQ4jpZHXIJA2YM3d5SP77a3p32vvIr5dxsO7v72/lopPKHvtrbhxWIf2m3MDR4ZXD8OK8d5VfqGGa/qMXG+MmTrOrS2i+H+G+envJfU5Nfk+Joc+HLBxN7xoKVZz/bJxJmmDTKtGuBf7r1dWFa0mkJr/lwf/inbj1W+/87GKCmb/AyE3A0tUi1EBtuWXGX7JSh53sCwZ9FuXv0dc77mvqAQwo1XNU7+ZvO5kFpIuC/BVJMzjRIQuj8o2jvGk0oa+vonHOBvrxKhUSPYvoy5LATLoR2eUkrr05Xe+vzCGOM98owJhx0gOTJonS9t95hEw0pucbqmZKs26Z6vT8shn1mfvaVgY0IOtHz2ImC2qY3Te16Kqcb9M7bf55X9U/76v6f3NfVRaxWPxqtxLBuBspcNr0LXOf09uEyDt0J5flfK4HI0U/bPwUfPtGdaZrLZ6e6Gt/k1T30+epa3Q+NuKG/o4mN1Ut1LDaZXaZ0SYsuBVrLt7Zl0yOnVcWKX0K6sEXHBcv4Xqia55GyCLUDi//eN85isKLMzdXlSKMo8Or4OnpfwBu3i9B","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Postcodes","permalink":"/docs/api/postcodes"},"next":{"title":"Autocomplete Search a Postcode","permalink":"/docs/api/postcode-lookup"}}');var o=i(31325),n=i(31736),r=i(47812),l=i.n(r),s=i(38616),d=i.n(s),c=i(67994),p=i.n(c),u=i(54768),h=i.n(u),m=(i(24909),i(96847),i(78121));const f={id:"lookup-postcode",title:"Lookup Postcode",description:"### Postcode Data",sidebar_label:"Lookup Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJztPG1TGzmTf6Vr8gFzZxvbQBJ8X44QlmWXt8NQ3D4hBfJM29ZGI81KGogvRdXzI55feL/kqqUZe2b8AnZCru7q2ardxR5Nq7vV793Wt8CyoQm6n4ILZWyoIjTB53qgEtTMciWPo6AbnCj1JU3yBUE9iNCEmie0IOgGb968gfwhfGSW3cpb6d8BBte/Q5I/ZEPGpbFgRwjnZ73CW1xjaJUeQ+38rHfxcbMJVyMEjSZR0iBwAwwGqRBj+k6JB4xAY6h0BP/9938APqAeA4tiLrmxhPkD1gGFg8lEHYxllhvLQyaAyQhGyIQdwRDVULNkNAY7Yhbc1mBGPDEwUNqhOcGdG9BoUy0xAuZJsCoBgQ8ooD8Gbg2M0pjJhkYWsb5AkCzGOjxyO3LL8a+UPzCB0sJRrwdboAYDHnImwPEdYq610hhBKiP0u9+7J/eg+n9iaJvEWOKLYTGCGbGkjFZ/DPdbOcLmHmr9VHyBfwWDTIejTUe5dWx9QG2wMUQVqojLIaCMEsWlNU2431JpDsBDJt4bTJhmFuvAhkONQ2Yxgk/nfuXn2hvLhlvnqX1kOmoc0MubGX50PEoiaPUICWpQfpEjOeONOzfYgoRpbkawBaGSxnKbogzHwLRmYwMmjWN6TtgWz8UAl4ZH6HhzmeF7v9PauQc+KJ9gpNCAVBbwKzcWlCbm0ecHJnjUvJVBPSAqY7SoSSe+BXSCQTdIpqLPSeITZkczajARZquIcZrjA72g6dg1RkHX6hTrgbFjQTANjxNBC/BrIgh2d8CEoQXhCGMWdL8Fllu3dKHmFbf8K0U9duCYA9wNejftfejs7wdPT58JD69LhiB3Wi36XxlaLw1DNCaoB6GSFqWlJSxJBA+dLdj609C6b0swhMtsl6Ae2HFCj7zolhjxKSB9TI370qTCkslJNBkdyz2C2QLawoPh0uIQdVAPBkrHzPqvtjtEsUzjoPup02p9fppAnKHuQMWJxhFKwx8QhPI0QcQsAy5DkTpFyC0CDyFUSkdcMoumXrEt0FepjJjm7pGMpqYGuPT4EezchhDlaEhjCoK0jD2FZZkyOsnL/vgrZYJbd9bMWC6HxEiptB1lf4cqldYJgxyZuxEL6oHD/849GE8+RkQQd7v7L0gzg3oglBxym7rNBLP5nwnTgrMYpWV6fFdUUkIlpfNj8m7CijuNQ2I9HS2P3StM453VqfH05k+d2tNWRhGqsf9fiIRKGA6JjNR6ujL3VJaVCbfmq0zGaCJVDmdUqOie/Ml1odPYgXDENAvtjMViYBIWoj92BtuN6UIuJ+ughs1hsw65Cm424TqJnNGMlbQjMYaBVjFcqjETcMq4aC5Q3akEFKjLLC0cvIRCchgDro0lA2tBDYBNSe7jQGl0UuroglqJeOMcMTcwRImakf/lEUrLBxzNxLoyAVY9SrKouUjNkkOkZCJcoORYrkaIwVDJaB4lbGAzp5kRwsQjOY7tMjW/okhMTsQYTIIhH/AQjNWI1hAN/ZQLMgbGuScus10odNDIypS1/RnlKlmWQE6IMwH/4Z/CsYzIlCo9JXVq1mYs+8K3odZu7G02oTdSj/4QvLUkhtAnZgwfUjww1JzCpAFqlCF2yUP+C7S7cOPJorU5rfm7MbPhiCKcKNJoDIRCGaSITZV9aYzMQet0Yd8HS+064NcQE0thyAM3qTOGxF9nC9UATpiMBJe0SWKg1guVFaRFSorxJgHb7sJ+kmj1lcfMOqeWHcBuC2K0Gg2t2ulO48ZUcutwgRp7QM2GGHnFyvBHf4Y+YMqRd3vtduHQWLeRC5woHE1ddGFSrcm809+TKINeeVvY2Dgjl20dMy7FGC7O4YP6isbBf9+FK9Sx8x9Tuw81wYyFL5LUhbYsH5F7c68LZ6rofYA9MC4oonQhykT42k8FD1CQvMOpV3jeecpUONB5eDKrcudVLCHbFGr/2ZiiuUnn1fbn5IP0lIA04RKFoyIToQ+aWwrzzlgm30cEnCTo6MMkQj3W85eckZdDLeFYI8lOE264ENBHIDrckoMRkxIFHBtaYBzIYyOQJPCUyZL67m63Wjvvnores8DHs4JLfR1G5ttC7Y//45xsv9vb2yWBzGOPAh8PJuHI8/b9+vdC9G8hg5ZFUtwUFOlQDgmtOuR2pA43TFBAViWtXqWkTla+QMlm2aZnkMmuZ/FTgZgehYA45CH86nPI/dSOlPbxWJW+52Xi7NdenoyyHJBzM7Mkl5E8UTJSknAshXZVtq+HVSXa9bDnYASnbEwig3GSPSfUvc1VaXZ844bPkYtAVVl6gikdk5i0QMnHaZz63bTk8EkEyHswKhxMOP8M02/Q2JgqGKinGLuguYDtjQ+iV8d0EjlvVXB2IdIzqPVsE35jMZoNQ6hNQ/gCZieFuD5DT6Zxv2zPIpX2XV66HOGbo977HZhsU/BXUCP/0HiksCHJwpjNiag468IHlGhNcrBUTjxciahGq9nuvHtLBnqShhTJmaYmP4iaDGCJGGejG0aldvSd5Oy2m7ut7d0dMpNLcqmiKE3lDS6Kb8BBOftaXdiuf69ALBVdnhG2A065l4vpnBlyrqGiHIsTwmKoki2Cw0kCfekWQe3w8HJzLcoWw3yxSZ2TsBYje/8UDphGuKKnULs4uFoPW2/8aaOqpVrgBeAjH7j4wVJ9kYKHUMkHSmcUVeqSRIyBhVoZQ2fsWW6WmrHZY7nMc/PV6fHAmIAIKQspFkJK7ps0FLUYw5F6QC1JCuGc6qGYnZZLxY7OL83mwlPyhYPiybhvtg5UHJNtX08zQv7ARV6MzMOMTcImzOFCzYUamyv4izqk0sOk7Eojc1aaSh0lA/2IGk7YGDX0UiqXnqc2SS3s0wurEtNpddpwgNKkBk565/tZZcLETAjU5Zq4RlYHO07okxhDu95qtRrt+m6rRRGoS5cpez6jKq4rFFMQ6jagAtpCqqHVfn9AlMYVSk95FAl8FVJPp6TGPGoY/l+4lNZdR+s7+u9300qkUuFqJgwrGKPvimayUGxab4z4Aze5jpGwktRO0tY5Uf20cJ5HaayallBlXIKiIHqRDSFwT748V6RVcOl4TBrIDeFFBupIqzRZmVwKjZcBzLtDnFotjjLBpHtcsKkG9QMPXZcAMlUuHyDt4hIG57+gYF0GlQq3INv0i9IhriejV65+4qAMHJSXhPmnaLWityyT4HEg5KiUeKcGd1xaraI0tBUD/pFCFzWA4+LzdRCOXCGmWPl5ZMRMDxYj4usff/zxx+lpVj2tlMf23rda7SLGNiuKLED4qvD4x+Frp5WYGXzhLNcMQV53qjpzxJ3LCL8SFXEqLE8E3kWYaP4wQ84xLXTZZbYQPhYWfn85gUpHS/eA2vHpx03QTH6ZFbEN7w+a4P0NLTIQKu0VKiJzF1NV2BOX+SvThEnKnSXakwoe/VvNuiGlvq2MMEFJJhWOTz+CCelN1xR8YCKl2pZG14OLXAdYUBwaUxOOlDoLY3wRgFeOpL3zfmd7aSR912l1dlYPp6FG760Xza0YVUOfGaQCKPyWijH5mJ1Ca2n1mNugxChamE703GM4GMc6/f4MogStdoPCjArEbz6XUMA51Uyz9iKdtlXggUxU8N+810Jh8HGEGuep5ByS76R6EdVwlqeLP6K6txI7fKL6elyhutVsWE++LtNh+I4QfxbMCwmZDU8WRPbWPpac75VmVEEiXij9ZX33OwfOPNSvrm72vWXKylnEZogVFTRQkaXtKzvy/oKY8Kj0l0WkyKzyepcw/aV0GHlJ9oIerHUORQgVwzJgQuT9qzoVKJgczxOUflpi9IeUC9tIk/VZXILgTGlnXpo0XedZTMx2AvU44uEIRsxAH1HCBtd+WoX3xRhS3WeSG4w2yuw+0sjIqE/ZzsN+2R9bHGoXALis/YNat0hHwj8X2kw4WohCJ5Gp67pxM6eRODcOnb+TSzKYDFHfMSE4/VUKwt0j2M8frUNlBca8A6wsMdDXbjZHDdElDkRQotUDj1D73kE4ieHpG6uAx7QAwRMDxKoyUy5PSbatW18r8GUzT57b7RenzySL7fbqbp3emsmim7AvOJtOiW0QMhsw4CiiJhzLaWjkuMZ9m5Zm4+BvSmKdBGEmYKIlPUrOHb4vy6nLDFieVf8IDpwu5ED8Eg6QPOsYI05hOnHi2WyaGNtZ7ZQ7a9E4p1byU0+ys+JJfi+Vp89TufppVcn4wTgXwTk31/DjD66iZSyEftlkrLPS12u1Wq2d9vtdV/RMw7LuXKaaicY1eRg4EDRDMcjm3tbVGzKkRd1ZssMzVQD/Tsz+dEVISW7Q7eHp6KxAxzon4OnovC4dApOKllPZ55AkMNHc4MQRjHgCtawEvx4tWXUflm4xx+OdHF74QCWZrqMwxT5SpCIctLyVSKkaqVOfZkrcIMqiAFFg0nk54T03/7Q26SZ/fUXiXQjJbSmsBCrcC5Yk5PZPDi+yKsG8bITG9yrRmM4DYyr5aG6VpkHoE+oUG6gdX52sTmCvUOSdTnbnk31UtCrs6ssM3FCjYdqMOLu+6kEDzlSMMhTMptpVpa4lTXcTkCKyk/3Mpps+3nfZ+W9MpsRg0pg6DJQQ6pE49EHjV27rfgsqSmlMBAv99NHx1QnUnmPLJmRDW9e/N2/lLzSpxsIv2cxhnDDL+5wmxeqTMSXT5DRJJC2XqZ8bySIyf7pu9nU6bH7rDuo28E7cTa8v7Rv5cczCue6XG1huDnzOpGt1Llda+lWAQ4Hm4muFjlDxSHu+lLuZTcu7aYPZjpmhwr3FLuSz4BsXBtNI+bc28sHMk73sn3mTLnU4LT0ujIrU4az0aHbWpFd6nvvVzeJ0hEsnmZ/acz96mEpreUa9SQVw4oNQNHFiRioVEYxojs5VOQ1mzGAGNs6UpfG5LN/eAM1cHG5HTIKlBCkbnY9ptRt5h+OPTl/L47TPz2G4Y1owsvlM3TL/xcNeYW6WoE201KdH82c2qu58jxz69vbzQzA/G2GPRwXdXC6WT478bFQJhypfd1vt7fett8t6rK+Opt+4gtnOdqvV6mw7zKqtp4OjV8dpWTeqgun2e8J0N8f0jkdVZI8/ru7gRkpbj9NkCluvg95N53r7b/N6lYcfX5+Ji/qhS9RlJoC4OvlOHMs4PeN555Rrrk6OtzsufGNpOXzbv+6sh5uPyCo+lCKP7DdmnaoizyBVsogzswWU77324VbT6Cp+bZq39fo7MxHws/E7nYNfp9Vq7b17N6//+8vrYzfTY66g1yHzl/VTXzZAtqTL9erELGmwzet2bRYrSj54faa1V+FOe6fVar3d3lvOnZmm4AtYtG5H8Ps5tUJ/sET/4v5P1rB57dOf7RFVXbkT5db23HbP1c3+etjNa/DMliEOnR51tnde3qB5fYYVd1u1U7MeZnNbNfO4tUNW+/3beX2Vgw+vzpm5PZAKirtOnDrvVmuNvH6sU96vivRbpwJ7C5oZ5A9d+fD1nWK5wzFriAm7Z1x5pRHxv4L86Vzk4znIF/z8nAaDR77zM5BfKVzqzOPxT0bzmahpWQPAg1kHz2U9gB9U4/dytB5yLyrxz+K63161gP9jOLgGkjPV+cOLaRH+deXvZfX6qst6R3Kw255bYCfcp3X018b+ZSX3WY//9ESRUfXn7E/+n3rwtUGfe+4Nf1eFYHIYdIORtYn73X4fBbVcLk+CemBUqskVuqemu7XFEt5MClXi6bUhW/Rj7c7+/i11JyZQQw8nh3pwclyEGqZaQOMIGl/g9vZWNhr0eePle23QZp/rQYx2pOjGmSFadzOAHQXdoLD+W/7nE22P+iG/qCPVYgl1M0Xn/YtjV092w14PTHM6ZSoxuKsy6A4Hkhg3d+LWt983W80WMYBTj9EFFdndIKfHV0G9sr9KUHrmNJUebmUvmS1aWzhVwuJyMnXdKJXtSRpRx+Z8kNW9C+BLzIxUaCY7LLwhxHUC/C06GgvTscJf00OYUKjub4SZFJWyVsOtfPMGDrMrYlynQ4jpZHXIJA2YM3d5SP77a3p32vvIr5dxsO7v72/lopPKHvtrbhxWIf2m3MDR4ZXD8OK8d5VfqGGa/qMXG+MmTrOrS2i+H+G+envJfU5Nfk+Joc+HLBxN7xoKVZz/bJxJmmDTKtGuBf7r1dWFa0mkJr/lwf/inbj1W+/87GKCmb/AyE3A0tUi1EBtuWXGX7JSh53sCwZ9FuXv0dc77mvqAQwo1XNU7+ZvO5kFpIuC/BVJMzjRIQuj8o2jvGk0oa+vonHOBvrxKhUSPYvoy5LATLoR2eUkrr05Xe+vzCGOM98owJhx0gOTJonS9t95hEw0pucbqmZKs26Z6vT8shn1mfvaVgY0IOtHz2ImC2qY3Te16Kqcb9M7bf55X9U/76v6f3NfVRaxWPxqtxLBuBspcNr0LXOf09uEyDt0J5flfK4HI0U/bPwUfPtGdaZrLZ6e6Gt/k1T30+epa3Q+NuKG/o4mN1Ut1LDaZXaZ0SYsuBVrLt7Zl0yOnVcWKX0K6sEXHBcv4Xqia55GyCLUDi//eN85isKLMzdXlSKMo8Or4OnpfwBu3i9B",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},y=void 0,g={},S=[{value:"Postcode Data",id:"postcode-data",level:3}];function b(e){const t={a:"a",code:"code",h3:"h3",p:"p",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Lookup Postcode"}),"\n",(0,o.jsx)(l(),{method:"get",path:"/postcodes/{postcode}",context:"endpoint"}),"\n",(0,o.jsx)(t.h3,{id:"postcode-data",children:"Postcode Data"}),"\n",(0,o.jsxs)(t.p,{children:["Lookup a UK postcode against the ONS Postcode Directory (ONSPD). The response is a fully resolved record \u2014 every administrative, electoral, statistical and health geography that ONSPD ships for the postcode is returned at the top level by its human-readable name, with the equivalent GSS / official codes mirrored under the ",(0,o.jsx)(t.code,{children:"codes"})," object."]}),"\n",(0,o.jsxs)(t.p,{children:["The same shape is returned by ",(0,o.jsx)(t.code,{children:"/postcodes"})," (bulk + search) and the reverse-geocoding endpoints. ",(0,o.jsx)(t.code,{children:"/outcodes"})," returns a separate, aggregated ",(0,o.jsx)(t.a,{href:"#tag/Outward-Codes",children:"Outcode"})," shape \u2014 one row per outward code, with admin / parish / constituency arrays summarising the postcodes inside."]}),"\n",(0,o.jsxs)(t.p,{children:["Returns ",(0,o.jsx)(t.code,{children:"404"})," if the postcode does not exist or is not valid."]}),"\n",(0,o.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:[{name:"postcode",in:"path",description:"Postcode to retrieve",required:!0,style:"simple",explode:!1,schema:{title:"Postcode",description:"Postcode to query",example:"SW1A 2AA"}}]}),"\n",(0,o.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive location data including geographic coordinates, administrative boundaries, and electoral information for the requested postcode",type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. May be empty for areas without county-level administration.",example:""},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}}}}}}}})]})}function C(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/4e6ae29d.29c1a44f.js b/build/assets/js/4e6ae29d.29c1a44f.js
new file mode 100644
index 000000000..e36c0e381
--- /dev/null
+++ b/build/assets/js/4e6ae29d.29c1a44f.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[9667],{9342(e,t,i){i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>x,frontMatter:()=>y,metadata:()=>a,toc:()=>S});const a=JSON.parse('{"id":"api/lookup-postcode","title":"Lookup Postcode","description":"### Postcode Data","source":"@site/docs/api/lookup-postcode.api.mdx","sourceDirName":"api","slug":"/api/lookup-postcode","permalink":"/docs/api/lookup-postcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"lookup-postcode","title":"Lookup Postcode","description":"### Postcode Data","sidebar_label":"Lookup Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJztXOty27iSfpUu5oflPZIsyXYSa/+s43gcz/i2ll3enDhlQyQkYgwCHACUo025ah9in3CfZKsBkiIpSraUOHupk6oZSyQu3Q00+uuL8N0zZKy9/hfvQmrjy4Bq72vTkzFVxDApjgOv751I+ZDEWQOv6QVU+4rF2MDre2/evIHsJXwkhtyKW+H6AIHrPyDOXpIxYUIbMCGF87NBoRdT1DdSTaFxfja4+LjZhquQgqI6lkJTYBoIjBLOp/hM8gkNQFFfqgD+6z/+E+iEqimQIGKCaYOUT2gTKLdjEt4EbYhh2jCfcCAigJASbkIYUzlWJA6nYEJiwE4NOmSxhpFUlsycdqZBUZMoQQMgjgUjY+B0QjkMp8CMhjCJiGgpSgIy5BQEiWgTHpkJbXP6V8ImhFNh4GgwgC2QoxHzGeFg5Q4RU0oqGkAiAupmv7dv7kEO/6S+aaNgUS6aRBR0SOIyWcMp3G9lBOt7aAwT/gB/A02J8sNNy7mxYp1QpWlrTKUvAybGQEUQSyaMbsP9lkyyAdzIKHtNY6KIoU0g47GiY2JoAF/OXcuvjTeGjLfOE/NIVNA6wM6bKX24PFJQUPIRYqpAukaW5VQ2dt1gC2KimA5hC3wptGEmocKfAlGKTDXoJIrwPVJbXBcNTGgWUCuby5Te+53Ozj2wUXkFA0k1CGmAfmPagFQoPPw+IZwF7VvhNT3kMqKGKtSJ7x6uoNf34tnWZ7jjY2LCOTXIN7ORKDjF6AQ7KFx2RQOvb1RCm542U45jahbFHBvQbzHHsfsjwjU28EMaEa//3TPM2KYLNa845V8JVVM7HLED973BTXcfevv73tPTV6TD6ZLGkXudDv4pjzZIfJ9q7TU9XwpDhcEmJI458+1ZsPWnxnbfl1AIl+ksXtMz0xhfua1bEsQXD/Ux0fahTrjBIydWeOgY5ghMG+AUbhgmDB1T5TW9kVQRMe7Rdg85Fknk9b/0Op2vT/mIc9wdyChWNKRCswkFLh1PEBBDgAmfJ1YRshOB+eBLqQImiKG6WTlbYCgTERDF7CsRzI4aYMLRh2NnZwhyTjVqTGEjLRNPoVmqjHbnpR/+Sghnxq410YaJMQpSSGXC9LMvE2HsZhChvguJ1/Qs/Xf2xTT/GiBDzM7uHqBmek2PSzFmJrGTcWKyjzFRnJGICkPU9K6opEhKgutHxF0uijtFxyh6XFoW2S5E0TujEu34zd5atceptERSI/fHp0iK74+xyQifBMTQOzm6Y8IoGSS+cf2zx4aqCJfLPWUioN/wcZRww2JO7wIaKzbJ3i9m5q7X6e14TU9TQYOgymfN0zshU1HnPBnziBQ7agi/i4l68JreMMGnzB8iZ0T4VN0Rzhl+SvnvdlMJ2A/4pJc9sR/SPyrxu+lf+53TOP2DCiES47ZBas3LqpVvrvoTJt2XuDPEeO7EKVpzt9H70GvtgB8SRXwzd8AT0DHxqdMSAtutWUMm8nbQoO1xuwnZibXZhus4sDYmksKEfAojJSO4lFPC4ZQw3l5w0s0UpsBdapjg4CUcon0dMaUN2iMDcgRkxvKQjqSiVqktX9AoMa8tbmEaxlRQRRCusIAKw0aM6twYEQ5GPgo0QJkGzrODrKQaX+DkWKzGiKa+FEEdJ2RkUoyRMkL4I9rZ7TI3nyiPdcbEFHRMfTZiPmijKDUaeRgmjOPZqa01ZyKdBZGWoqTMWdetUXaClXcgc8oC/+rewrEI0PJINWN1ZgXmDOHC3tDotvY22zAI5aNbBGdcUCD4jWjNxgifxoohqhxRRYVP+wgo/gm6fbhxbGHbjNesb0SMHyIgDAJFtQafS00R4Moy9IgosaP1+rDvsGW3CfSbT2ODqG3CdGJtB8rXmg45ghMiAs4EThJraAx8aThqkRR8uomDbfdhP46V/MYiYiwGSBdgtwMRNYpqbLXTn8HsRDBjaYEGmVBFxjRwipXST90aOnyZEW/n2u3DoTZ2IoszEb0nFozpRCm0hvg5B2XY5W1hYm1tQjp1RJjgU7g4hw/yG9V2/Pd9uErP74KZhAYn2sCDQHXBKctLZHvu9eFMFo01kAlhHAG4RXT55us+FQxmYecdzozo81hDJNwOnaG5eZU7r1IJ6aTQ+LfWjMxNXK+uWyfn0yQ4SBsuKbdcpFvog2IGUfFZakrgCAfHHXT0IQf0x6q+yRmCAqoEHCuKe6cNN4xzGFJAPmyTg5AIQTkca2yg7ZDHmlPcgadElNR3d7vT2Xn3VAQbBTmeFRDI6wgymxYan/+PS7L7bm9vFzdkBtUKcjzI0dvz5/v1HwVnyUA6Wgo8mS4o0qEYI1lNyM6RJtwQjvi1ylqzykkTT/kCJ5vlMz0dGc/1FG4WmBkgYqZj5sMn53LvJyaUysHXKn/P74mzT4PMdyfZQNbMzLNcJvJEikAKpLGEhKtiX4+qinPgxq6hCM5wrzyGNIUQMyRFONeInNCTBZKO0HKxhRmjDexkgwN8imqAUYQsNmFCai2vpkkgQSd+CETD/eFe+u++iSf1iPh5fMHFFtpFedyXlxY5f5pzFgoy+zhzIH5Yatn4uNnQThGM6OSsP7O8N1SbCENLVM3W2HozBWpvnHezOqW5S7NVodmCsWdIG5g2/E4iqjc0kjbzrQqUnRQcrpQ8kUTD8skZyGRoAwbLCb45GrzfgXyagmWEBlqi1iMClDgFTJttOCXT/BxjI/SAc+c4EbktLTHV6rS7vXdv0RTk/mGRnZnP+JO4SQcsMWOtQUvLxIQ/yM5ut73b2d7dwQN5iZNb3Eqz/QYXxR5wUHYXV99s139URixFw57ZbAcMvTyLHu2BZ41QRTkWe+pFUJQ2gsM8snFpG0Hj8PBycy3OFo/54sO7JpJQ9CHcWzggisIVvoXGxcHVetQ6M4MTVU+qBfYGPrKRRSoGA794PvtSTNBxkhhCjWM+BeIrqTWusRO5XnqMzS/LZR5gWJkfNxjhEFD0d4oRqhJQQA1FAwNHckKVwF0I5xiopulqWafv6PxSby5cJRfRKa6MfbJ1IKMIz/b1NMNnE8azKHEGaDaRGj8bFxoW1GyuYC+akAg3JvpxihJ7SmMMqnRAP1IFJ2RKFQwSjGOfJyZODOxjh1WZ6XV6XTigQicaTgbn+2kMREeEc6rKyQpFSRPMNMZvfArdZqfTaXWbu50OYl3rmKOffobhdRvBR7hrJ8DI5kKuodN9f4CcRhVOT1kQcPoqrJ7OWI1Y0NLs3+lSXnctr+/w/z/MK7KKEcU5wFc4jH4IzaSgbxYIDtiE6UzHcLPirs0d5Br/YZbRQB9cJgZI1QHClIUAiXB90RmSYjaMmxZ55UxYGaMGMo10WQCpZBKvzC6C8GUDZmk7hjkwyxknwr4unKmaqgnzbfoGUlUuLyDOYl0Ta7+gcLqMKqkHjmfTb1L5dL09emWhuB1lZEd5iUNxSo2S2MsQAY4GJK42Rl1EzAhd5AiOyzHs1QkObMin6EQ8EhSmG5YGKNfPnz9/Pj1N47SVQNze+06nW6S4GD6vIfiqFF3/WfSaWcxnjl7nLeEycLS6M9Wp2e7Lo/2lAGpAv1k/Nm0IH0tpgR8NXGCQaukc0Dg+/bgJioiH+S224exBG5y9wUYafKmcQgV43EUYf3bMpfZKtyF37lOXPo8V4n9V/x4STKiLgMZU4JEKx6cfQfvY02ZrJ4QnGEVT1CZHA5ua54hDI8yOolKnMMaFG1hlSbo773e2lyJpl2FZGU5DA/uth+ZWRNUwJJpiqBV+T/gUbcxOIee3OuauyyUVoyT2NRxMI5X8uAdRGq1xQ7kOC8xvPudQwDlGZ9O8L662keAGyVXwn53VolxTG82oCIRQFUyDAC6oIMqECwSAabOXyADOMufxZ0QVVxKOc1tfQUbdnadSxrAYRv00yPQZfgDuzw/zQjbmocoClG9znAXCrxTBcBVKQqqH9U1xzTh1pF9d3ey7U8oegmlYLZIY3KAST92hNKGzHSiER6keFrFSztMWFyMLBF+4BO4a61AcoXLIuLCfS9o0MVhBxLTOumHauEDUh4Rx00ri9UVcGsEeq706l2nWzokYhW031GPI/BBComFIqYANplxJERvyKSRqSATTNNgoi/tIUYIH/EzsmAgv2WZDx8qCAevBf5DrBuxw89eONgdNC4g0R6k218d0TfqyFpPWz2QdjkqKvwjI7SvYn2X/V+eyMkbdAlaaaBgqW0Alx9Q6EchQrOSEBVS5jIWf43l8YiSwCBtQcMwAiqoslMtT3NvGtm8U5LKZOdLd7otdadyL3e7qJh57zXnUbdjnjMxK+TaQmA0YMcqDNhyLGUyyUnNBdFvACH+XgjZxI8yBJ2wyQEfd0vsy/7osgOUe9s+QwOlCCUQvkQDuZxXRgCFkR0k861mndSqrrHJvLR5r4ia/dCV7K67kj3J5+jyXq69WlY2fTHNxOGvmWq7owka3tAHfNctrbyvZxE6n09npvt+1AVBb5lSMfyaK8NY1Whg44Fi5MUqLE9fVGzxIi7qzZIZnIgKuT0T+tAFJgWbQzvGUlWm9mI91VsDx0XtdPmyZWUnLMQR0iDswVkzT3BCELIZGGo5fj5c00g9Lp6ixeCeHFw6oxLN2CFPMIyIVbkfL0orotqE6DbGSxZa/LAKItrDuxYwPbNXV2qzrrPuKzFsIyUwJVgIG8TmJYzT7J4cXacSgBmTaosEKGlMZMMbwj2JGKqxWP8G0tIbG8dXJ6gwOCgHfWfl9Vk+IAazCrC7kwDQmHWaJibPrqwG04ExGVPicmETZCNW1wBJ8HKRIbD6f3rQl4vvWU/+diAQFjBrThJHkXD6ihD4o+o2ZppsCA1SKxtzmzIdTOL46gcZzYtmEtFTs+o/2rfgN6+OI/5BWOkYxMWzIsD6tmRdH6TbD+iVhmEhctUqKyNzq2gLl2S8Cbu1C3XrOiNufGCzNIbki0MK67peTWbZYv6YcuVo8LQz+dMOSgGUHjUJ2qLikAxfW3Ux/0oCrUZM90xjEN7QPWcH+xoWrW7C9NrJy0JOseKGuvqYJp6XXhQKVJpyVXs1XuAxK7zO76nygojtJXK2g/WXKbLeWf0jQxmA4yoFLrHPRoUx4ACFW79mIp6apMIiGjTNpsGgv9bc3QBGLw01IBBh0kNLfN0TY2v4uAY4/Wn0t1ocvKN+ulHen1dx5fbWrpfb98R0L8gLrtFaYk6Q3V4Ltyq6Xln0/X0b9v6Yueq4Q+vm6FrvVFxTbPhMHzn7as1eoeM7rdfKje0ENTBUS7SEo2t5+vnzpVxPs6KiQm+nW8kqcX00q0lCV626nu/2+83ZZzvrVyXQTVyjb2e50Or1tS1k1lXdw9Oo0LcvuVSjdfo+U7maU4tFSIfb44+ogIZTKpKVtWf28Woe8m9719t/rcr+HH19fiIvyy0vUZQ6EXZ38II1lmp5BLzUhr6uT4+2ehcBoIYoQeP+6tx5tDtVWcAiit/THlL2qIs8RVToR52o10Gd+7cWthiKq9HWxUtrp71yFxa+m77SGvl6n09l7964un/7b61M3l7OvkNfD4y/NT7+sIG9J1vDVmVmSsKzLHm4Wo3LOAXgGRVWk093pdDpvt/eWS2cuyfoCEa2bYf1xSa2Qby3xvziHlia9Xnv15/NsVVNut3JnuzZldnWzvx51dUmy+VDOodWj3vbOy5Ncry+w4myrZrvWo6w23VUnrR08td+/rctNHXx4dcnU5pEqJO7a7dR7t1p66fWxTnm+KtFvrQrsLUgIoT20IdjXN4rlLNH8QYzUPWPKK8mc/xHiT2uJj2qIL9j5miSNI773K4hfCS716mT8i8l8BjUtS6K4Ydahc1ke5SflSdw+Wo+4F6VJ5mnd766aBPk5ElyDyLkMx+HFLJHxuvvvZTmPqsl6h/tgt1ubpEDaZ7mI16b+ZWmLeYv/9ITIqHoRwZP71/S+tfD7wPZwl7JwIsZe3wuNiW3kckg5pq0uT/B6BpkoNIX2re5vbZGYteNCpH12P84W/sy+t79/ixmefFTfjZONenByXBzVTxSH1hG0HuD29la0Wvh94+VzbeBkX5teRE0o8WqlMTU2impCr+8V2n/PPj7ZOyfUJLuRJlF8CXdzgfv9i2Mbk7flchOiGK4yhhjsnTB4WQnuGFu7Y9t337c77Q4KgGGe1oKK9BKc0+Mrr1mZX8ZUOOG0pRpvpZ30FrYtrCpScZlXsbdKqQ/cjVRF+nyU5g4Kw5eEGUhf5zMsvArHZlPcdVGKFqqNubuPCilBqO6uPsqDSmm65la8eQOH6V1INlvE+axS3ScCC/aJvSUn++U89p3lj7J7lOxY9/f3t2LRSqWv3X1OliofbwPQcHR4ZSm8OB9cZTfH6Lb76raNthW86R09+HsJCvfVa3ruM26yC3k0fj8kfji7VMuXUfaDfyKwClDJWNkygk9XVxc2rZPo7H4Od1cBSuv3wfnZRU6Zu6nLVhTjHTqYhO7YZtrdJtSEnfQBgSEJsn74eMc+xjzKCF09y/Vu1tvuWaB4I5a7C2yOJlxkrmU2cZAl3nL+hjKYZmLAnx1jINGJCB+WNkye0UmzLDZFPGvv7oZCiROXKKARYagHOoljqcy/sIAS3pqtry/byYNNdFjVGbhmc+pT220rHdTD0w/fRUQU1DC9WG3RnVDfZ5c3/eNitn9czPb/5mK2FLEY+s1sxZwwW5Zhtel7aj5n12ahdejn1xx9bXqhxB+KfvG+f8c407XiT0/42F2Z1v/ydWYarY0NmMbPQX4l20INa1ymWdlNWHD9Wy3d6UMiptYq8wS/eU3vgU6Lt8094X1mISUBVZYu93rfGopCx7kr2koI4+jwynt6+m+Rkim/","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Postcodes","permalink":"/docs/api/postcodes"},"next":{"title":"Autocomplete Search a Postcode","permalink":"/docs/api/postcode-lookup"}}');var o=i(31325),n=i(31736),r=i(47812),s=i.n(r),l=i(38616),c=i.n(l),d=i(67994),p=i.n(d),u=i(54768),h=i.n(u),m=(i(24909),i(96847),i(78121));const y={id:"lookup-postcode",title:"Lookup Postcode",description:"### Postcode Data",sidebar_label:"Lookup Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJztXOty27iSfpUu5oflPZIsyXYSa/+s43gcz/i2ll3enDhlQyQkYgwCHACUo025ah9in3CfZKsBkiIpSraUOHupk6oZSyQu3Q00+uuL8N0zZKy9/hfvQmrjy4Bq72vTkzFVxDApjgOv751I+ZDEWQOv6QVU+4rF2MDre2/evIHsJXwkhtyKW+H6AIHrPyDOXpIxYUIbMCGF87NBoRdT1DdSTaFxfja4+LjZhquQgqI6lkJTYBoIjBLOp/hM8gkNQFFfqgD+6z/+E+iEqimQIGKCaYOUT2gTKLdjEt4EbYhh2jCfcCAigJASbkIYUzlWJA6nYEJiwE4NOmSxhpFUlsycdqZBUZMoQQMgjgUjY+B0QjkMp8CMhjCJiGgpSgIy5BQEiWgTHpkJbXP6V8ImhFNh4GgwgC2QoxHzGeFg5Q4RU0oqGkAiAupmv7dv7kEO/6S+aaNgUS6aRBR0SOIyWcMp3G9lBOt7aAwT/gB/A02J8sNNy7mxYp1QpWlrTKUvAybGQEUQSyaMbsP9lkyyAdzIKHtNY6KIoU0g47GiY2JoAF/OXcuvjTeGjLfOE/NIVNA6wM6bKX24PFJQUPIRYqpAukaW5VQ2dt1gC2KimA5hC3wptGEmocKfAlGKTDXoJIrwPVJbXBcNTGgWUCuby5Te+53Ozj2wUXkFA0k1CGmAfmPagFQoPPw+IZwF7VvhNT3kMqKGKtSJ7x6uoNf34tnWZ7jjY2LCOTXIN7ORKDjF6AQ7KFx2RQOvb1RCm542U45jahbFHBvQbzHHsfsjwjU28EMaEa//3TPM2KYLNa845V8JVVM7HLED973BTXcfevv73tPTV6TD6ZLGkXudDv4pjzZIfJ9q7TU9XwpDhcEmJI458+1ZsPWnxnbfl1AIl+ksXtMz0xhfua1bEsQXD/Ux0fahTrjBIydWeOgY5ghMG+AUbhgmDB1T5TW9kVQRMe7Rdg85Fknk9b/0Op2vT/mIc9wdyChWNKRCswkFLh1PEBBDgAmfJ1YRshOB+eBLqQImiKG6WTlbYCgTERDF7CsRzI4aYMLRh2NnZwhyTjVqTGEjLRNPoVmqjHbnpR/+Sghnxq410YaJMQpSSGXC9LMvE2HsZhChvguJ1/Qs/Xf2xTT/GiBDzM7uHqBmek2PSzFmJrGTcWKyjzFRnJGICkPU9K6opEhKgutHxF0uijtFxyh6XFoW2S5E0TujEu34zd5atceptERSI/fHp0iK74+xyQifBMTQOzm6Y8IoGSS+cf2zx4aqCJfLPWUioN/wcZRww2JO7wIaKzbJ3i9m5q7X6e14TU9TQYOgymfN0zshU1HnPBnziBQ7agi/i4l68JreMMGnzB8iZ0T4VN0Rzhl+SvnvdlMJ2A/4pJc9sR/SPyrxu+lf+53TOP2DCiES47ZBas3LqpVvrvoTJt2XuDPEeO7EKVpzt9H70GvtgB8SRXwzd8AT0DHxqdMSAtutWUMm8nbQoO1xuwnZibXZhus4sDYmksKEfAojJSO4lFPC4ZQw3l5w0s0UpsBdapjg4CUcon0dMaUN2iMDcgRkxvKQjqSiVqktX9AoMa8tbmEaxlRQRRCusIAKw0aM6twYEQ5GPgo0QJkGzrODrKQaX+DkWKzGiKa+FEEdJ2RkUoyRMkL4I9rZ7TI3nyiPdcbEFHRMfTZiPmijKDUaeRgmjOPZqa01ZyKdBZGWoqTMWdetUXaClXcgc8oC/+rewrEI0PJINWN1ZgXmDOHC3tDotvY22zAI5aNbBGdcUCD4jWjNxgifxoohqhxRRYVP+wgo/gm6fbhxbGHbjNesb0SMHyIgDAJFtQafS00R4Moy9IgosaP1+rDvsGW3CfSbT2ODqG3CdGJtB8rXmg45ghMiAs4EThJraAx8aThqkRR8uomDbfdhP46V/MYiYiwGSBdgtwMRNYpqbLXTn8HsRDBjaYEGmVBFxjRwipXST90aOnyZEW/n2u3DoTZ2IoszEb0nFozpRCm0hvg5B2XY5W1hYm1tQjp1RJjgU7g4hw/yG9V2/Pd9uErP74KZhAYn2sCDQHXBKctLZHvu9eFMFo01kAlhHAG4RXT55us+FQxmYecdzozo81hDJNwOnaG5eZU7r1IJ6aTQ+LfWjMxNXK+uWyfn0yQ4SBsuKbdcpFvog2IGUfFZakrgCAfHHXT0IQf0x6q+yRmCAqoEHCuKe6cNN4xzGFJAPmyTg5AIQTkca2yg7ZDHmlPcgadElNR3d7vT2Xn3VAQbBTmeFRDI6wgymxYan/+PS7L7bm9vFzdkBtUKcjzI0dvz5/v1HwVnyUA6Wgo8mS4o0qEYI1lNyM6RJtwQjvi1ylqzykkTT/kCJ5vlMz0dGc/1FG4WmBkgYqZj5sMn53LvJyaUysHXKn/P74mzT4PMdyfZQNbMzLNcJvJEikAKpLGEhKtiX4+qinPgxq6hCM5wrzyGNIUQMyRFONeInNCTBZKO0HKxhRmjDexkgwN8imqAUYQsNmFCai2vpkkgQSd+CETD/eFe+u++iSf1iPh5fMHFFtpFedyXlxY5f5pzFgoy+zhzIH5Yatn4uNnQThGM6OSsP7O8N1SbCENLVM3W2HozBWpvnHezOqW5S7NVodmCsWdIG5g2/E4iqjc0kjbzrQqUnRQcrpQ8kUTD8skZyGRoAwbLCb45GrzfgXyagmWEBlqi1iMClDgFTJttOCXT/BxjI/SAc+c4EbktLTHV6rS7vXdv0RTk/mGRnZnP+JO4SQcsMWOtQUvLxIQ/yM5ut73b2d7dwQN5iZNb3Eqz/QYXxR5wUHYXV99s139URixFw57ZbAcMvTyLHu2BZ41QRTkWe+pFUJQ2gsM8snFpG0Hj8PBycy3OFo/54sO7JpJQ9CHcWzggisIVvoXGxcHVetQ6M4MTVU+qBfYGPrKRRSoGA794PvtSTNBxkhhCjWM+BeIrqTWusRO5XnqMzS/LZR5gWJkfNxjhEFD0d4oRqhJQQA1FAwNHckKVwF0I5xiopulqWafv6PxSby5cJRfRKa6MfbJ1IKMIz/b1NMNnE8azKHEGaDaRGj8bFxoW1GyuYC+akAg3JvpxihJ7SmMMqnRAP1IFJ2RKFQwSjGOfJyZODOxjh1WZ6XV6XTigQicaTgbn+2kMREeEc6rKyQpFSRPMNMZvfArdZqfTaXWbu50OYl3rmKOffobhdRvBR7hrJ8DI5kKuodN9f4CcRhVOT1kQcPoqrJ7OWI1Y0NLs3+lSXnctr+/w/z/MK7KKEcU5wFc4jH4IzaSgbxYIDtiE6UzHcLPirs0d5Br/YZbRQB9cJgZI1QHClIUAiXB90RmSYjaMmxZ55UxYGaMGMo10WQCpZBKvzC6C8GUDZmk7hjkwyxknwr4unKmaqgnzbfoGUlUuLyDOYl0Ta7+gcLqMKqkHjmfTb1L5dL09emWhuB1lZEd5iUNxSo2S2MsQAY4GJK42Rl1EzAhd5AiOyzHs1QkObMin6EQ8EhSmG5YGKNfPnz9/Pj1N47SVQNze+06nW6S4GD6vIfiqFF3/WfSaWcxnjl7nLeEycLS6M9Wp2e7Lo/2lAGpAv1k/Nm0IH0tpgR8NXGCQaukc0Dg+/bgJioiH+S224exBG5y9wUYafKmcQgV43EUYf3bMpfZKtyF37lOXPo8V4n9V/x4STKiLgMZU4JEKx6cfQfvY02ZrJ4QnGEVT1CZHA5ua54hDI8yOolKnMMaFG1hlSbo773e2lyJpl2FZGU5DA/uth+ZWRNUwJJpiqBV+T/gUbcxOIee3OuauyyUVoyT2NRxMI5X8uAdRGq1xQ7kOC8xvPudQwDlGZ9O8L662keAGyVXwn53VolxTG82oCIRQFUyDAC6oIMqECwSAabOXyADOMufxZ0QVVxKOc1tfQUbdnadSxrAYRv00yPQZfgDuzw/zQjbmocoClG9znAXCrxTBcBVKQqqH9U1xzTh1pF9d3ey7U8oegmlYLZIY3KAST92hNKGzHSiER6keFrFSztMWFyMLBF+4BO4a61AcoXLIuLCfS9o0MVhBxLTOumHauEDUh4Rx00ri9UVcGsEeq706l2nWzokYhW031GPI/BBComFIqYANplxJERvyKSRqSATTNNgoi/tIUYIH/EzsmAgv2WZDx8qCAevBf5DrBuxw89eONgdNC4g0R6k218d0TfqyFpPWz2QdjkqKvwjI7SvYn2X/V+eyMkbdAlaaaBgqW0Alx9Q6EchQrOSEBVS5jIWf43l8YiSwCBtQcMwAiqoslMtT3NvGtm8U5LKZOdLd7otdadyL3e7qJh57zXnUbdjnjMxK+TaQmA0YMcqDNhyLGUyyUnNBdFvACH+XgjZxI8yBJ2wyQEfd0vsy/7osgOUe9s+QwOlCCUQvkQDuZxXRgCFkR0k861mndSqrrHJvLR5r4ia/dCV7K67kj3J5+jyXq69WlY2fTHNxOGvmWq7owka3tAHfNctrbyvZxE6n09npvt+1AVBb5lSMfyaK8NY1Whg44Fi5MUqLE9fVGzxIi7qzZIZnIgKuT0T+tAFJgWbQzvGUlWm9mI91VsDx0XtdPmyZWUnLMQR0iDswVkzT3BCELIZGGo5fj5c00g9Lp6ixeCeHFw6oxLN2CFPMIyIVbkfL0orotqE6DbGSxZa/LAKItrDuxYwPbNXV2qzrrPuKzFsIyUwJVgIG8TmJYzT7J4cXacSgBmTaosEKGlMZMMbwj2JGKqxWP8G0tIbG8dXJ6gwOCgHfWfl9Vk+IAazCrC7kwDQmHWaJibPrqwG04ExGVPicmETZCNW1wBJ8HKRIbD6f3rQl4vvWU/+diAQFjBrThJHkXD6ihD4o+o2ZppsCA1SKxtzmzIdTOL46gcZzYtmEtFTs+o/2rfgN6+OI/5BWOkYxMWzIsD6tmRdH6TbD+iVhmEhctUqKyNzq2gLl2S8Cbu1C3XrOiNufGCzNIbki0MK67peTWbZYv6YcuVo8LQz+dMOSgGUHjUJ2qLikAxfW3Ux/0oCrUZM90xjEN7QPWcH+xoWrW7C9NrJy0JOseKGuvqYJp6XXhQKVJpyVXs1XuAxK7zO76nygojtJXK2g/WXKbLeWf0jQxmA4yoFLrHPRoUx4ACFW79mIp6apMIiGjTNpsGgv9bc3QBGLw01IBBh0kNLfN0TY2v4uAY4/Wn0t1ocvKN+ulHen1dx5fbWrpfb98R0L8gLrtFaYk6Q3V4Ltyq6Xln0/X0b9v6Yueq4Q+vm6FrvVFxTbPhMHzn7as1eoeM7rdfKje0ENTBUS7SEo2t5+vnzpVxPs6KiQm+nW8kqcX00q0lCV626nu/2+83ZZzvrVyXQTVyjb2e50Or1tS1k1lXdw9Oo0LcvuVSjdfo+U7maU4tFSIfb44+ogIZTKpKVtWf28Woe8m9719t/rcr+HH19fiIvyy0vUZQ6EXZ38II1lmp5BLzUhr6uT4+2ehcBoIYoQeP+6tx5tDtVWcAiit/THlL2qIs8RVToR52o10Gd+7cWthiKq9HWxUtrp71yFxa+m77SGvl6n09l7964un/7b61M3l7OvkNfD4y/NT7+sIG9J1vDVmVmSsKzLHm4Wo3LOAXgGRVWk093pdDpvt/eWS2cuyfoCEa2bYf1xSa2Qby3xvziHlia9Xnv15/NsVVNut3JnuzZldnWzvx51dUmy+VDOodWj3vbOy5Ncry+w4myrZrvWo6w23VUnrR08td+/rctNHXx4dcnU5pEqJO7a7dR7t1p66fWxTnm+KtFvrQrsLUgIoT20IdjXN4rlLNH8QYzUPWPKK8mc/xHiT2uJj2qIL9j5miSNI773K4hfCS716mT8i8l8BjUtS6K4Ydahc1ke5SflSdw+Wo+4F6VJ5mnd766aBPk5ElyDyLkMx+HFLJHxuvvvZTmPqsl6h/tgt1ubpEDaZ7mI16b+ZWmLeYv/9ITIqHoRwZP71/S+tfD7wPZwl7JwIsZe3wuNiW3kckg5pq0uT/B6BpkoNIX2re5vbZGYteNCpH12P84W/sy+t79/ixmefFTfjZONenByXBzVTxSH1hG0HuD29la0Wvh94+VzbeBkX5teRE0o8WqlMTU2impCr+8V2n/PPj7ZOyfUJLuRJlF8CXdzgfv9i2Mbk7flchOiGK4yhhjsnTB4WQnuGFu7Y9t337c77Q4KgGGe1oKK9BKc0+Mrr1mZX8ZUOOG0pRpvpZ30FrYtrCpScZlXsbdKqQ/cjVRF+nyU5g4Kw5eEGUhf5zMsvArHZlPcdVGKFqqNubuPCilBqO6uPsqDSmm65la8eQOH6V1INlvE+axS3ScCC/aJvSUn++U89p3lj7J7lOxY9/f3t2LRSqWv3X1OliofbwPQcHR4ZSm8OB9cZTfH6Lb76raNthW86R09+HsJCvfVa3ruM26yC3k0fj8kfji7VMuXUfaDfyKwClDJWNkygk9XVxc2rZPo7H4Od1cBSuv3wfnZRU6Zu6nLVhTjHTqYhO7YZtrdJtSEnfQBgSEJsn74eMc+xjzKCF09y/Vu1tvuWaB4I5a7C2yOJlxkrmU2cZAl3nL+hjKYZmLAnx1jINGJCB+WNkye0UmzLDZFPGvv7oZCiROXKKARYagHOoljqcy/sIAS3pqtry/byYNNdFjVGbhmc+pT220rHdTD0w/fRUQU1DC9WG3RnVDfZ5c3/eNitn9czPb/5mK2FLEY+s1sxZwwW5Zhtel7aj5n12ahdejn1xx9bXqhxB+KfvG+f8c407XiT0/42F2Z1v/ydWYarY0NmMbPQX4l20INa1ymWdlNWHD9Wy3d6UMiptYq8wS/eU3vgU6Lt8094X1mISUBVZYu93rfGopCx7kr2koI4+jwynt6+m+Rkim/",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},f=void 0,g={},S=[{value:"Postcode Data",id:"postcode-data",level:3}];function b(e){const t={a:"a",code:"code",h3:"h3",p:"p",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Lookup Postcode"}),"\n",(0,o.jsx)(s(),{method:"get",path:"/postcodes/{postcode}",context:"endpoint"}),"\n",(0,o.jsx)(t.h3,{id:"postcode-data",children:"Postcode Data"}),"\n",(0,o.jsxs)(t.p,{children:["Lookup a UK postcode against the ONS Postcode Directory (ONSPD). The response is a fully resolved record \u2014 every administrative, electoral, statistical and health geography that ONSPD ships for the postcode is returned at the top level by its human-readable name, with the equivalent GSS / official codes mirrored under the ",(0,o.jsx)(t.code,{children:"codes"})," object."]}),"\n",(0,o.jsxs)(t.p,{children:["The same shape is returned by ",(0,o.jsx)(t.code,{children:"/postcodes"})," (bulk + search) and the reverse-geocoding endpoints. ",(0,o.jsx)(t.code,{children:"/outcodes"})," returns a separate, aggregated ",(0,o.jsx)(t.a,{href:"#tag/Outward-Codes",children:"Outcode"})," shape \u2014 one row per outward code, with admin / parish / constituency arrays summarising the postcodes inside."]}),"\n",(0,o.jsxs)(t.p,{children:["Returns ",(0,o.jsx)(t.code,{children:"404"})," if the postcode does not exist or is not valid."]}),"\n",(0,o.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:[{name:"postcode",in:"path",description:"Postcode to retrieve",required:!0,style:"simple",explode:!1,schema:{title:"Postcode",description:"Postcode to query",example:"SW1A 2AA"}}]}),"\n",(0,o.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive location data including geographic coordinates, administrative boundaries, and electoral information for the requested postcode",type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","pfa","date_of_introduction","date_of_termination","index_of_multiple_deprivation","parliamentary_constituency_2024","senedd_constituency","senedd_constituency_no","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. Null where the postcode falls outside a county-level authority (the underlying GSS code is then a pseudo such as `E99999999`, surfaced under `codes.admin_county`).",example:null},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:"Caerdydd Penarth"},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:14},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",required:["admin_district","admin_county","admin_ward","parish","ccg","ccg_id","ced","nuts","lau2","lsoa","msoa","pfa","parliamentary_constituency","parliamentary_constituency_2024","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2"],properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}}}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/6353b66b.663d6c32.js b/build/assets/js/6353b66b.663d6c32.js
deleted file mode 100644
index 7bfcce9db..000000000
--- a/build/assets/js/6353b66b.663d6c32.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[1002],{61843(e,n,d){d.r(n),d.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>i,metadata:()=>s,toc:()=>o});const s=JSON.parse('{"id":"postcode/schema","title":"Postcode Response Schema","description":"The Postcode schema represents all geographical and administrative information associated with a UK postcode. This data is returned when using the postcode lookup endpoints and forms the core of the Postcodes.io API response structure.","source":"@site/docs/postcode/schema.mdx","sourceDirName":"postcode","slug":"/postcode/schema","permalink":"/docs/postcode/schema","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"sidebar_label":"Postcode Schema","title":"Postcode Response Schema"},"sidebar":"docsSidebar","previous":{"title":"Overview","permalink":"/docs/overview"},"next":{"title":"Lookup","permalink":"/docs/postcode/lookup"}}');var r=d(31325),t=d(31736);const i={sidebar_label:"Postcode Schema",title:"Postcode Response Schema"},c=void 0,l={},o=[{value:"Example",id:"example",level:2},{value:"Reference",id:"reference",level:2},{value:"Positional Quality",id:"positional-quality",level:2}];function h(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"The Postcode schema represents all geographical and administrative information associated with a UK postcode. This data is returned when using the postcode lookup endpoints and forms the core of the Postcodes.io API response structure."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "postcode": "SW1A 1AA",\n "quality": 1,\n "eastings": 529090,\n "northings": 179645,\n "country": "England",\n "nhs_ha": "London",\n "longitude": -0.141563,\n "latitude": 51.50101,\n "european_electoral_region": "London",\n "primary_care_trust": "Westminster",\n "region": "London",\n "lsoa": "Westminster 018C",\n "msoa": "Westminster 018",\n "incode": "1AA",\n "outcode": "SW1A",\n "parliamentary_constituency": "Cities of London and Westminster",\n "parliamentary_constituency_2024": "Cities of London and Westminster",\n "senedd_constituency": null,\n "senedd_constituency_no": null,\n "admin_district": "Westminster",\n "parish": "Westminster, unparished area",\n "admin_county": "(pseudo) England (UA/MD/LB)",\n "date_of_introduction": "198001",\n "date_of_termination": null,\n "index_of_multiple_deprivation": 24862,\n "admin_ward": "St James\'s",\n "ced": null,\n "ccg": "NHS North West London",\n "nuts": "Westminster",\n "pfa": "Metropolitan Police",\n "nhs_region": "London",\n "ttwa": "London",\n "national_park": "England (non-National Park)",\n "bua": "City of Westminster",\n "icb": "NHS North West London Integrated Care Board",\n "cancer_alliance": "West London",\n "lsoa11": "Westminster 018C",\n "msoa11": "Westminster 018",\n "lsoa21": "Westminster 018C",\n "msoa21": "Westminster 018",\n "oa21": "E00023938",\n "ruc11": "(England/Wales) Urban major conurbation",\n "ruc21": "Urban: Nearer to a major town or city",\n "lep1": "London",\n "lep2": null,\n "codes": {\n "admin_district": "E09000033",\n "admin_county": "E99999999",\n "admin_ward": "E05013806",\n "parish": "E43000236",\n "parliamentary_constituency": "E14001172",\n "parliamentary_constituency_2024": "E14001172",\n "ccg": "E38000256",\n "ccg_id": "W2U3Z",\n "ced": "E99999999",\n "nuts": "TLI35",\n "lsoa": "E01004736",\n "msoa": "E02000977",\n "lau2": "E09000033",\n "pfa": "E23000001",\n "nhs_region": "E40000003",\n "ttwa": "E30000234",\n "national_park": "E65000001",\n "bua": "E63012036",\n "icb": "E54000027",\n "cancer_alliance": "E56000021",\n "lsoa11": "E01004736",\n "msoa11": "E02000977",\n "lsoa21": "E01004736",\n "msoa21": "E02000977",\n "oa21": "E00023938",\n "ruc11": "A1",\n "ruc21": "UN1",\n "lep1": "E37000051",\n "lep2": null\n }\n}\n'})}),"\n",(0,r.jsx)(n.h2,{id:"reference",children:"Reference"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Field"}),(0,r.jsx)(n.th,{children:"Type"}),(0,r.jsx)(n.th,{children:"Description"}),(0,r.jsx)(n.th,{children:"Example"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"postcode"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code. Updated monthly from Royal Mail."}),(0,r.jsx)(n.td,{children:'"SW1A 2AA"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"outcode"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district."}),(0,r.jsx)(n.td,{children:'"SW1A"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"incode"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area."}),(0,r.jsx)(n.td,{children:'"1AA"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"quality"})}),(0,r.jsx)(n.td,{children:"integer"}),(0,r.jsx)(n.td,{children:"Indicates accuracy of the grid reference location (1-9 scale, 1 being most accurate)."}),(0,r.jsx)(n.td,{children:"1"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"eastings"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"Ordnance Survey grid reference easting (X-coordinate) with 1-meter resolution. May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"530047"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"northings"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"Ordnance Survey grid reference northing (Y-coordinate) with 1-meter resolution. May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"179951"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"country"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man)."}),(0,r.jsx)(n.td,{children:'"England"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nhs_ha"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The NHS health authority area for this postcode."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"admin_county"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The administrative county for this postcode. May be empty for areas without county-level administration."}),(0,r.jsx)(n.td,{children:'""'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"admin_district"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The administrative district or unitary authority for this postcode."}),(0,r.jsx)(n.td,{children:'"Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"admin_ward"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The electoral/administrative ward for this postcode."}),(0,r.jsx)(n.td,{children:'"St. James\'s"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"longitude"})}),(0,r.jsx)(n.td,{children:"number | null"}),(0,r.jsx)(n.td,{children:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"-0.12767"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"latitude"})}),(0,r.jsx)(n.td,{children:"number | null"}),(0,r.jsx)(n.td,{children:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"51.503541"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"parliamentary_constituency"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The UK Parliamentary constituency for this postcode."}),(0,r.jsx)(n.td,{children:'"Cities of London and Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"european_electoral_region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The European Electoral Region for this postcode."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"primary_care_trust"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions."}),(0,r.jsx)(n.td,{children:'"Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The regional designation for this postcode (formerly Government Office Regions or GORs)."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"parish"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The civil parish (England) or community (Wales) for this postcode."}),(0,r.jsx)(n.td,{children:'"Westminster, unparished area"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lsoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data."}),(0,r.jsx)(n.td,{children:'"Westminster 018C"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"msoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data."}),(0,r.jsx)(n.td,{children:'"Westminster 018"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ced"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ccg"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"NHS Clinical Commissioning Group responsible for planning healthcare services in England."}),(0,r.jsx)(n.td,{children:'"NHS North West London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nuts"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"International Territorial Levels (ITL) code for statistical geography (formerly NUTS - Nomenclature of Units for Territorial Statistics)."}),(0,r.jsx)(n.td,{children:'"Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes"})}),(0,r.jsx)(n.td,{children:"object"}),(0,r.jsx)(n.td,{children:"Standard 9-character codes (ONS/GSS) for various administrative boundaries. Useful for data linking with official statistics."}),(0,r.jsx)(n.td,{children:"-"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.admin_district"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this administrative district."}),(0,r.jsx)(n.td,{children:'"E09000033"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.admin_county"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this administrative county."}),(0,r.jsx)(n.td,{children:'"E99999999"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.admin_ward"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this administrative ward."}),(0,r.jsx)(n.td,{children:'"E05013806"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.parish"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this parish."}),(0,r.jsx)(n.td,{children:'"E43000236"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.parliamentary_constituency"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsxs)(n.td,{children:["Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for ",(0,r.jsx)(n.code,{children:"codes.parliamentary_constituency_2024"}),"."]}),(0,r.jsx)(n.td,{children:'"E14000639"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ccg"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Clinical Commissioning Group."}),(0,r.jsx)(n.td,{children:'"E38000256"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ccg_id"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Short code identifier for this Clinical Commissioning Group."}),(0,r.jsx)(n.td,{children:'"W2U3Z"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ced"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this County Electoral District."}),(0,r.jsx)(n.td,{children:'"E99999999"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.nuts"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official code for this International Territorial Level area."}),(0,r.jsx)(n.td,{children:'"TLI32"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lau2"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Local Administrative Unit level 2 code for this area."}),(0,r.jsx)(n.td,{children:'"E09000033"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lsoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census LSOA."}),(0,r.jsx)(n.td,{children:'"E01004736"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.msoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census MSOA."}),(0,r.jsx)(n.td,{children:'"E02000977"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.pfa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Police Force Area."}),(0,r.jsx)(n.td,{children:'"E23000001"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"pfa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The police force area for this postcode."}),(0,r.jsx)(n.td,{children:'"Metropolitan Police"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"date_of_introduction"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The date the postcode was introduced in YYYYMM format."}),(0,r.jsx)(n.td,{children:'"198001"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"date_of_termination"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsxs)(n.td,{children:["The date the postcode was terminated in YYYYMM format. ",(0,r.jsx)(n.code,{children:"null"})," for live postcodes."]}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"index_of_multiple_deprivation"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries."}),(0,r.jsx)(n.td,{children:"14843"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"parliamentary_constituency_2024"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries."}),(0,r.jsx)(n.td,{children:'"Cities of London and Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"senedd_constituency"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere."}),(0,r.jsx)(n.td,{children:'"Caerdydd Penarth"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"senedd_constituency_no"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere."}),(0,r.jsx)(n.td,{children:"14"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nhs_region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The NHS England Region for this postcode. Only applicable to English postcodes."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ttwa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"national_park"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The National Park this postcode falls within, if any."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"bua"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Built-up Area (2022) for this postcode."}),(0,r.jsx)(n.td,{children:'"Greater London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"icb"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The NHS Integrated Care Board responsible for healthcare planning in this area."}),(0,r.jsx)(n.td,{children:'"NHS North West London ICB"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"cancer_alliance"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Cancer Alliance for this postcode."}),(0,r.jsx)(n.td,{children:'"RM Partners (West London)"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lsoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2011 Census LSOA code. Alias for the 'lsoa' field."}),(0,r.jsx)(n.td,{children:'"Westminster 018C"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"msoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2011 Census MSOA code. Alias for the 'msoa' field."}),(0,r.jsx)(n.td,{children:'"Westminster 018"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lsoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area."}),(0,r.jsx)(n.td,{children:'"Westminster 018C"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"msoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census MSOA code. In Scotland this is the Intermediate Zone."}),(0,r.jsx)(n.td,{children:'"Westminster 018"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"oa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census Output Area code - the smallest census geography."}),(0,r.jsx)(n.td,{children:'"E00004185"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ruc11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The 2011 Census Rural-Urban Classification for this postcode."}),(0,r.jsx)(n.td,{children:'"Urban major conurbation"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ruc21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The 2021 Census Rural-Urban Classification for this postcode."}),(0,r.jsx)(n.td,{children:'"Urban major conurbation"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lep1"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The primary Local Enterprise Partnership for this postcode."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lep2"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.nhs_region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this NHS England Region."}),(0,r.jsx)(n.td,{children:'"E40000003"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ttwa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Travel to Work Area code."}),(0,r.jsx)(n.td,{children:'"E30000234"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.national_park"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this National Park."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.bua"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Built-up Area (2022) code."}),(0,r.jsx)(n.td,{children:'"E34004786"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.icb"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Integrated Care Board."}),(0,r.jsx)(n.td,{children:'"E54000027"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.cancer_alliance"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Cancer Alliance."}),(0,r.jsx)(n.td,{children:'"E56000009"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lsoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa."}),(0,r.jsx)(n.td,{children:'"E01004736"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.msoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa."}),(0,r.jsx)(n.td,{children:'"E02000977"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lsoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census LSOA."}),(0,r.jsx)(n.td,{children:'"E01004736"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.msoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census MSOA."}),(0,r.jsx)(n.td,{children:'"E02000977"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.oa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census Output Area code."}),(0,r.jsx)(n.td,{children:'"E00004185"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ruc11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2011 Census Rural-Urban Classification code."}),(0,r.jsx)(n.td,{children:'"A1"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ruc21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census Rural-Urban Classification code."}),(0,r.jsx)(n.td,{children:'"A1"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lep1"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for the primary Local Enterprise Partnership."}),(0,r.jsx)(n.td,{children:'"E37000051"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lep2"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for the secondary Local Enterprise Partnership."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.parliamentary_constituency_2024"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries."}),(0,r.jsx)(n.td,{children:'"E14000639"'})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"positional-quality",children:"Positional Quality"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Quality Value"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"1"}),(0,r.jsx)(n.td,{children:"Within the actual building (most accurate)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"2"}),(0,r.jsx)(n.td,{children:"Same as 1, but verified by Landline maps (Scotland only)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"3"}),(0,r.jsx)(n.td,{children:"Approximate location within 50m"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"4"}),(0,r.jsx)(n.td,{children:"Postcode unit mean (averaged from addresses with same postcode)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"5"}),(0,r.jsx)(n.td,{children:"Estimated by ONS using surrounding postcodes"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"6"}),(0,r.jsx)(n.td,{children:"Postcode sector mean (mainly PO Boxes)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"8"}),(0,r.jsx)(n.td,{children:"Historical postcode (pre-Gridlink\xae)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"9"}),(0,r.jsx)(n.td,{children:"No grid reference available"})]})]})]})]})}function a(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},31736(e,n,d){d.d(n,{R:()=>i,x:()=>c});var s=d(20489);const r={},t=s.createContext(r);function i(e){const n=s.useContext(t);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/6353b66b.ff06497d.js b/build/assets/js/6353b66b.ff06497d.js
new file mode 100644
index 000000000..3105bb972
--- /dev/null
+++ b/build/assets/js/6353b66b.ff06497d.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[1002],{61843(e,n,d){d.r(n),d.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>i,metadata:()=>s,toc:()=>o});const s=JSON.parse('{"id":"postcode/schema","title":"Postcode Response Schema","description":"The Postcode schema represents all geographical and administrative information associated with a UK postcode. This data is returned when using the postcode lookup endpoints and forms the core of the Postcodes.io API response structure.","source":"@site/docs/postcode/schema.mdx","sourceDirName":"postcode","slug":"/postcode/schema","permalink":"/docs/postcode/schema","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"sidebar_label":"Postcode Schema","title":"Postcode Response Schema"},"sidebar":"docsSidebar","previous":{"title":"Overview","permalink":"/docs/overview"},"next":{"title":"Lookup","permalink":"/docs/postcode/lookup"}}');var r=d(31325),t=d(31736);const i={sidebar_label:"Postcode Schema",title:"Postcode Response Schema"},c=void 0,l={},o=[{value:"Example",id:"example",level:2},{value:"Reference",id:"reference",level:2},{value:"Positional Quality",id:"positional-quality",level:2}];function h(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"The Postcode schema represents all geographical and administrative information associated with a UK postcode. This data is returned when using the postcode lookup endpoints and forms the core of the Postcodes.io API response structure."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "postcode": "SW1A 1AA",\n "quality": 1,\n "eastings": 529090,\n "northings": 179645,\n "country": "England",\n "nhs_ha": "London",\n "longitude": -0.141563,\n "latitude": 51.50101,\n "european_electoral_region": "London",\n "primary_care_trust": "Westminster",\n "region": "London",\n "lsoa": "Westminster 018C",\n "msoa": "Westminster 018",\n "incode": "1AA",\n "outcode": "SW1A",\n "parliamentary_constituency": "Cities of London and Westminster",\n "parliamentary_constituency_2024": "Cities of London and Westminster",\n "senedd_constituency": null,\n "senedd_constituency_no": null,\n "admin_district": "Westminster",\n "parish": "Westminster, unparished area",\n "admin_county": "(pseudo) England (UA/MD/LB)",\n "date_of_introduction": "198001",\n "date_of_termination": null,\n "index_of_multiple_deprivation": 24862,\n "admin_ward": "St James\'s",\n "ced": null,\n "ccg": "NHS North West London",\n "nuts": "Westminster",\n "pfa": "Metropolitan Police",\n "nhs_region": "London",\n "ttwa": "London",\n "national_park": "England (non-National Park)",\n "bua": "City of Westminster",\n "icb": "NHS North West London Integrated Care Board",\n "cancer_alliance": "West London",\n "lsoa11": "Westminster 018C",\n "msoa11": "Westminster 018",\n "lsoa21": "Westminster 018C",\n "msoa21": "Westminster 018",\n "oa21": "E00023938",\n "ruc11": "(England/Wales) Urban major conurbation",\n "ruc21": "Urban: Nearer to a major town or city",\n "lep1": "London",\n "lep2": null,\n "codes": {\n "admin_district": "E09000033",\n "admin_county": "E99999999",\n "admin_ward": "E05013806",\n "parish": "E43000236",\n "parliamentary_constituency": "E14001172",\n "parliamentary_constituency_2024": "E14001172",\n "ccg": "E38000256",\n "ccg_id": "W2U3Z",\n "ced": "E99999999",\n "nuts": "TLI35",\n "lsoa": "E01004736",\n "msoa": "E02000977",\n "lau2": "E09000033",\n "pfa": "E23000001",\n "nhs_region": "E40000003",\n "ttwa": "E30000234",\n "national_park": "E65000001",\n "bua": "E63012036",\n "icb": "E54000027",\n "cancer_alliance": "E56000021",\n "lsoa11": "E01004736",\n "msoa11": "E02000977",\n "lsoa21": "E01004736",\n "msoa21": "E02000977",\n "oa21": "E00023938",\n "ruc11": "A1",\n "ruc21": "UN1",\n "lep1": "E37000051",\n "lep2": null\n }\n}\n'})}),"\n",(0,r.jsx)(n.h2,{id:"reference",children:"Reference"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Field"}),(0,r.jsx)(n.th,{children:"Type"}),(0,r.jsx)(n.th,{children:"Description"}),(0,r.jsx)(n.th,{children:"Example"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"postcode"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code. Updated monthly from Royal Mail."}),(0,r.jsx)(n.td,{children:'"SW1A 2AA"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"outcode"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district."}),(0,r.jsx)(n.td,{children:'"SW1A"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"incode"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area."}),(0,r.jsx)(n.td,{children:'"1AA"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"quality"})}),(0,r.jsx)(n.td,{children:"integer"}),(0,r.jsx)(n.td,{children:"Indicates accuracy of the grid reference location (1-9 scale, 1 being most accurate)."}),(0,r.jsx)(n.td,{children:"1"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"eastings"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"Ordnance Survey grid reference easting (X-coordinate) with 1-meter resolution. May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"530047"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"northings"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"Ordnance Survey grid reference northing (Y-coordinate) with 1-meter resolution. May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"179951"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"country"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man)."}),(0,r.jsx)(n.td,{children:'"England"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nhs_ha"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The NHS health authority area for this postcode."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"admin_county"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsxs)(n.td,{children:["The administrative county for this postcode. Null where the postcode falls outside a county-level authority (the underlying GSS code is then a pseudo such as ",(0,r.jsx)(n.code,{children:"E99999999"}),", surfaced under ",(0,r.jsx)(n.code,{children:"codes.admin_county"}),")."]}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"admin_district"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The administrative district or unitary authority for this postcode."}),(0,r.jsx)(n.td,{children:'"Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"admin_ward"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The electoral/administrative ward for this postcode."}),(0,r.jsx)(n.td,{children:'"St. James\'s"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"longitude"})}),(0,r.jsx)(n.td,{children:"number | null"}),(0,r.jsx)(n.td,{children:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"-0.12767"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"latitude"})}),(0,r.jsx)(n.td,{children:"number | null"}),(0,r.jsx)(n.td,{children:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable."}),(0,r.jsx)(n.td,{children:"51.503541"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"parliamentary_constituency"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The UK Parliamentary constituency for this postcode."}),(0,r.jsx)(n.td,{children:'"Cities of London and Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"european_electoral_region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The European Electoral Region for this postcode."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"primary_care_trust"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions."}),(0,r.jsx)(n.td,{children:'"Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The regional designation for this postcode (formerly Government Office Regions or GORs)."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"parish"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The civil parish (England) or community (Wales) for this postcode."}),(0,r.jsx)(n.td,{children:'"Westminster, unparished area"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lsoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data."}),(0,r.jsx)(n.td,{children:'"Westminster 018C"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"msoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data."}),(0,r.jsx)(n.td,{children:'"Westminster 018"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ced"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ccg"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"NHS Clinical Commissioning Group responsible for planning healthcare services in England."}),(0,r.jsx)(n.td,{children:'"NHS North West London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nuts"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"International Territorial Levels (ITL) code for statistical geography (formerly NUTS - Nomenclature of Units for Territorial Statistics)."}),(0,r.jsx)(n.td,{children:'"Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes"})}),(0,r.jsx)(n.td,{children:"object"}),(0,r.jsx)(n.td,{children:"Standard 9-character codes (ONS/GSS) for various administrative boundaries. Useful for data linking with official statistics."}),(0,r.jsx)(n.td,{children:"-"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.admin_district"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this administrative district."}),(0,r.jsx)(n.td,{children:'"E09000033"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.admin_county"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this administrative county."}),(0,r.jsx)(n.td,{children:'"E99999999"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.admin_ward"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this administrative ward."}),(0,r.jsx)(n.td,{children:'"E05013806"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.parish"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this parish."}),(0,r.jsx)(n.td,{children:'"E43000236"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.parliamentary_constituency"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsxs)(n.td,{children:["Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for ",(0,r.jsx)(n.code,{children:"codes.parliamentary_constituency_2024"}),"."]}),(0,r.jsx)(n.td,{children:'"E14000639"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ccg"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Clinical Commissioning Group."}),(0,r.jsx)(n.td,{children:'"E38000256"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ccg_id"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Short code identifier for this Clinical Commissioning Group."}),(0,r.jsx)(n.td,{children:'"W2U3Z"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ced"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this County Electoral District."}),(0,r.jsx)(n.td,{children:'"E99999999"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.nuts"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official code for this International Territorial Level area."}),(0,r.jsx)(n.td,{children:'"TLI32"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lau2"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Local Administrative Unit level 2 code for this area."}),(0,r.jsx)(n.td,{children:'"E09000033"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lsoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census LSOA."}),(0,r.jsx)(n.td,{children:'"E01004736"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.msoa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census MSOA."}),(0,r.jsx)(n.td,{children:'"E02000977"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.pfa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Police Force Area."}),(0,r.jsx)(n.td,{children:'"E23000001"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"pfa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The police force area for this postcode."}),(0,r.jsx)(n.td,{children:'"Metropolitan Police"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"date_of_introduction"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The date the postcode was introduced in YYYYMM format."}),(0,r.jsx)(n.td,{children:'"198001"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"date_of_termination"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsxs)(n.td,{children:["The date the postcode was terminated in YYYYMM format. ",(0,r.jsx)(n.code,{children:"null"})," for live postcodes."]}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"index_of_multiple_deprivation"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries."}),(0,r.jsx)(n.td,{children:"14843"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"parliamentary_constituency_2024"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries."}),(0,r.jsx)(n.td,{children:'"Cities of London and Westminster"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"senedd_constituency"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere."}),(0,r.jsx)(n.td,{children:'"Caerdydd Penarth"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"senedd_constituency_no"})}),(0,r.jsx)(n.td,{children:"integer | null"}),(0,r.jsx)(n.td,{children:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere."}),(0,r.jsx)(n.td,{children:"14"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nhs_region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The NHS England Region for this postcode. Only applicable to English postcodes."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ttwa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"national_park"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The National Park this postcode falls within, if any."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"bua"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Built-up Area (2022) for this postcode."}),(0,r.jsx)(n.td,{children:'"Greater London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"icb"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The NHS Integrated Care Board responsible for healthcare planning in this area."}),(0,r.jsx)(n.td,{children:'"NHS North West London ICB"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"cancer_alliance"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The Cancer Alliance for this postcode."}),(0,r.jsx)(n.td,{children:'"RM Partners (West London)"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lsoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2011 Census LSOA code. Alias for the 'lsoa' field."}),(0,r.jsx)(n.td,{children:'"Westminster 018C"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"msoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2011 Census MSOA code. Alias for the 'msoa' field."}),(0,r.jsx)(n.td,{children:'"Westminster 018"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lsoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area."}),(0,r.jsx)(n.td,{children:'"Westminster 018C"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"msoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census MSOA code. In Scotland this is the Intermediate Zone."}),(0,r.jsx)(n.td,{children:'"Westminster 018"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"oa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census Output Area code - the smallest census geography."}),(0,r.jsx)(n.td,{children:'"E00004185"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ruc11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The 2011 Census Rural-Urban Classification for this postcode."}),(0,r.jsx)(n.td,{children:'"Urban major conurbation"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ruc21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The 2021 Census Rural-Urban Classification for this postcode."}),(0,r.jsx)(n.td,{children:'"Urban major conurbation"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lep1"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The primary Local Enterprise Partnership for this postcode."}),(0,r.jsx)(n.td,{children:'"London"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lep2"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.nhs_region"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this NHS England Region."}),(0,r.jsx)(n.td,{children:'"E40000003"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ttwa"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Travel to Work Area code."}),(0,r.jsx)(n.td,{children:'"E30000234"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.national_park"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this National Park."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.bua"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Built-up Area (2022) code."}),(0,r.jsx)(n.td,{children:'"E34004786"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.icb"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Integrated Care Board."}),(0,r.jsx)(n.td,{children:'"E54000027"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.cancer_alliance"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Cancer Alliance."}),(0,r.jsx)(n.td,{children:'"E56000009"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lsoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa."}),(0,r.jsx)(n.td,{children:'"E01004736"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.msoa11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa."}),(0,r.jsx)(n.td,{children:'"E02000977"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lsoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census LSOA."}),(0,r.jsx)(n.td,{children:'"E01004736"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.msoa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this 2021 Census MSOA."}),(0,r.jsx)(n.td,{children:'"E02000977"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.oa21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census Output Area code."}),(0,r.jsx)(n.td,{children:'"E00004185"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ruc11"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2011 Census Rural-Urban Classification code."}),(0,r.jsx)(n.td,{children:'"A1"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.ruc21"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"2021 Census Rural-Urban Classification code."}),(0,r.jsx)(n.td,{children:'"A1"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lep1"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for the primary Local Enterprise Partnership."}),(0,r.jsx)(n.td,{children:'"E37000051"'})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.lep2"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for the secondary Local Enterprise Partnership."}),(0,r.jsx)(n.td,{children:"null"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"codes.parliamentary_constituency_2024"})}),(0,r.jsx)(n.td,{children:"string | null"}),(0,r.jsx)(n.td,{children:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries."}),(0,r.jsx)(n.td,{children:'"E14000639"'})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"positional-quality",children:"Positional Quality"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Quality Value"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"1"}),(0,r.jsx)(n.td,{children:"Within the actual building (most accurate)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"2"}),(0,r.jsx)(n.td,{children:"Same as 1, but verified by Landline maps (Scotland only)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"3"}),(0,r.jsx)(n.td,{children:"Approximate location within 50m"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"4"}),(0,r.jsx)(n.td,{children:"Postcode unit mean (averaged from addresses with same postcode)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"5"}),(0,r.jsx)(n.td,{children:"Estimated by ONS using surrounding postcodes"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"6"}),(0,r.jsx)(n.td,{children:"Postcode sector mean (mainly PO Boxes)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"8"}),(0,r.jsx)(n.td,{children:"Historical postcode (pre-Gridlink\xae)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"9"}),(0,r.jsx)(n.td,{children:"No grid reference available"})]})]})]})]})}function a(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},31736(e,n,d){d.d(n,{R:()=>i,x:()=>c});var s=d(20489);const r={},t=s.createContext(r);function i(e){const n=s.useContext(t);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/735c778a.9ec0fb88.js b/build/assets/js/735c778a.9ec0fb88.js
deleted file mode 100644
index 02b5ec133..000000000
--- a/build/assets/js/735c778a.9ec0fb88.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[7110],{54192(e,t,i){i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>C,frontMatter:()=>y,metadata:()=>a,toc:()=>b});const a=JSON.parse('{"id":"api/random-postcode","title":"Get a Random Postcode","description":"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode.","source":"@site/docs/api/random-postcode.api.mdx","sourceDirName":"api","slug":"/api/random-postcode","permalink":"/docs/api/random-postcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"random-postcode","title":"Get a Random Postcode","description":"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode.","sidebar_label":"Get a Random Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJzVPNty27iSv9LF82B7S5Yl2U5i7cs6jsejGd/WkssnJ055YLIlYQICHAC0o5Ny1X7EfuF+yakGSIqk6IuUOLs7VTNjkUCju9HoO/EtsGxigv6n4FwZG6oITfC5FagENbNcyUEU9APNZKTifEDQCiI0oeYJDQj6wQXaVEsDDPxAMQODAkOLESTZJGBCyQncczuFUMWJxilKw+8QJqgmmiVTHraARTGX3Fha+w5bwGQExjLLjeUhExAxy4AZo0LOCLoDZ6fMFuu0g1aQMM1itKiJrm+BZDEG/UClOfackP4rRT1bIOUXLmheRkgB1cDtDDIAbcjplakQwMfA5R0TPCoGBK3A2JmgRcdKx0ErwK+JoLX7YyYMtgITTjFmQf9bYLl1A89Se890BBmKdpbQU2M1lxMHgMWJGzi86u4HDw+fW4FGkyhp0BCcXqdD/6tSM0zDEI0JWkGopEVpaQhLEsFDt7lbfxoa960Bn3yz4SJbZY6Uuv0TQxsQAn+lXGNE0kO7lBr30KTCkgwlmqTIco9gNoCW8GC4tDhBHbQck5j1j7Z7RK1M46D/qdfpfH4oIC5Qd1ARI6E8TV5GuAxFGnE5KYkXhErpiEtm0dRFDW5VKiOmuXslI3DyqzQTwKXHj2CPlQY7RSDK0ZTl+xn2lIaV5TD746+UCW5JGpEZy+WEGCmVttPs71Cl0jpxlVNzM2VBK3D437gXs+JnRARxt7p/QDIVtAI6e9ymbjHBbP5nwrTgLEZpmZ7dhEoaeoUydKiktH9M3hSsuNE4IdbT1vLYTWEab6xOjac3f8s0N1NayihCNfb/C5FQCUOSZ5laT1emb6qyUnCrQSAbDkdVLC5/nysdv3N96G3uQDhlmoUWNZ3T4qy1gIFJWJgpGwbbm/OBXBbjYB3bk3YL6PhBb39/ow2XSeSUUKyknYoZjLWK4ULNmIATxkV74djSvOBhLgENx//gJRSOpghjro2FhGkLagxsTvItjpVGJ6WOLlivEG822jCacgMTlKiZEDPgEUrLxxyNm0WQmACr7iUoDblILZJDpGQiXKJkIJcjxGCoZNRECRvTHpQIYeKezQxsV6n5FUViciJmYBIM+ZiHYKxGtIZouE25IGVgnMHgMluFCWAaWZWyrt+j/EhWJZAT4kzAf/q3MJARqVKl56TO1VqV1qdmw3p3c2+jDcOpuveb4LUlMYR+MWP4RGIEE80j0DhGjTLE/rW8lv8G3T5cebJobE5rPjdmNpxiBCyKNBoDoVAGjQWrit123I6ROWi9Puwbp+i6LcCvISaWjN8dN6lThsRfpwvVGI6ZjASXtEhiYH0YKivoFCkpZhsEbLsP+0mi1VceM4u0ZrYBux2I0Wo0NGqnD4W5SSW3DhdYZ3eo2QQjf7Ay/NHvIRgWz5F3a+324dBYt1BEGJ+dDiE1xAmTak3qnf4uLDpNeVNa2Dglly0dMy7FDM7P4L36isbBf9eHEerY2Y+SX7MumLHwRdJxoSWrW+Rm7vXhVJWtD7A7xgW7FXgty8LXfShZgJLkHc6twvPGk7wSAh30rU6x6cid1bGEbFFY//vmHM0N2q+u3yfQaJRICQj5P8JRkYnQe80tN1M4ZZl8HxFwkqCj906p0qCBbh5ySlYOtYSBRpKdNlxxIeAWvXdFQw6mTEoUMDA0wDiQAyOQJPCEycrx3d3udHbePpStZ4mPpyWT+jqMzJeF9Y//zznZfbu3t0sCmfseJT4eFO7I8/r98neYOxYWMmiZJ8VN6SAdygmh1YJcj7TgiglyyOqkteqUtEjLlyjZqOr0DDLp9cx/KhEzJBcQJzyEX5EJO4X91E6V9v5Ynb7nZeL01yFMPSCWA3JmZpHkKpLHSkZKEo4V167O9tWwqnm7HnYDRnDCZiQyGCfZe0Ld61yVZts32xR4h6ICVFWlJ5jTUfikJUo+zP3U76Ylh08iQNaD6VmJ888w/QqNjbk0FvUcY+c0l7C98k708pgWnvNWDWfnIj2D2tC24TcWo1kzhNrchS9hdlzy6zP0ZBrfVvVZpFLC8jmEr46G73agWKZkr2Cd7MPmPbkNSebGbBSikkfBE1RFDJbKwsJViNrstLu9t29IQRdhSJmceWjyg6jJAFaIcTp606jUTr+TnN1ue7ezvbtDavKJWKosSnN5g/PyDDioRl/LC9vl7zWIZRyeE7YDTrGX8+mcGnKmoXY4Hg8Iy65KNggOiwD6wg2C9cPDi42VKHsc5otVakPAWvbs/Vs4YBphRG9h/fxgtBq2XvnTQnVN9YgVgA987PwHC5LF5DyESt5ROKMoqZYkYgYs1MoY2mPPcvOkGlvclos8Nl+eHg+Mkm9IUUg5EVIx33RCUYsZHKk71JKkEM7GYx5itlsuFDs6uzAbj+6STxyUd8Y92TpQcUy6fbWTEfI7LsADL9yMDcImzOHCunM1NpawFy1IpYdJ0ZVG5rQ0pToqCvoeNRyzGWoYpglqOEttklrYpwnLEtPr9LpwgNKkBo6HZ/tZZsLETAjUlUwpIdQCO0vol5hBt9XpdDa7rd1OhzxQFy5T9Hyq7iFRXFrnhLoFKIH2KNXQ6b47IErjGqUnPIoEvgqpJ3NSYx5tGv5PfJLWXUfrW/rvd9NKpFLiasENKymj7/JmMldsnm+M+B03+RkjYSWpLcLWBq9+nqTOvTRWD0sU5bJAkRP9mA4hcA8+PVemVXDpeEwnkBvCixTUkVZpsjS55Bo/BRCyjDa/FegpE0y61yWdalDf8RANEZQd5eoG0iouYHD2C0raZVzLcAvSTb8oHeJqMjpy+RMHZeygvMTNP0GrFc2yTILHgZCjVOKNGt9wabWK0tDWFPgHcl3UGAbl96sgHLlETDnzc8+ImR4sRsTXjx8/fjw5ybKntfTY3rtOp1vG2GZJkUcQHpVe/zh87TwTs4AvnOYnQ5DVnR+dBnHnMsKvREWcCssTgTcRJprfLZAzoIEuuswGwofSwO9PJ1Dq6Mk1YH1w8mGDClNfFkVszduDNnh7Q4MMhEr7AxWRuospK+yJy+yVaUMRcmeBdpHBo3/rUTekBoEYlqAklQqDkw9gQpoJ//Nf/w13TKSU29KUBrEQcY2hFTNX7mOaSM/dGJ8E4LUt6e6829l+0pO+6XV6O8u707BO81bz5pb0quGWGaQEKPyWihnZmJ1SaWl5n9ugxCh6NJwYutdwMIt1+v0RRAXa+hUKMy0Rv/FcQAFnlDPNyou021aBB1IcwX/3VguFwfspamw6kg0k30j1IqrhNA8Xf0R2byl2+ED19bhCeatFt55sXXaG4Ttc/EUwLyRk0T15xLO39r5ifEeaUQaJeKH0l9XNbwOcJtRHo6t9r5mydBaxGWJFCQ1UpGlvlZ16e0FMuFf6y2OkyCzzepMw/aWyGXlK9pxerLQPZQg1xTJmQuT1qxYlKJicNQnKbVph9PuUC7uZJquzuALBqdJeU5g0H+dZTMx2AnU/5eEUpszALaKENa413qEmL28Gqb5lkhuM1qrsPtLISKnP2c7D26o9tjjRzgFwUft7tWqSjoS/EdqCO1ryQgvP1FXduGkoJDb6oc0ruSCDyRD1DROC018VJ9y9gv381SpU1mA0bWBtiIFbgg5WTdAFDkRQotUdj6hDhrY2LHx4emIV8JgGIHhigFhVZcrFCcm2dePXS3zZyIPnbvfF4TPJYre7vFmnWQtRdBv2BWem6PBYI2TWYMxRRG0YyLlr5LjGfZn2A/Wa/ENJbJEgLDhMNGRIwbnD92UxdZUBT0fVP4IDJ49yIH4JB0iedYwR9WM5TjwbTRNje8vtcm8lGhtyJT91J3tL7uT3UnnyPJXL71adjB+McxmcM3Obvv3BZbSMhdAPy5u4qhYvOOx0Op2d7rtdl/RMw+rZuUg1E5uXZGHgQFAPxTjre1v13JAiLZ+dJ1Z4Jgvg58TsT5eElGQG3Rqejt4SdKyyA56O3uvSITCpnXJK+xySBCaaGywMwZQnsJ6l4FejJcvuw5NLNFi848Nz76gk83Hkpth78lSEg5aXEilUo+N0Sz0lrhHlMQdRYNJ7OeFD1/+0Mukmn74k8c6F5LbiVgIl7gVLEjL7x4fnWZagKRqh9r2aN6Zzx5hSPppbpTkTcEyVYgPrg9Hx8gQOS0neQgVA3tlHSavSqj7NwA0VGubFiNPL0RA24VTFKEPBbKpdVupScutNXRnZYj2z0abeqn0Xnf/GZEoMphPTgrESQt0Th95r/Mptyy9BSSmNiWCh7z4ajI5h/Tm2bEDWtHX5e/ta/kKdaiz8kvUcxgmz/JZTp1iraFMybU6dRNJymfq+kcwj87vrel9TGWV9c9duo64Db8SpuvR0+du3Y5b2db9awDpw7xc7Xet9udIyLr3FORoOYb1UESpv6dCncjfAZ69dt8FixcxQ4t5iv2i7Xjs3mEbKz1rLGzOP97J/mjpdWnBSeV1qFWnBaeXVYq/JsPI+t6sb5e4IF04y37VnlZ6VpDVSaFw+DL9yY9uUACc+CEUdJ2aqUhHBlProXJbTYMYMZmDtVFlqn8vi7TXQzPnhdsokWAqQnHs+xZhG+xb0wQd3XqvttM/3YbhteqRl85m8JVX4SKL3Sn2zBK04pT48au7ZqJvzPTLo29vPN8H8bIQ9HjV0c7l4unPkZ6NKONT5utvpbr/rvHmqxvrqaPqFa5jtbHc6nd62w6xeejo4enWcnqpG1TDdfkeY7uaY3vCojuzgw/IGbqq09TgVXdh6FfSuepfb/2iqVR5+eH0mPlYPfeK4LDgQo+PvxLGK0zOWtyFdMzoebPec+8bSqvu2f9lbDTfvkdVsKHke4PvnevWDvIBURSMu9BZQvPfam1sPo+v4danf1p/fhY6An43fSQN+vU6ns/f2bVP995fXx26hxlxDr0fqL6unvqyB7Ikq16sT80SBranatVHOKHnn9ZnSXo073Z1Op/Nme+9p7iwUBV/AolUrgt/PqSXqgxX6H6//ZAWb1979xRpR3ZQ7Ue5sN5Z7Rlf7q2HXVOBZTEMcunPU2955eYHm9RlWXm3ZSs1qmDWWapq4tUNa+92bprrKwftX50xjDaSG4q4Tp97b5Uojr+/rVNerI/3GHYG9R4oZZA9d+vD1jWK1wrGoiAm7Z0x5rRDxv4L8SSPycQPyJTvfUGDwyPd+BvJLuUu9Jh7/ZDSf8ZqeKgB4MKvg+VQN4Afl+L0crYbci1L8i7jud5dN4P8YDq6A5EJ2/vB8noR/Xfl7Wb6+brLekhzsdhsT7IT7PI/+2ti/LOW+aPEfHsgzqn/O/uD/aQVfN+n30M3wF1cIJidBP5ham7jv9m9RUMnl4pgumFCpJlPo3pr+1hZLeDspZYm3/BUWW6UPXoOHVgE09GByoAfHgzLQMNUCNo9g8wtcX1/LzU36vfbipdZorc+tIEY7VXSByAStuxfAToN+sDCcVkZ9l9/XkWrxBF0L6eb984HLJLs2rzumOe0vJRfcJRl0ewPJius4ceO779qddodo51RddO5EdkXIyWAUtGrrqwSl50tb6clWNsls0djSfhIWF0W/9WYlYU9yiDo2Z+Ms410CX+FjpEJTrND0Bfm8BkDpAhhrLPXFCqW+kO93PnCFqgkqeqwLuXVFhmv5t7/BoYxcH7yrcQgx76kOmaTWcuauDcm/vKa586oHZnMdrD/++ONaPrZT2etrSXUqh1VIX5MbODocOQzPz4aj/CoN0/Y/vcgY12uaXVpCnf0If9TvLfkjpya/ocTQ70MWTvPGHYIQ5x+MM0m9a1ol2hW/fx2Nzl0xIjX5/Q7+W3fi1m/Ds9PzAjN3YwK63le6VIRKpx03zPjrVVqwkz1gcMuifB493nGPKfs/piDPUb2bz3YyC6i10m6FRZxok4VR+cJRXi4q6LtV0SxnA322SilEzyJ6WBGYog6RXUviCpvz8W33JTpxnPkSAcaM0zkwaZIobf+DR8jE5nx/Q9VOqcstOzpDP2zh+DRO28qABqT36F3MZOkYHiF9wnDhr+B57Nahb/M7bf7PXUCUWR2LX+1WIhh3ZWHHl2+ZEvyU3akUtIK5GvzcCqaKvkz7FHz7RomCSy0eHuixv6yIlGPEDem3qLhK6FGm/KirjBqJ+YKzypVKrvfbffb7ea6Eg/4nur9niixC7bD30/adHijNWriSqGI8jg5HwcPDvwBAGaPL","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Find the Nearest Postcodes","permalink":"/docs/api/nearest-postcode"},"next":{"title":"Terminated Postcodes","permalink":"/docs/api/terminated-postcodes"}}');var n=i(31325),o=i(31736),r=i(47812),l=i.n(r),s=i(38616),c=i.n(s),d=i(67994),p=i.n(d),u=i(54768),m=i.n(u),h=(i(24909),i(96847),i(78121));const y={id:"random-postcode",title:"Get a Random Postcode",description:"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode.",sidebar_label:"Get a Random Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJzVPNty27iSv9LF82B7S5Yl2U5i7cs6jsejGd/WkssnJ055YLIlYQICHAC0o5Ny1X7EfuF+yakGSIqk6IuUOLs7VTNjkUCju9HoO/EtsGxigv6n4FwZG6oITfC5FagENbNcyUEU9APNZKTifEDQCiI0oeYJDQj6wQXaVEsDDPxAMQODAkOLESTZJGBCyQncczuFUMWJxilKw+8QJqgmmiVTHraARTGX3Fha+w5bwGQExjLLjeUhExAxy4AZo0LOCLoDZ6fMFuu0g1aQMM1itKiJrm+BZDEG/UClOfackP4rRT1bIOUXLmheRkgB1cDtDDIAbcjplakQwMfA5R0TPCoGBK3A2JmgRcdKx0ErwK+JoLX7YyYMtgITTjFmQf9bYLl1A89Se890BBmKdpbQU2M1lxMHgMWJGzi86u4HDw+fW4FGkyhp0BCcXqdD/6tSM0zDEI0JWkGopEVpaQhLEsFDt7lbfxoa960Bn3yz4SJbZY6Uuv0TQxsQAn+lXGNE0kO7lBr30KTCkgwlmqTIco9gNoCW8GC4tDhBHbQck5j1j7Z7RK1M46D/qdfpfH4oIC5Qd1ARI6E8TV5GuAxFGnE5KYkXhErpiEtm0dRFDW5VKiOmuXslI3DyqzQTwKXHj2CPlQY7RSDK0ZTl+xn2lIaV5TD746+UCW5JGpEZy+WEGCmVttPs71Cl0jpxlVNzM2VBK3D437gXs+JnRARxt7p/QDIVtAI6e9ymbjHBbP5nwrTgLEZpmZ7dhEoaeoUydKiktH9M3hSsuNE4IdbT1vLYTWEab6xOjac3f8s0N1NayihCNfb/C5FQCUOSZ5laT1emb6qyUnCrQSAbDkdVLC5/nysdv3N96G3uQDhlmoUWNZ3T4qy1gIFJWJgpGwbbm/OBXBbjYB3bk3YL6PhBb39/ow2XSeSUUKyknYoZjLWK4ULNmIATxkV74djSvOBhLgENx//gJRSOpghjro2FhGkLagxsTvItjpVGJ6WOLlivEG822jCacgMTlKiZEDPgEUrLxxyNm0WQmACr7iUoDblILZJDpGQiXKJkIJcjxGCoZNRECRvTHpQIYeKezQxsV6n5FUViciJmYBIM+ZiHYKxGtIZouE25IGVgnMHgMluFCWAaWZWyrt+j/EhWJZAT4kzAf/q3MJARqVKl56TO1VqV1qdmw3p3c2+jDcOpuveb4LUlMYR+MWP4RGIEE80j0DhGjTLE/rW8lv8G3T5cebJobE5rPjdmNpxiBCyKNBoDoVAGjQWrit123I6ROWi9Puwbp+i6LcCvISaWjN8dN6lThsRfpwvVGI6ZjASXtEhiYH0YKivoFCkpZhsEbLsP+0mi1VceM4u0ZrYBux2I0Wo0NGqnD4W5SSW3DhdYZ3eo2QQjf7Ay/NHvIRgWz5F3a+324dBYt1BEGJ+dDiE1xAmTak3qnf4uLDpNeVNa2Dglly0dMy7FDM7P4L36isbBf9eHEerY2Y+SX7MumLHwRdJxoSWrW+Rm7vXhVJWtD7A7xgW7FXgty8LXfShZgJLkHc6twvPGk7wSAh30rU6x6cid1bGEbFFY//vmHM0N2q+u3yfQaJRICQj5P8JRkYnQe80tN1M4ZZl8HxFwkqCj906p0qCBbh5ySlYOtYSBRpKdNlxxIeAWvXdFQw6mTEoUMDA0wDiQAyOQJPCEycrx3d3udHbePpStZ4mPpyWT+jqMzJeF9Y//zznZfbu3t0sCmfseJT4eFO7I8/r98neYOxYWMmiZJ8VN6SAdygmh1YJcj7TgiglyyOqkteqUtEjLlyjZqOr0DDLp9cx/KhEzJBcQJzyEX5EJO4X91E6V9v5Ynb7nZeL01yFMPSCWA3JmZpHkKpLHSkZKEo4V167O9tWwqnm7HnYDRnDCZiQyGCfZe0Ld61yVZts32xR4h6ICVFWlJ5jTUfikJUo+zP3U76Ylh08iQNaD6VmJ888w/QqNjbk0FvUcY+c0l7C98k708pgWnvNWDWfnIj2D2tC24TcWo1kzhNrchS9hdlzy6zP0ZBrfVvVZpFLC8jmEr46G73agWKZkr2Cd7MPmPbkNSebGbBSikkfBE1RFDJbKwsJViNrstLu9t29IQRdhSJmceWjyg6jJAFaIcTp606jUTr+TnN1ue7ezvbtDavKJWKosSnN5g/PyDDioRl/LC9vl7zWIZRyeE7YDTrGX8+mcGnKmoXY4Hg8Iy65KNggOiwD6wg2C9cPDi42VKHsc5otVakPAWvbs/Vs4YBphRG9h/fxgtBq2XvnTQnVN9YgVgA987PwHC5LF5DyESt5ROKMoqZYkYgYs1MoY2mPPcvOkGlvclos8Nl+eHg+Mkm9IUUg5EVIx33RCUYsZHKk71JKkEM7GYx5itlsuFDs6uzAbj+6STxyUd8Y92TpQcUy6fbWTEfI7LsADL9yMDcImzOHCunM1NpawFy1IpYdJ0ZVG5rQ0pToqCvoeNRyzGWoYpglqOEttklrYpwnLEtPr9LpwgNKkBo6HZ/tZZsLETAjUlUwpIdQCO0vol5hBt9XpdDa7rd1OhzxQFy5T9Hyq7iFRXFrnhLoFKIH2KNXQ6b47IErjGqUnPIoEvgqpJ3NSYx5tGv5PfJLWXUfrW/rvd9NKpFLiasENKymj7/JmMldsnm+M+B03+RkjYSWpLcLWBq9+nqTOvTRWD0sU5bJAkRP9mA4hcA8+PVemVXDpeEwnkBvCixTUkVZpsjS55Bo/BRCyjDa/FegpE0y61yWdalDf8RANEZQd5eoG0iouYHD2C0raZVzLcAvSTb8oHeJqMjpy+RMHZeygvMTNP0GrFc2yTILHgZCjVOKNGt9wabWK0tDWFPgHcl3UGAbl96sgHLlETDnzc8+ImR4sRsTXjx8/fjw5ybKntfTY3rtOp1vG2GZJkUcQHpVe/zh87TwTs4AvnOYnQ5DVnR+dBnHnMsKvREWcCssTgTcRJprfLZAzoIEuuswGwofSwO9PJ1Dq6Mk1YH1w8mGDClNfFkVszduDNnh7Q4MMhEr7AxWRuospK+yJy+yVaUMRcmeBdpHBo3/rUTekBoEYlqAklQqDkw9gQpoJ//Nf/w13TKSU29KUBrEQcY2hFTNX7mOaSM/dGJ8E4LUt6e6829l+0pO+6XV6O8u707BO81bz5pb0quGWGaQEKPyWihnZmJ1SaWl5n9ugxCh6NJwYutdwMIt1+v0RRAXa+hUKMy0Rv/FcQAFnlDPNyou021aBB1IcwX/3VguFwfspamw6kg0k30j1IqrhNA8Xf0R2byl2+ED19bhCeatFt55sXXaG4Ttc/EUwLyRk0T15xLO39r5ifEeaUQaJeKH0l9XNbwOcJtRHo6t9r5mydBaxGWJFCQ1UpGlvlZ16e0FMuFf6y2OkyCzzepMw/aWyGXlK9pxerLQPZQg1xTJmQuT1qxYlKJicNQnKbVph9PuUC7uZJquzuALBqdJeU5g0H+dZTMx2AnU/5eEUpszALaKENa413qEmL28Gqb5lkhuM1qrsPtLISKnP2c7D26o9tjjRzgFwUft7tWqSjoS/EdqCO1ryQgvP1FXduGkoJDb6oc0ruSCDyRD1DROC018VJ9y9gv381SpU1mA0bWBtiIFbgg5WTdAFDkRQotUdj6hDhrY2LHx4emIV8JgGIHhigFhVZcrFCcm2dePXS3zZyIPnbvfF4TPJYre7vFmnWQtRdBv2BWem6PBYI2TWYMxRRG0YyLlr5LjGfZn2A/Wa/ENJbJEgLDhMNGRIwbnD92UxdZUBT0fVP4IDJ49yIH4JB0iedYwR9WM5TjwbTRNje8vtcm8lGhtyJT91J3tL7uT3UnnyPJXL71adjB+McxmcM3Obvv3BZbSMhdAPy5u4qhYvOOx0Op2d7rtdl/RMw+rZuUg1E5uXZGHgQFAPxTjre1v13JAiLZ+dJ1Z4Jgvg58TsT5eElGQG3Rqejt4SdKyyA56O3uvSITCpnXJK+xySBCaaGywMwZQnsJ6l4FejJcvuw5NLNFi848Nz76gk83Hkpth78lSEg5aXEilUo+N0Sz0lrhHlMQdRYNJ7OeFD1/+0Mukmn74k8c6F5LbiVgIl7gVLEjL7x4fnWZagKRqh9r2aN6Zzx5hSPppbpTkTcEyVYgPrg9Hx8gQOS0neQgVA3tlHSavSqj7NwA0VGubFiNPL0RA24VTFKEPBbKpdVupScutNXRnZYj2z0abeqn0Xnf/GZEoMphPTgrESQt0Th95r/Mptyy9BSSmNiWCh7z4ajI5h/Tm2bEDWtHX5e/ta/kKdaiz8kvUcxgmz/JZTp1iraFMybU6dRNJymfq+kcwj87vrel9TGWV9c9duo64Db8SpuvR0+du3Y5b2db9awDpw7xc7Xet9udIyLr3FORoOYb1UESpv6dCncjfAZ69dt8FixcxQ4t5iv2i7Xjs3mEbKz1rLGzOP97J/mjpdWnBSeV1qFWnBaeXVYq/JsPI+t6sb5e4IF04y37VnlZ6VpDVSaFw+DL9yY9uUACc+CEUdJ2aqUhHBlProXJbTYMYMZmDtVFlqn8vi7TXQzPnhdsokWAqQnHs+xZhG+xb0wQd3XqvttM/3YbhteqRl85m8JVX4SKL3Sn2zBK04pT48au7ZqJvzPTLo29vPN8H8bIQ9HjV0c7l4unPkZ6NKONT5utvpbr/rvHmqxvrqaPqFa5jtbHc6nd62w6xeejo4enWcnqpG1TDdfkeY7uaY3vCojuzgw/IGbqq09TgVXdh6FfSuepfb/2iqVR5+eH0mPlYPfeK4LDgQo+PvxLGK0zOWtyFdMzoebPec+8bSqvu2f9lbDTfvkdVsKHke4PvnevWDvIBURSMu9BZQvPfam1sPo+v4danf1p/fhY6An43fSQN+vU6ns/f2bVP995fXx26hxlxDr0fqL6unvqyB7Ikq16sT80SBranatVHOKHnn9ZnSXo073Z1Op/Nme+9p7iwUBV/AolUrgt/PqSXqgxX6H6//ZAWb1979xRpR3ZQ7Ue5sN5Z7Rlf7q2HXVOBZTEMcunPU2955eYHm9RlWXm3ZSs1qmDWWapq4tUNa+92bprrKwftX50xjDaSG4q4Tp97b5Uojr+/rVNerI/3GHYG9R4oZZA9d+vD1jWK1wrGoiAm7Z0x5rRDxv4L8SSPycQPyJTvfUGDwyPd+BvJLuUu9Jh7/ZDSf8ZqeKgB4MKvg+VQN4Afl+L0crYbci1L8i7jud5dN4P8YDq6A5EJ2/vB8noR/Xfl7Wb6+brLekhzsdhsT7IT7PI/+2ti/LOW+aPEfHsgzqn/O/uD/aQVfN+n30M3wF1cIJidBP5ham7jv9m9RUMnl4pgumFCpJlPo3pr+1hZLeDspZYm3/BUWW6UPXoOHVgE09GByoAfHgzLQMNUCNo9g8wtcX1/LzU36vfbipdZorc+tIEY7VXSByAStuxfAToN+sDCcVkZ9l9/XkWrxBF0L6eb984HLJLs2rzumOe0vJRfcJRl0ewPJius4ceO779qddodo51RddO5EdkXIyWAUtGrrqwSl50tb6clWNsls0djSfhIWF0W/9WYlYU9yiDo2Z+Ms410CX+FjpEJTrND0Bfm8BkDpAhhrLPXFCqW+kO93PnCFqgkqeqwLuXVFhmv5t7/BoYxcH7yrcQgx76kOmaTWcuauDcm/vKa586oHZnMdrD/++ONaPrZT2etrSXUqh1VIX5MbODocOQzPz4aj/CoN0/Y/vcgY12uaXVpCnf0If9TvLfkjpya/ocTQ70MWTvPGHYIQ5x+MM0m9a1ol2hW/fx2Nzl0xIjX5/Q7+W3fi1m/Ds9PzAjN3YwK63le6VIRKpx03zPjrVVqwkz1gcMuifB493nGPKfs/piDPUb2bz3YyC6i10m6FRZxok4VR+cJRXi4q6LtV0SxnA322SilEzyJ6WBGYog6RXUviCpvz8W33JTpxnPkSAcaM0zkwaZIobf+DR8jE5nx/Q9VOqcstOzpDP2zh+DRO28qABqT36F3MZOkYHiF9wnDhr+B57Nahb/M7bf7PXUCUWR2LX+1WIhh3ZWHHl2+ZEvyU3akUtIK5GvzcCqaKvkz7FHz7RomCSy0eHuixv6yIlGPEDem3qLhK6FGm/KirjBqJ+YKzypVKrvfbffb7ea6Eg/4nur9niixC7bD30/adHijNWriSqGI8jg5HwcPDvwBAGaPL",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},f=void 0,g={},b=[];function S(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get a Random Postcode"}),"\n",(0,n.jsx)(l(),{method:"get",path:"/random/postcodes",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(c(),{parameters:[{name:"outcode",in:"query",description:"Filters random postcodes by outcode. Returns null if invalid outcode.",style:"form",explode:!1,schema:{title:"Outward code",type:"string",example:"SW1A"}}]}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive location data including geographic coordinates, administrative boundaries, and electoral information for the requested postcode",type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. May be empty for areas without county-level administration.",example:""},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:null},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}}}}}}}})]})}function C(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(S,{...e})}):S(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/735c778a.d2103fc5.js b/build/assets/js/735c778a.d2103fc5.js
new file mode 100644
index 000000000..dd7afebfd
--- /dev/null
+++ b/build/assets/js/735c778a.d2103fc5.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[7110],{54192(e,t,i){i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>S,default:()=>x,frontMatter:()=>f,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"id":"api/random-postcode","title":"Get a Random Postcode","description":"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode.","source":"@site/docs/api/random-postcode.api.mdx","sourceDirName":"api","slug":"/api/random-postcode","permalink":"/docs/api/random-postcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"random-postcode","title":"Get a Random Postcode","description":"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode.","sidebar_label":"Get a Random Postcode","hide_title":true,"hide_table_of_contents":true,"api":"eJzVPO1y2ziSr9LF/WH5SpIl2U5i7Z9zHI/jGX+dJZc3G6cciIREjEGAA4B2dClX3UPcE96TXDVAUiRFSZYS5/ZSNWOJBBrdjUZ/C989Qyba63/2rqQ2vgyo9r40PRlTRQyT4jTw+p4iIpBRNsBregHVvmIxDvD63jU1iRIaCLiBfAqacuobGkCcTgLCpZjAEzMh+DKKFQ2p0OyRwoTKiSJxyPwmkCBigmmDaz/SJhARgDbEMG2YTzgExBAgWkufEYRuwZmQmHydttf0YqJIRA1VSNd3T5CIen1PJhn2DJH+K6FqOkfKb4zjvJSQHKqG0RRSAG3I6BUJ58DGwMQj4SzIB3hNT5spx0XHUkVe06PfYo5r98eEa9r0tB/SiHj9755hxg68TMwTUQGkKJppjE+1UUxMLAASxXbg4LZ76D0/f2l6iupYCk01wul1OvinTM0g8X2qtdf0fCkMFQaHkDjmzLebu/OnxnHfa/DJNhuu01VmSMnRn9Q3HiLwV8IUDVB6cJcSbR/qhBuUoVihFBnmEEwH4BIODBOGTqjympZJxLhHuz2kViSR1//c63S+POcQ56g7KokRl44mJyNM+DwJmJgUxAt8KVXABDFUV0UNRjIRAVHMvhIBWPmVinBgwuGHsMdSgQkpIOVUF+V7BXsKw4pymH74KyGcGZRGSrRhYoKMFFKZMP3sy0QYK64i1Pch8Zqexf/evpjmXwMkiNnV3QOUKa/p4dljJrGLcWKyjzFRnJGICkPU9N6XQuMrKnyLSoL7R8R9zop7RSfIetxaFtkpRNF7oxLt6M3eEsV0iEtpiahG7o9PERXfR3mOx/gkIIbey/E9E0bJIPGNm589NlRFuF3uKRMB/YaPo4QbFnN6H9BYscfs/WJi7nud3h4eSipoEFTprHl6L2TK6pwmY54QY4cN4fcxUQ9e0xsl+JT5I6SMCJ+qe8I5w08p/d1uygH7AZ/0sif2Q/pHJX43/Wu/cxqnf/BAiMQ4MUjVc/lo5cJVc35rdEn5FN38MdPRTtD70GvtgR8SRXxDFaq1XDU1gYCOiZ/qZgK7rdlAJvJx0KDtSbsJqK2gd3i43YabOLA6O5LChHwKYyUjuJZTwuGcMN6e03I4z3ueHZgabXn0EgqHIYUxU9pATJQBOQYyI3lEx1JRe6gtXdAoEa+32zAMmYYJFVQRzqfAAioMGzOq7SyERDgY+SRAKshO4Dw5SEp64guUnIr1CNHUlyKoo4SMcQ8KhBD+RKYadsvUfKQ81hkRU9Ax9dmY+aCNotRopGGUMI66U1v7ykS6CuFAFCVlyrpujzINVpZA5g4L/Id7C6ciQMsj1YzUmRUo07psNjS6rYPtNgxC+eQ2wRkXZAh+I1qziaABTBQLQNExVVT4tH8n7sS/QbcPt44sHJvRms2NiPFDGgAJAkW1Bp9LTbUBI/PdttyOKLHQen041NYudJtAv/k0NugrPDKdWNuB/LWmQ47hjIiAM4GLxBoaA18ajqdICj7dRmC7fTiMYyW/sYgYimumG7DfgYgaRTWO2utDbp0TwYzFBRrkkSoyoYE7WCn+1O0haBLNkLdr7ffhWBu7UIAYX14MINHICZ0ohdYQP+cOEE55U1hYW5uQLh0RJvgUri7hvfxGtYX/rg/DVH8X3cAGJ9rAg8DjgkuWt8jOPOjDhSwaayCPhHEy4vROFIWv+1wwmAXJO54Z0dW+BjpxCNrrG5XQuiN3WcUS0kWh8Y/WDM1t3K+u2ydQVEueIBB0F7mlIhWh94oZpkO4SE0JnCBwlKCT91ap4qBTVT/kAp0CqgScKoqy04ZbxjmMqHNGcchRSISgHE41DtAW5KnmFCXwnIjS8d3f7XT23j4XnY0CHy8KHsjrMDJbFhqf/p9zsvv24GAfBTJz1Qp8PMq9t9X6/eYPmHkiBlJoqePJdOEgHYsJotWETI804ZZw9F+rpDWrlDRRyxco2S7r9BQy6vXU3SwQM0CPmU6YDx8p4SaEw8SEUjn3tUrfapm4+DiA0AEiGSBrZuZJLiN5JkUgBeJY8oSrbN8Mq0pw4GDXYAQXKCtPIU1diJknRTjX6DlphqY5hdDi9JHyAqENnJSIgCo+xWNwMhg494lZu2Ytr6ZJIEEnfghEw9fjg/Tf1yZq6jHxaeBAwFerqdtFfnwtby1S/jwXLBR49mEWQPww1zL4KGxop4iaFkhfsb23VJuICW2omu2xjWYK2N666GZ9TPOQZqeCs3XGVqA2MG34nURUb2lEbRZbFTA7KwRcKXoiiUZlzRnIBLFchfDtyeDdHuTLFCwjNNAStZ7QQYlTh2m7DedkmusxNsYIOA+OE5Hb0hJRrU6723v7Bk1BHh8WyZnFjD+JmhRgiRhrDVpaJib8QXL2u+39zu7+HirkJUFuUZRm8gZXxRlwVA4X1xe2mz8qEIs4rBK2I4ZRnvUercKzRqhyOBZH6kWnKB0Ex3lm49oOgsbx8fX2RpQthvli5V2TSSjGEO4tHBFFYYhvoXF1NNwMW2dmcKGqplpgb+ADG1tPxYAgEepnX4pHDJwkZjvjmE+B+EpqjXvsWK6XqrH5bbnOEwxr0+OAYVaUYrxTzFCVHAU8oWhg4EQ+UiVQCuFyPGY+TXfLBn0nl9d6e+EuuYxOcWfsk50jGUWo2zc7GT57ZBwc8Nyh2UZs/AwuNKxTs72GvWhCIhxMjOMUJVZLYw6qpKCfqIIzMqUKBklMFVwmJk4MHOKEdYnpdXpdOKJCJxrOBpeHaQ5ER4RzqkopbESoCWYa4zc+hW6z0+m0us39Tgd9XRuYY5x+IZ8glkwY6+7aBTCzuZBq6HTfHSGlUYXScxYEnL4KqeczUiMWtDT7T7qU1n1L61v8/w/TiqRiRnHO4Ssoox/yZlKnb5YIDtgj09kZQ2FFqc0D5Jr4YVY9wBhcJgZINQCSmDUDie76Ih2S+myYNy3SypmwPMYTyDTiZR1IJZN4bXLRCV8GENJSAxtx6ijjRNjXBZ2qqXpkPtVIUHqUyxuIq9jQxNovKGiXcaX0wFE3/SaVTzeT0aF1xS2UsYXykoDinBolcZYhAhwOiFxtjrroMaPrIsdwWs5hr49wYFM+xSDiiSAzHVgaIF8/ffr06fw8zdNWEnEH7zqdbhHjYvq8BuFhKbv+s/A1s5zPHL4uWsJt4Gh1Z0enRtyXZ/tLCdSAfrNxbDoQPpTKAj+auMAk1dI1oHF6/mEbK4YP8yK25exBG5y9wUEafKncgQpQ3UWYf3bEpfZKtyEP7tOQPs8V4n/V+B4STQEZFlOBKhVOzz+A9nEm/M9//Tc8Ep5gFk1hwsVAwBT1DZ/aOixRSHrmxrh0A6tsSXfv3d7uUk/aVVjWdqehgfM28+bW9KphRDTFVCv8nvAp2pi9Qs1vfZ+7rpZUzJLY13A0jVTy4xFECVrjlnIdFojfXhVQwCVmZ9O6L+62keCA5Efw785qUa6pzWZUGEKoCqZBAFdUEGXCBQzAstlLeAAXWfD4M7KKazHHha2vwKPu3nOpYlhMo34cZOcZfsDdnwfzQjLmXZUFXr6tcRYQHyqC6SrkhFQPm5viGjh1qA+Ht4dOS1klmKbVIonJDSpR646kCZ3tQCY8SfWwiJRynba4GVki+MoVcDfYhyKEipJxaT9XtGlisoKIaZ11w7JxAan3CeOmlcSbs7gEwarVXl3INBvnWIzMtgL1FDI/hJBoGFEqYIspRR+pQo9vCokaEcE0DbbK7D5RlKCCn7EdC+El22zoRFlnwEbw7+WmCTsU/lpoc65pwSPNvVRb62O6pnxZ65PWr2QDjkqJv+iQ21dwOKv+r09lBUbdBlaGaBghdDByQm0QgQTFSj6yANuYcGv93J/HJ0YCi3AABUcMIKvKTLk+R9k2dnyjwJftLJDudl8cSqMsdrvrm3icNRdRt+GQM6LzNpwtRGYLxozyoA2nYuYmWa65JDp8wIagf0pBmygIc84TDhlgoG7xfVl8XWbA8gj7Z3DgfCEHopdwAOVZRTTApjnLiZWRddqnss4u9zaisSZv8kt3srfmTv4oleerqVx/t6pk/GSci+CsmWu5pgub3dIGfDcs67QrWzzvuNPpdPa67/ZtAtS2ORXzn4kivHWDFgaOOHZujNPmxE3PDSrS4tlZssKKjICbE5E/bUJSoBm0azxnbVovpmOTHXB09F6XDttmVjrlmAI6RgmMFdM0NwQhi6GRpuM3oyXN9MPSJWos3tnxlXNU4tk4dFPME3oq3ELLyooYtuFxGmEni21/WeQg2sa6FxM+sF1XG5Ous+lrEm9dSGZKbiVgEp+TOEazf3Z8lWYMapxM2zRY8cZU5hhj+kcxIxUjHM6wLK2hcTo8W5/AQSHhm6sAyPoJMYFVWNWlHJjGosOsMHFxMxxACy5kRIXPiUmUzVDdCGacqSsim6+nt9vY0XVoI/XfiUiQwXhimjCWnMsn5NB7Rb8x03RLYIJK0ZjbmvloCqfDM2isYss2pK1iN3+078Rv2B9H/Ie00zGKiWEjhv1pzbw5SrcZ9i8Jw0TiulVSj8ztrm1QdhV7BHtnN+rOc0YcK03LS+GuCbSwr4flYtaRfT/fjlxtnhaGMOEsDrYdNArVoeKWDlxadxtcJht3o6Z6pjGJb2g/743funJ9C3bWVtYOepY1L9T11zThvPS60KDShIvSq/kOl0HpfWZXXQxUDCeJ6xU0Uk0L0hpIqm1ujH5j2rQxGY584BL7XHQoEx5AiN17NuOpacoMomHrQhps2kvj7S1QxPrhJiQCDAZI1j0PaYSj3e8ETj/Y81rsD1/Qvl1p7067ufP+atdL7fuTexbkDdZprzAnSW+uBdu1XS9t+17dRv0v0xc91wi9uq/FivqCZtsVeWCsmKJWOCh0POf9OrnqXtADU3WJDtAp2t1d3b70qxF2eFTQzc7W8k6cX40q4lDl636nu/uu82ZZzfrV0XQLVzDb2+10Or1di1m1lHd08uo4LavuVTDdfYeY7meYomqpIHv6YX0nIZTKpK1tWf+82gS9297N7j/rar/HH16fiYvqy0uOy5wTNjz7QRzLOK3wXmpSXsOz092edYHRQhRd4MOb3ma4Oa+24oeg9wau4bFXPchzSJU04lyvBsbMr7251VREFb8udkq78zvXYfGr8Tuvwa/X6XQO3r6tq6f/9vrYzdXsK+j1UP2l9emXNeQtqRq+OjFLCpZ11cPtYlbOBQArvKgKd7p7nU7nze7Bcu7MFVlfwKJNK6w/zqk16q0l+hfX0NKi12vv/nydrWrKrSh3dmtLZsPbw82wqyuSzadyju056u3uvbzI9foMK662brVrM8xqy1113NpDrf3uTV1t6uj9q3Omto5UQXHfilPv7Xrlpdf3dcrrVZF+Y4/AwYKCENpDm4J9faNYrhLNK2LEboUprxRz/k+QP69FPqpBvmDna4o0Dvner0B+LXepV8fjX4zmCq9pWRHFgdkEz2V1lJ9UJ3FytBlyLyqTzON62F23CPJzOLgBknMVjuOrWSHjdeXvZTWPqsl6i3Kw360tUiDus1rEa2P/srLFvMV/fkbPqHoRwbP71/S+tfD7wM5wN7RwIiZe3wuNiW3mckQ5lq2uz/B6BpkoNIX2re7v7JCYteNCpn3H3dWyU/ipsvfczIH6DkwG9OjstAjUTxSH1gm0HuDu7k60Wvh968VLbeFaX5peRE0o8aacCTU2h2pCr+/NDbe3TajH7GKaRPEldM2l7A+vTm023jbKPRLFcH8xuWBvg8FrSlBWbNeOHd991+60O0g7wwqtdSfSu3DOT4des7K+jKlwfGlLNdlJJ+kdHFvYT8TiOu9fb5WKHiiHVEX6cpxWDQrgS3wMpK/zFep++z+ro2C6AMaKFvqMuZQP6Ptdndpi34RKfKxyubWFmjvxt7/BsQjs7wpsnYjzWY+6TwS26hN7P072m3mcO6sc0XSuhfX169c7sWin0td3Amt9Fisf7wHQcHI8tBheXQ6G2Z0xuu2+OpHRtnc3vZ0HfylB4Wv1gp6vGTXZVTwavx8TP8yanxBClP3Unwjs/1MyVraB4ONweGULOonObuZwtxQgt34fXF5c5ZjZuy6o7SXG23Ow/Nyxw7S7R6gJe+kDAiMSZPPw8Z59jBWUMQZ5lur9bLaVWaBKSWVXmMcJN5lrmS0cZCW3nL6RDKYZG/AHx5hCdCzChyWByWs5aX3FFodn49v2DgHkOHElAhoRhudAJ3Eslfl3FlDCW7P99WU7ebAlDnt0Bm7Y3PGpnbaTAvVQ7+G7iIjCMTyh+JOQa3fX1KLrtb7PLm/6l7tpK7U6hn4zOzEnzJbWLV++p0rwc3p5mNf0ZmrwS9MLJf7S77P3/TsmCm4Uf37Gx+5WLlSOAdOo34L8zqyFTPlZd3bVEvNAp6W7w2wvvdf3rNrPlLDX/4wXVYWUBFRZ7N20Q6sHCrPm7t4qGY+T46H3/Py/zk6eSQ==","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Find the Nearest Postcodes","permalink":"/docs/api/nearest-postcode"},"next":{"title":"Terminated Postcodes","permalink":"/docs/api/terminated-postcodes"}}');var n=i(31325),o=i(31736),r=i(47812),s=i.n(r),l=i(38616),d=i.n(l),c=i(67994),p=i.n(c),u=i(54768),h=i.n(u),m=(i(24909),i(96847),i(78121));const f={id:"random-postcode",title:"Get a Random Postcode",description:"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode.",sidebar_label:"Get a Random Postcode",hide_title:!0,hide_table_of_contents:!0,api:"eJzVPO1y2ziSr9LF/WH5SpIl2U5i7Z9zHI/jGX+dJZc3G6cciIREjEGAA4B2dClX3UPcE96TXDVAUiRFSZYS5/ZSNWOJBBrdjUZ/C989Qyba63/2rqQ2vgyo9r40PRlTRQyT4jTw+p4iIpBRNsBregHVvmIxDvD63jU1iRIaCLiBfAqacuobGkCcTgLCpZjAEzMh+DKKFQ2p0OyRwoTKiSJxyPwmkCBigmmDaz/SJhARgDbEMG2YTzgExBAgWkufEYRuwZmQmHydttf0YqJIRA1VSNd3T5CIen1PJhn2DJH+K6FqOkfKb4zjvJSQHKqG0RRSAG3I6BUJ58DGwMQj4SzIB3hNT5spx0XHUkVe06PfYo5r98eEa9r0tB/SiHj9755hxg68TMwTUQGkKJppjE+1UUxMLAASxXbg4LZ76D0/f2l6iupYCk01wul1OvinTM0g8X2qtdf0fCkMFQaHkDjmzLebu/OnxnHfa/DJNhuu01VmSMnRn9Q3HiLwV8IUDVB6cJcSbR/qhBuUoVihFBnmEEwH4BIODBOGTqjympZJxLhHuz2kViSR1//c63S+POcQ56g7KokRl44mJyNM+DwJmJgUxAt8KVXABDFUV0UNRjIRAVHMvhIBWPmVinBgwuGHsMdSgQkpIOVUF+V7BXsKw4pymH74KyGcGZRGSrRhYoKMFFKZMP3sy0QYK64i1Pch8Zqexf/evpjmXwMkiNnV3QOUKa/p4dljJrGLcWKyjzFRnJGICkPU9N6XQuMrKnyLSoL7R8R9zop7RSfIetxaFtkpRNF7oxLt6M3eEsV0iEtpiahG7o9PERXfR3mOx/gkIIbey/E9E0bJIPGNm589NlRFuF3uKRMB/YaPo4QbFnN6H9BYscfs/WJi7nud3h4eSipoEFTprHl6L2TK6pwmY54QY4cN4fcxUQ9e0xsl+JT5I6SMCJ+qe8I5w08p/d1uygH7AZ/0sif2Q/pHJX43/Wu/cxqnf/BAiMQ4MUjVc/lo5cJVc35rdEn5FN38MdPRTtD70GvtgR8SRXxDFaq1XDU1gYCOiZ/qZgK7rdlAJvJx0KDtSbsJqK2gd3i43YabOLA6O5LChHwKYyUjuJZTwuGcMN6e03I4z3ueHZgabXn0EgqHIYUxU9pATJQBOQYyI3lEx1JRe6gtXdAoEa+32zAMmYYJFVQRzqfAAioMGzOq7SyERDgY+SRAKshO4Dw5SEp64guUnIr1CNHUlyKoo4SMcQ8KhBD+RKYadsvUfKQ81hkRU9Ax9dmY+aCNotRopGGUMI66U1v7ykS6CuFAFCVlyrpujzINVpZA5g4L/Id7C6ciQMsj1YzUmRUo07psNjS6rYPtNgxC+eQ2wRkXZAh+I1qziaABTBQLQNExVVT4tH8n7sS/QbcPt44sHJvRms2NiPFDGgAJAkW1Bp9LTbUBI/PdttyOKLHQen041NYudJtAv/k0NugrPDKdWNuB/LWmQ47hjIiAM4GLxBoaA18ajqdICj7dRmC7fTiMYyW/sYgYimumG7DfgYgaRTWO2utDbp0TwYzFBRrkkSoyoYE7WCn+1O0haBLNkLdr7ffhWBu7UIAYX14MINHICZ0ohdYQP+cOEE55U1hYW5uQLh0RJvgUri7hvfxGtYX/rg/DVH8X3cAGJ9rAg8DjgkuWt8jOPOjDhSwaayCPhHEy4vROFIWv+1wwmAXJO54Z0dW+BjpxCNrrG5XQuiN3WcUS0kWh8Y/WDM1t3K+u2ydQVEueIBB0F7mlIhWh94oZpkO4SE0JnCBwlKCT91ap4qBTVT/kAp0CqgScKoqy04ZbxjmMqHNGcchRSISgHE41DtAW5KnmFCXwnIjS8d3f7XT23j4XnY0CHy8KHsjrMDJbFhqf/p9zsvv24GAfBTJz1Qp8PMq9t9X6/eYPmHkiBlJoqePJdOEgHYsJotWETI804ZZw9F+rpDWrlDRRyxco2S7r9BQy6vXU3SwQM0CPmU6YDx8p4SaEw8SEUjn3tUrfapm4+DiA0AEiGSBrZuZJLiN5JkUgBeJY8oSrbN8Mq0pw4GDXYAQXKCtPIU1diJknRTjX6DlphqY5hdDi9JHyAqENnJSIgCo+xWNwMhg494lZu2Ytr6ZJIEEnfghEw9fjg/Tf1yZq6jHxaeBAwFerqdtFfnwtby1S/jwXLBR49mEWQPww1zL4KGxop4iaFkhfsb23VJuICW2omu2xjWYK2N666GZ9TPOQZqeCs3XGVqA2MG34nURUb2lEbRZbFTA7KwRcKXoiiUZlzRnIBLFchfDtyeDdHuTLFCwjNNAStZ7QQYlTh2m7DedkmusxNsYIOA+OE5Hb0hJRrU6723v7Bk1BHh8WyZnFjD+JmhRgiRhrDVpaJib8QXL2u+39zu7+HirkJUFuUZRm8gZXxRlwVA4X1xe2mz8qEIs4rBK2I4ZRnvUercKzRqhyOBZH6kWnKB0Ex3lm49oOgsbx8fX2RpQthvli5V2TSSjGEO4tHBFFYYhvoXF1NNwMW2dmcKGqplpgb+ADG1tPxYAgEepnX4pHDJwkZjvjmE+B+EpqjXvsWK6XqrH5bbnOEwxr0+OAYVaUYrxTzFCVHAU8oWhg4EQ+UiVQCuFyPGY+TXfLBn0nl9d6e+EuuYxOcWfsk50jGUWo2zc7GT57ZBwc8Nyh2UZs/AwuNKxTs72GvWhCIhxMjOMUJVZLYw6qpKCfqIIzMqUKBklMFVwmJk4MHOKEdYnpdXpdOKJCJxrOBpeHaQ5ER4RzqkopbESoCWYa4zc+hW6z0+m0us39Tgd9XRuYY5x+IZ8glkwY6+7aBTCzuZBq6HTfHSGlUYXScxYEnL4KqeczUiMWtDT7T7qU1n1L61v8/w/TiqRiRnHO4Ssoox/yZlKnb5YIDtgj09kZQ2FFqc0D5Jr4YVY9wBhcJgZINQCSmDUDie76Ih2S+myYNy3SypmwPMYTyDTiZR1IJZN4bXLRCV8GENJSAxtx6ijjRNjXBZ2qqXpkPtVIUHqUyxuIq9jQxNovKGiXcaX0wFE3/SaVTzeT0aF1xS2UsYXykoDinBolcZYhAhwOiFxtjrroMaPrIsdwWs5hr49wYFM+xSDiiSAzHVgaIF8/ffr06fw8zdNWEnEH7zqdbhHjYvq8BuFhKbv+s/A1s5zPHL4uWsJt4Gh1Z0enRtyXZ/tLCdSAfrNxbDoQPpTKAj+auMAk1dI1oHF6/mEbK4YP8yK25exBG5y9wUEafKncgQpQ3UWYf3bEpfZKtyEP7tOQPs8V4n/V+B4STQEZFlOBKhVOzz+A9nEm/M9//Tc8Ep5gFk1hwsVAwBT1DZ/aOixRSHrmxrh0A6tsSXfv3d7uUk/aVVjWdqehgfM28+bW9KphRDTFVCv8nvAp2pi9Qs1vfZ+7rpZUzJLY13A0jVTy4xFECVrjlnIdFojfXhVQwCVmZ9O6L+62keCA5Efw785qUa6pzWZUGEKoCqZBAFdUEGXCBQzAstlLeAAXWfD4M7KKazHHha2vwKPu3nOpYlhMo34cZOcZfsDdnwfzQjLmXZUFXr6tcRYQHyqC6SrkhFQPm5viGjh1qA+Ht4dOS1klmKbVIonJDSpR646kCZ3tQCY8SfWwiJRynba4GVki+MoVcDfYhyKEipJxaT9XtGlisoKIaZ11w7JxAan3CeOmlcSbs7gEwarVXl3INBvnWIzMtgL1FDI/hJBoGFEqYIspRR+pQo9vCokaEcE0DbbK7D5RlKCCn7EdC+El22zoRFlnwEbw7+WmCTsU/lpoc65pwSPNvVRb62O6pnxZ65PWr2QDjkqJv+iQ21dwOKv+r09lBUbdBlaGaBghdDByQm0QgQTFSj6yANuYcGv93J/HJ0YCi3AABUcMIKvKTLk+R9k2dnyjwJftLJDudl8cSqMsdrvrm3icNRdRt+GQM6LzNpwtRGYLxozyoA2nYuYmWa65JDp8wIagf0pBmygIc84TDhlgoG7xfVl8XWbA8gj7Z3DgfCEHopdwAOVZRTTApjnLiZWRddqnss4u9zaisSZv8kt3srfmTv4oleerqVx/t6pk/GSci+CsmWu5pgub3dIGfDcs67QrWzzvuNPpdPa67/ZtAtS2ORXzn4kivHWDFgaOOHZujNPmxE3PDSrS4tlZssKKjICbE5E/bUJSoBm0azxnbVovpmOTHXB09F6XDttmVjrlmAI6RgmMFdM0NwQhi6GRpuM3oyXN9MPSJWos3tnxlXNU4tk4dFPME3oq3ELLyooYtuFxGmEni21/WeQg2sa6FxM+sF1XG5Ous+lrEm9dSGZKbiVgEp+TOEazf3Z8lWYMapxM2zRY8cZU5hhj+kcxIxUjHM6wLK2hcTo8W5/AQSHhm6sAyPoJMYFVWNWlHJjGosOsMHFxMxxACy5kRIXPiUmUzVDdCGacqSsim6+nt9vY0XVoI/XfiUiQwXhimjCWnMsn5NB7Rb8x03RLYIJK0ZjbmvloCqfDM2isYss2pK1iN3+078Rv2B9H/Ie00zGKiWEjhv1pzbw5SrcZ9i8Jw0TiulVSj8ztrm1QdhV7BHtnN+rOc0YcK03LS+GuCbSwr4flYtaRfT/fjlxtnhaGMOEsDrYdNArVoeKWDlxadxtcJht3o6Z6pjGJb2g/743funJ9C3bWVtYOepY1L9T11zThvPS60KDShIvSq/kOl0HpfWZXXQxUDCeJ6xU0Uk0L0hpIqm1ujH5j2rQxGY584BL7XHQoEx5AiN17NuOpacoMomHrQhps2kvj7S1QxPrhJiQCDAZI1j0PaYSj3e8ETj/Y81rsD1/Qvl1p7067ufP+atdL7fuTexbkDdZprzAnSW+uBdu1XS9t+17dRv0v0xc91wi9uq/FivqCZtsVeWCsmKJWOCh0POf9OrnqXtADU3WJDtAp2t1d3b70qxF2eFTQzc7W8k6cX40q4lDl636nu/uu82ZZzfrV0XQLVzDb2+10Or1di1m1lHd08uo4LavuVTDdfYeY7meYomqpIHv6YX0nIZTKpK1tWf+82gS9297N7j/rar/HH16fiYvqy0uOy5wTNjz7QRzLOK3wXmpSXsOz092edYHRQhRd4MOb3ma4Oa+24oeg9wau4bFXPchzSJU04lyvBsbMr7251VREFb8udkq78zvXYfGr8Tuvwa/X6XQO3r6tq6f/9vrYzdXsK+j1UP2l9emXNeQtqRq+OjFLCpZ11cPtYlbOBQArvKgKd7p7nU7nze7Bcu7MFVlfwKJNK6w/zqk16q0l+hfX0NKi12vv/nydrWrKrSh3dmtLZsPbw82wqyuSzadyju056u3uvbzI9foMK662brVrM8xqy1113NpDrf3uTV1t6uj9q3Omto5UQXHfilPv7Xrlpdf3dcrrVZF+Y4/AwYKCENpDm4J9faNYrhLNK2LEboUprxRz/k+QP69FPqpBvmDna4o0Dvner0B+LXepV8fjX4zmCq9pWRHFgdkEz2V1lJ9UJ3FytBlyLyqTzON62F23CPJzOLgBknMVjuOrWSHjdeXvZTWPqsl6i3Kw360tUiDus1rEa2P/srLFvMV/fkbPqHoRwbP71/S+tfD7wM5wN7RwIiZe3wuNiW3mckQ5lq2uz/B6BpkoNIX2re7v7JCYteNCpn3H3dWyU/ipsvfczIH6DkwG9OjstAjUTxSH1gm0HuDu7k60Wvh968VLbeFaX5peRE0o8aacCTU2h2pCr+/NDbe3TajH7GKaRPEldM2l7A+vTm023jbKPRLFcH8xuWBvg8FrSlBWbNeOHd991+60O0g7wwqtdSfSu3DOT4des7K+jKlwfGlLNdlJJ+kdHFvYT8TiOu9fb5WKHiiHVEX6cpxWDQrgS3wMpK/zFep++z+ro2C6AMaKFvqMuZQP6Ptdndpi34RKfKxyubWFmjvxt7/BsQjs7wpsnYjzWY+6TwS26hN7P072m3mcO6sc0XSuhfX169c7sWin0td3Amt9Fisf7wHQcHI8tBheXQ6G2Z0xuu2+OpHRtnc3vZ0HfylB4Wv1gp6vGTXZVTwavx8TP8yanxBClP3Unwjs/1MyVraB4ONweGULOonObuZwtxQgt34fXF5c5ZjZuy6o7SXG23Ow/Nyxw7S7R6gJe+kDAiMSZPPw8Z59jBWUMQZ5lur9bLaVWaBKSWVXmMcJN5lrmS0cZCW3nL6RDKYZG/AHx5hCdCzChyWByWs5aX3FFodn49v2DgHkOHElAhoRhudAJ3Eslfl3FlDCW7P99WU7ebAlDnt0Bm7Y3PGpnbaTAvVQ7+G7iIjCMTyh+JOQa3fX1KLrtb7PLm/6l7tpK7U6hn4zOzEnzJbWLV++p0rwc3p5mNf0ZmrwS9MLJf7S77P3/TsmCm4Uf37Gx+5WLlSOAdOo34L8zqyFTPlZd3bVEvNAp6W7w2wvvdf3rNrPlLDX/4wXVYWUBFRZ7N20Q6sHCrPm7t4qGY+T46H3/Py/zk6eSQ==",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},S=void 0,y={},g=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get a Random Postcode"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/random/postcodes",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Returns a randomly selected postcode along with comprehensive geographic, administrative, and statistical data associated with that postcode."}),"\n",(0,n.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"outcode",in:"query",description:"Filters random postcodes by outcode. Returns null if invalid outcode.",style:"form",explode:!1,schema:{title:"Outward code",type:"string",example:"SW1A"}}]}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Postcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive location data including geographic coordinates, administrative boundaries, and electoral information for the requested postcode",type:"object",required:["postcode","outcode","incode","quality","eastings","northings","country","nhs_ha","admin_county","admin_district","admin_ward","longitude","latitude","parliamentary_constituency","european_electoral_region","primary_care_trust","region","parish","lsoa","msoa","ced","ccg","pfa","date_of_introduction","date_of_termination","index_of_multiple_deprivation","parliamentary_constituency_2024","senedd_constituency","senedd_constituency_no","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2","nuts","codes"],properties:{postcode:{title:"Postcode",type:"string",description:"UK postcode format: 2-4 character outward code, a space, and a 3-character inward code (e.g., SW1A 2AA). Updated monthly from Royal Mail.",example:"SW1A 2AA"},outcode:{title:"Outward Code",type:"string",description:"The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district.",example:"SW1A"},incode:{title:"Inward Code",type:"string",description:"The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area.",example:"1AA"},quality:{title:"Positional Quality Indicator",type:"integer",description:"Positional Quality Indicator (1-9). Shows the status of the assigned grid reference:\n\n* 1: Within the building of the matched address closest to the postcode mean\n* 2: As for 1, except by visual inspection of Landline maps (Scotland only)\n* 3: Approximate to within 50 metres\n* 4: Postcode unit mean (averaged from addresses with same postcode)\n* 5: Estimated by ONS using surrounding postcodes\n* 6: Postcode sector mean (mainly PO Boxes)\n* 8: Terminated postcode (last known ONS grid reference)\n* 9: No coordinates available\n",example:1},eastings:{title:"Eastings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference easting (X-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:530047},northings:{title:"Northings",type:"integer",format:"int32",nullable:!0,description:"The OS grid reference northing (Y-coordinate) to 1 metre resolution. Relates to the British National Grid for GB and the Irish National Grid for Northern Ireland. Will be null for Channel Islands and Isle of Man.",example:179951},country:{title:"Country",type:"string",description:"The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man).",example:"England"},nhs_ha:{title:"Strategic Health Authority",type:"string",nullable:!0,description:"The NHS health authority area for this postcode.",example:"London"},admin_county:{title:"County",type:"string",nullable:!0,description:"The administrative county for this postcode. Null where the postcode falls outside a county-level authority (the underlying GSS code is then a pseudo such as `E99999999`, surfaced under `codes.admin_county`).",example:null},admin_district:{title:"District",type:"string",nullable:!0,description:"The administrative district or unitary authority for this postcode.",example:"Westminster"},admin_ward:{title:"Ward",type:"string",nullable:!0,description:"The electoral/administrative ward for this postcode.",example:"St. James's"},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable.",example:-.12767},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable.",example:51.503541},parliamentary_constituency:{title:"Westminster Parliamentary Constituency",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode.",example:"Cities of London and Westminster"},european_electoral_region:{title:"European Electoral Region (EER)",type:"string",nullable:!0,description:"The European Electoral Region for this postcode.",example:"London"},primary_care_trust:{title:"Primary Care Trust (PCT)",type:"string",nullable:!0,description:"The healthcare administrative area for this postcode. Different naming conventions apply across UK regions.",example:"Westminster"},region:{title:"Region",type:"string",nullable:!0,description:"The regional designation for this postcode (formerly Government Office Regions or GORs).",example:"London"},parish:{title:"Parish/Community",type:"string",nullable:!0,description:"The civil parish (England) or community (Wales) for this postcode.",example:"Westminster, unparished area"},lsoa:{title:"Lower Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data.",example:"Westminster 018C"},msoa:{title:"Middle Layer Super Output Area",type:"string",nullable:!0,description:"2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data.",example:"Westminster 018"},ced:{title:"County Electoral District",type:"string",nullable:!0,description:"The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions.",example:null},ccg:{title:"Clinical Commissioning Group",type:"string",nullable:!0,description:"NHS Clinical Commissioning Group responsible for planning healthcare services in England.",example:"NHS North West London"},pfa:{title:"Police Force Area",type:"string",nullable:!0,description:"The police force area for this postcode.",example:"Metropolitan Police"},date_of_introduction:{title:"Date of Introduction",type:"string",nullable:!0,description:"The date the postcode was introduced in YYYYMM format.",example:"198001"},date_of_termination:{title:"Date of Termination",type:"string",nullable:!0,description:"The date the postcode was terminated in YYYYMM format. Null for live postcodes.",example:null},index_of_multiple_deprivation:{title:"Index of Multiple Deprivation",type:"integer",format:"int32",nullable:!0,description:"ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales \u2014 values are not directly comparable across countries.",example:14843},parliamentary_constituency_2024:{title:"Westminster Parliamentary Constituency (2024)",type:"string",nullable:!0,description:"The UK Parliamentary constituency for this postcode based on July 2024 boundaries.",example:"Cities of London and Westminster"},senedd_constituency:{title:"Senedd Cymru Constituency",type:"string",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:"Caerdydd Penarth"},senedd_constituency_no:{title:"Senedd Cymru Constituency Number",type:"integer",format:"int32",nullable:!0,description:"The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere.",example:14},nhs_region:{title:"NHS England Region",type:"string",nullable:!0,description:"The NHS England Region for this postcode. Only applicable to English postcodes.",example:"London"},ttwa:{title:"Travel to Work Area",type:"string",nullable:!0,description:"The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work.",example:"London"},national_park:{title:"National Park",type:"string",nullable:!0,description:"The National Park this postcode falls within, if any.",example:null},bua:{title:"Built-up Area",type:"string",nullable:!0,description:"The Built-up Area (2022) for this postcode. Built-up areas are land which has been 'irreversibly urbanised'.",example:"Greater London"},icb:{title:"Integrated Care Board",type:"string",nullable:!0,description:"The NHS Integrated Care Board responsible for healthcare planning in this area.",example:"NHS North West London Integrated Care Board"},cancer_alliance:{title:"Cancer Alliance",type:"string",nullable:!0,description:"The Cancer Alliance for this postcode. Cancer Alliances bring together NHS providers and commissioners to improve cancer care.",example:"RM Partners (West London)"},lsoa11:{title:"Lower Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census LSOA code. Alias for the 'lsoa' field. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa11:{title:"Middle Layer Super Output Area (2011)",type:"string",nullable:!0,description:"2011 Census MSOA code. Alias for the 'msoa' field. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},lsoa21:{title:"Lower Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area.",example:"Westminster 018C"},msoa21:{title:"Middle Layer Super Output Area (2021)",type:"string",nullable:!0,description:"2021 Census MSOA code. In Scotland this is the Intermediate Zone.",example:"Westminster 018"},oa21:{title:"Output Area (2021)",type:"string",nullable:!0,description:"2021 Census Output Area code - the smallest census geography.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification (2011)",type:"string",nullable:!0,description:"The 2011 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},ruc21:{title:"Rural-Urban Classification (2021)",type:"string",nullable:!0,description:"The 2021 Census Rural-Urban Classification for this postcode.",example:"Urban major conurbation"},lep1:{title:"Local Enterprise Partnership (Primary)",type:"string",nullable:!0,description:"The primary Local Enterprise Partnership for this postcode. LEPs are partnerships between local authorities and businesses.",example:"London"},lep2:{title:"Local Enterprise Partnership (Secondary)",type:"string",nullable:!0,description:"The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas.",example:null},nuts:{title:"International Territorial Levels (ITL)",type:"string",nullable:!0,description:'Statistical geography code for international comparisons (formerly NUTS - Nomenclature of Units for Territorial Statistics).\n\nAs of January 2021, following Brexit, NUTS was replaced by ITL (International Territorial Levels) in the UK.\nFor backward compatibility, Postcodes.io continues to provide this data under the "nuts" field name.',example:"Westminster"},codes:{title:"Administrative Codes",type:"object",description:"Contains the GSS (Government Statistical Service) codes for administrative areas. Note: Returns 'Pseudo codes' (e.g., L99999999 for Channel Islands, M99999999 for Isle of Man, N99999999 for Northern Ireland, S99999999 for Scotland) for areas where a statutory geography does not exist. Client logic should handle these codes as 'Not Applicable' rather than treating them as valid IDs.",required:["admin_district","admin_county","admin_ward","parish","ccg","ccg_id","ced","nuts","lau2","lsoa","msoa","pfa","parliamentary_constituency","parliamentary_constituency_2024","nhs_region","ttwa","national_park","bua","icb","cancer_alliance","lsoa11","msoa11","lsoa21","msoa21","oa21","ruc11","ruc21","lep1","lep2"],properties:{admin_district:{title:"District GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative district.",example:"E09000033"},admin_county:{title:"County GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative county.",example:"E99999999"},admin_ward:{title:"Ward GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this administrative ward.",example:"E05013806"},parish:{title:"Parish GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this parish.",example:"E43000236"},ccg:{title:"CCG GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Clinical Commissioning Group.",example:"E38000256"},ccg_id:{title:"CCG ID",type:"string",nullable:!0,description:"Short code identifier for this Clinical Commissioning Group.",example:"W2U3Z"},ced:{title:"CED GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this County Electoral District.",example:"E99999999"},nuts:{title:"ITL Code",type:"string",nullable:!0,description:"Official code for this International Territorial Level area.",example:"TLI32"},lau2:{title:"LAU2 Code",type:"string",nullable:!0,description:"Local Administrative Unit level 2 code for this area.",example:"E09000033"},lsoa:{title:"LSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa:{title:"MSOA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},pfa:{title:"PFA GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Police Force Area.",example:"E23000001"},parliamentary_constituency:{title:"Parliamentary Constituency GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024.",example:"E14000639"},parliamentary_constituency_2024:{title:"Parliamentary Constituency GSS Code (2024)",type:"string",nullable:!0,description:"Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries.",example:"E14000639"},nhs_region:{title:"NHS Region GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this NHS England Region.",example:"E40000003"},ttwa:{title:"TTWA Code",type:"string",nullable:!0,description:"Travel to Work Area code.",example:"E30000234"},national_park:{title:"National Park GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this National Park.",example:null},bua:{title:"Built-up Area Code",type:"string",nullable:!0,description:"Built-up Area (2022) code.",example:"E34004786"},icb:{title:"ICB GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Integrated Care Board.",example:"E54000027"},cancer_alliance:{title:"Cancer Alliance GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this Cancer Alliance.",example:"E56000009"},lsoa11:{title:"LSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa.",example:"E01004736"},msoa11:{title:"MSOA 2011 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa.",example:"E02000977"},lsoa21:{title:"LSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census LSOA.",example:"E01004736"},msoa21:{title:"MSOA 2021 GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for this 2021 Census MSOA.",example:"E02000977"},oa21:{title:"Output Area 2021 Code",type:"string",nullable:!0,description:"2021 Census Output Area code.",example:"E00004185"},ruc11:{title:"Rural-Urban Classification 2011 Code",type:"string",nullable:!0,description:"2011 Census Rural-Urban Classification code.",example:"A1"},ruc21:{title:"Rural-Urban Classification 2021 Code",type:"string",nullable:!0,description:"2021 Census Rural-Urban Classification code.",example:"A1"},lep1:{title:"LEP (Primary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the primary Local Enterprise Partnership.",example:"E37000051"},lep2:{title:"LEP (Secondary) GSS Code",type:"string",nullable:!0,description:"Official 9-character GSS code for the secondary Local Enterprise Partnership.",example:null}}}},title:"Postcode"}}}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/7c98d41e.480c0f75.js b/build/assets/js/7c98d41e.480c0f75.js
new file mode 100644
index 000000000..20dce4296
--- /dev/null
+++ b/build/assets/js/7c98d41e.480c0f75.js
@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[3512],{21703(e,t,i){i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>y,default:()=>W,frontMatter:()=>h,metadata:()=>a,toc:()=>f});const a=JSON.parse('{"id":"api/find-outcode","title":"Find an Outward Code","description":"Returns aggregated information for postcodes grouped by their shared outward code.","source":"@site/docs/api/find-outcode.api.mdx","sourceDirName":"api","slug":"/api/find-outcode","permalink":"/docs/api/find-outcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"find-outcode","title":"Find an Outward Code","description":"Returns aggregated information for postcodes grouped by their shared outward code.","sidebar_label":"Find an Outward Code","hide_title":true,"hide_table_of_contents":true,"api":"eJzlWFtvG7cS/isDFjixgPVKduQ0FVCc47pumtSJDcuGHyyjpnZHu2y45JYXO4Kw//1guBetJMdwc/J2/GItLzPfDL8ZznDFHM8sm9yyc+8euUnhRKdo2V3EUrSJEaUTWrEJu0TnjbLAs8xgxh2mINRCm4LTAlhoA6W2LqHdkBntS0xhvgSXozBgc24wBd3ooFXxTM3UVY4bgyAs7YCFMNZBzuUC9AK4WnbCYe/1/hiSnBueODQWuEphoaXUj7VCDrbkCQ5iOI2zGO6nNwfH963cDV2EOUzDwfHxfTxTLGK6RBMsep+yCftNqPTcB70sYiU3vEBSyia3K6Z4gWzCdDcvyE8ldznbdt60xEQsBD4BYqk9PAqbg9Pwt0ezjFnEDP7thcGUTZzxGDH8wotSkjaCyyJm3TJ8WhHGaUUpCcVkwaXFiNkkx4KzyYq5ZRlWOiNUxqrqjsTbUiuLluYPRyP6twXYJwlayyKWaOVQOVrCy1KKJHhn+Jeldau+HuECpMZfcNkoYVELQc//wsRtmHfLrOPO2zBovXREvNLQKThR42sWrC0RymGGhkWspl899PqQvKB8wSa3h6PRXdVJ3DHuRBelwRyVFQ8IGerM8DIXCZeBTDwthBLWEQ8eEFLueKAKHZ1tDjJQmcyMQKhE+lSoDKSunQOJ1iYViju00ba4ufYq5UaEKZWCQRmCifjNZT+miI0KzxeBbH2XrRmH3DqhMnKf0sblze+g8s9Ee+WW3WdKGETwfz1AHGQRk1plwvkgT3LX/gy7zbKmvbB5/UMKXqBy3Cz/TLSytBpVstw9tRbjLjHWfGgouR0sv4XYL7lxFPvk9S7257jQBpuT4AnCHsZZHMEsxMWMgVDNbwrpGRvEcG09l3IJhxtZI2Y7QVX13NlDfbp2cQNb+WL+NP2Ul5LPaVsdtpt2nZtUcZUgTL15wCW02np0gb2DAgxaLT1tGsTQpt0RiMWaYF7xBy6Crg1Ljg5/+nE8qvps6JnyqUeR72xLp+87GnPwdjR686baonPPnuPNyDpp+d7Yxo3h9CkcFvaJTLht05a4oI9S9qMg08DlwrZRv4Hzlu2VFn2qB3CqMklBvXd9PPz46/DslwG7q3YCsGfCr+ug/EbUrYShV4LiErh3uTbihdBv0LpCKOsCC264Su0jnWUPd8gTPcw3dd74Ll4eosTEacMlkJqXIP4kFMKpLIjFUxfDB16gfWUD4HUu6+E96yW4r9I+1X4eLtLneX/zbvp2DJ2aHttj+MiXMEcgAS/i9/4oPnh9WFO8S7x93Otk/J1gNwL/J9RHB/HRaPxmXK2viB7mk+7W+EZ61AJext0m2sLJN5dUD8pFe219I5J6P1rYa/QMQBtIdFFQpBHCvRsu0Q5eEmVdXEXgVY0VU+AGOUXdOgZ3pxvjvnbxbhq8XgUn/VXf7ITrP2BTbE95cMEHT3fr6HDcK2wG4HLugOo0YzFxz3nmpHalXsCZVqlWoSbaTEq/cBcEkS+qaKecqO6q+i9iX/ZpZBqE1zW65CpjE5Y7V4byZo6SrLo8oxpae5NgM2snwyEvRdz1MLHQwwayHdrHAz5TrIo6iUkto5V4cva+LzHxRsL+O9j/DLPZTAHs79PIq5dperWpagv8J+QGrYN/asS/pVY/U845/PHNT0f/ktz9HGL59dH4WdNafc+b+FIDn0ERzL6LWIEu19R9ZehC1elyNmFrF62aXxXBQfPQ9mPeyGf8sFNmHl+8h2nYziL2wI2gVEcxEVokqsMpPkh6vf7gbTyKR+QYkSD1NZOuBfz4/opFW/p1iap2VqxNNmw22SGt7bGYUFziAg1SNbUPF5uQHZrCni8Ip9g45g3npjqxnYYdQ/siqQ/msDDYK6ql1p99CYSEgi9DTcOm63mu/wit+g8/wKlKSy2Uo89jKcHWsCwkXNElwkPTiCksjC7qPj405tQcYbM3yLq/v5+pr51UM10/DgRUSYKls/Du9CogvDifXgE1RGidjevPmjQWvKXrLbSsQLkN7re71vvWmrZBtfR9ypMc2r6YsnxzAwFXwEvqbYygmvb3q6sLmIaWtO7f9/ALoQve+jA9/3TRIRvEcJWjxaZDRDgcjcIyWzfXEYybAQ5znrb7aHgchpUmsZ5aUpXCUbs7cBbQGG2Chl1MdMjS6lYxvdSE0+jsm+t02brh2LsclWtcRIMbhEk12oCk6UBDfbleX7+akMd5XdliwQXFgfVlqY37j0iRy/31+SY69p+pYKlDZ1ov2wmfJ7cNG6GMkj3NFVz1wpBea+i8+i9Z29GwWj9o/L88aTVXvMMvblhKLijZ195eNcm1e1Kg5DFpW/e7iOXaOpperebc4rWRVUXD4Z2KTW7v1okzZOBUWPqddq9QX3X93mXznjGAf/o29qQ5bXmjliGZS09fLGKfcdl7oquomMqRp2gC3nr2OKSX3r6dd66NW+nd6RWrqv8Cn1dZBQ==","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Outward Codes","permalink":"/docs/api/outward-codes"},"next":{"title":"Places","permalink":"/docs/api/places"}}');var n=i(31325),o=i(31736),s=i(47812),r=i.n(s),d=i(38616),c=i.n(d),p=i(67994),l=i.n(p),u=i(54768),m=i.n(u),g=(i(24909),i(96847),i(78121));const h={id:"find-outcode",title:"Find an Outward Code",description:"Returns aggregated information for postcodes grouped by their shared outward code.",sidebar_label:"Find an Outward Code",hide_title:!0,hide_table_of_contents:!0,api:"eJzlWFtvG7cS/isDFjixgPVKduQ0FVCc47pumtSJDcuGHyyjpnZHu2y45JYXO4Kw//1guBetJMdwc/J2/GItLzPfDL8ZznDFHM8sm9yyc+8euUnhRKdo2V3EUrSJEaUTWrEJu0TnjbLAs8xgxh2mINRCm4LTAlhoA6W2LqHdkBntS0xhvgSXozBgc24wBd3ooFXxTM3UVY4bgyAs7YCFMNZBzuUC9AK4WnbCYe/1/hiSnBueODQWuEphoaXUj7VCDrbkCQ5iOI2zGO6nNwfH963cDV2EOUzDwfHxfTxTLGK6RBMsep+yCftNqPTcB70sYiU3vEBSyia3K6Z4gWzCdDcvyE8ldznbdt60xEQsBD4BYqk9PAqbg9Pwt0ezjFnEDP7thcGUTZzxGDH8wotSkjaCyyJm3TJ8WhHGaUUpCcVkwaXFiNkkx4KzyYq5ZRlWOiNUxqrqjsTbUiuLluYPRyP6twXYJwlayyKWaOVQOVrCy1KKJHhn+Jeldau+HuECpMZfcNkoYVELQc//wsRtmHfLrOPO2zBovXREvNLQKThR42sWrC0RymGGhkWspl899PqQvKB8wSa3h6PRXdVJ3DHuRBelwRyVFQ8IGerM8DIXCZeBTDwthBLWEQ8eEFLueKAKHZ1tDjJQmcyMQKhE+lSoDKSunQOJ1iYViju00ba4ufYq5UaEKZWCQRmCifjNZT+miI0KzxeBbH2XrRmH3DqhMnKf0sblze+g8s9Ee+WW3WdKGETwfz1AHGQRk1plwvkgT3LX/gy7zbKmvbB5/UMKXqBy3Cz/TLSytBpVstw9tRbjLjHWfGgouR0sv4XYL7lxFPvk9S7257jQBpuT4AnCHsZZHMEsxMWMgVDNbwrpGRvEcG09l3IJhxtZI2Y7QVX13NlDfbp2cQNb+WL+NP2Ul5LPaVsdtpt2nZtUcZUgTL15wCW02np0gb2DAgxaLT1tGsTQpt0RiMWaYF7xBy6Crg1Ljg5/+nE8qvps6JnyqUeR72xLp+87GnPwdjR686baonPPnuPNyDpp+d7Yxo3h9CkcFvaJTLht05a4oI9S9qMg08DlwrZRv4Hzlu2VFn2qB3CqMklBvXd9PPz46/DslwG7q3YCsGfCr+ug/EbUrYShV4LiErh3uTbihdBv0LpCKOsCC264Su0jnWUPd8gTPcw3dd74Ll4eosTEacMlkJqXIP4kFMKpLIjFUxfDB16gfWUD4HUu6+E96yW4r9I+1X4eLtLneX/zbvp2DJ2aHttj+MiXMEcgAS/i9/4oPnh9WFO8S7x93Otk/J1gNwL/J9RHB/HRaPxmXK2viB7mk+7W+EZ61AJext0m2sLJN5dUD8pFe219I5J6P1rYa/QMQBtIdFFQpBHCvRsu0Q5eEmVdXEXgVY0VU+AGOUXdOgZ3pxvjvnbxbhq8XgUn/VXf7ITrP2BTbE95cMEHT3fr6HDcK2wG4HLugOo0YzFxz3nmpHalXsCZVqlWoSbaTEq/cBcEkS+qaKecqO6q+i9iX/ZpZBqE1zW65CpjE5Y7V4byZo6SrLo8oxpae5NgM2snwyEvRdz1MLHQwwayHdrHAz5TrIo6iUkto5V4cva+LzHxRsL+O9j/DLPZTAHs79PIq5dperWpagv8J+QGrYN/asS/pVY/U845/PHNT0f/ktz9HGL59dH4WdNafc+b+FIDn0ERzL6LWIEu19R9ZehC1elyNmFrF62aXxXBQfPQ9mPeyGf8sFNmHl+8h2nYziL2wI2gVEcxEVokqsMpPkh6vf7gbTyKR+QYkSD1NZOuBfz4/opFW/p1iap2VqxNNmw22SGt7bGYUFziAg1SNbUPF5uQHZrCni8Ip9g45g3npjqxnYYdQ/siqQ/msDDYK6ql1p99CYSEgi9DTcOm63mu/wit+g8/wKlKSy2Uo89jKcHWsCwkXNElwkPTiCksjC7qPj405tQcYbM3yLq/v5+pr51UM10/DgRUSYKls/Du9CogvDifXgE1RGidjevPmjQWvKXrLbSsQLkN7re71vvWmrZBtfR9ypMc2r6YsnxzAwFXwEvqbYygmvb3q6sLmIaWtO7f9/ALoQve+jA9/3TRIRvEcJWjxaZDRDgcjcIyWzfXEYybAQ5znrb7aHgchpUmsZ5aUpXCUbs7cBbQGG2Chl1MdMjS6lYxvdSE0+jsm+t02brh2LsclWtcRIMbhEk12oCk6UBDfbleX7+akMd5XdliwQXFgfVlqY37j0iRy/31+SY69p+pYKlDZ1ov2wmfJ7cNG6GMkj3NFVz1wpBea+i8+i9Z29GwWj9o/L88aTVXvMMvblhKLijZ195eNcm1e1Kg5DFpW/e7iOXaOpperebc4rWRVUXD4Z2KTW7v1okzZOBUWPqddq9QX3X93mXznjGAf/o29qQ5bXmjliGZS09fLGKfcdl7oquomMqRp2gC3nr2OKSX3r6dd66NW+nd6RWrqv8Cn1dZBQ==",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},y=void 0,b={},f=[];function w(e){const t={code:"code",p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Find an Outward Code"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/outcodes/{outcode}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Returns aggregated information for postcodes grouped by their shared outward code."}),"\n",(0,n.jsxs)(t.p,{children:["The outward code is the first half of any postcode (3-4 characters and followed by a space). E.g. ",(0,n.jsx)(t.code,{children:"SW1A"})," is the outward code for ",(0,n.jsx)(t.code,{children:"SW1A 1AA"}),"."]}),"\n",(0,n.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(c(),{parameters:[{name:"outcode",in:"path",description:"Specifies the outward code you wish to query.",required:!0,example:"SW1A",style:"simple",explode:!1,schema:{type:"string"}}]}),"\n",(0,n.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Outcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive geographical and administrative data for the specified outcode, including location coordinates, administrative boundaries, and related postal information",oneOf:[{required:["outcode","eastings","northings","admin_county","admin_district","admin_ward","longitude","latitude","country","parish","parliamentary_constituency"],properties:{outcode:{title:"Outcode",type:"string",description:'First part of the postcode before the space (e.g., "SW1A" in "SW1A 1AA"). Usually 2-4 characters.',example:"SW1A"},eastings:{title:"Eastings",type:"number",format:"int32",nullable:!0,description:"Ordnance Survey eastings coordinate (1m resolution). Returns 0 if location unavailable.",example:529740},northings:{title:"Northings",type:"number",format:"int32",nullable:!0,description:"Ordnance Survey northings coordinate (1m resolution). Returns 0 if location unavailable.",example:180066},admin_county:{title:"Administrative County",type:"array",items:{type:"string"},description:"Administrative counties within this outcode.",example:["(pseudo) England (UA/MD/LB)"]},admin_district:{title:"District",type:"array",items:{type:"string"},description:"District/unitary authorities within this outcode.",example:["Westminster","Wandsworth"]},admin_ward:{title:"Ward",type:"array",items:{type:"string"},description:"Administrative/electoral wards within this outcode.",example:["Nine Elms","St. James's"]},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate. May be null if location unavailable.",example:-.132066},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate. May be null if location unavailable.",example:51.50464},country:{title:"Country",type:"array",items:{type:"string"},description:"Countries within this outcode.",example:["England"]},parish:{title:"Parish",type:"array",items:{type:"string"},description:"Parishes (England) or communities (Wales) within this outcode.",example:["Wandsworth, unparished area","Westminster, unparished area"]},parliamentary_constituency:{title:"Parliamentary Constituency",type:"array",items:{type:"string"},description:"UK Parliamentary constituencies (July 2024 boundaries) that intersect this outcode.",example:["Cities of London and Westminster","Battersea"]}},title:"Outcode"}]}}}}}}}})]})}function W(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(w,{...e})}):w(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/7c98d41e.726e233e.js b/build/assets/js/7c98d41e.726e233e.js
deleted file mode 100644
index b0b591aa9..000000000
--- a/build/assets/js/7c98d41e.726e233e.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunkpostcodes_io=globalThis.webpackChunkpostcodes_io||[]).push([[3512],{21703(e,t,i){i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>h,default:()=>x,frontMatter:()=>f,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"id":"api/find-outcode","title":"Find an Outward Code","description":"Returns aggregated information for postcodes grouped by their shared outward code.","source":"@site/docs/api/find-outcode.api.mdx","sourceDirName":"api","slug":"/api/find-outcode","permalink":"/docs/api/find-outcode","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"find-outcode","title":"Find an Outward Code","description":"Returns aggregated information for postcodes grouped by their shared outward code.","sidebar_label":"Find an Outward Code","hide_title":true,"hide_table_of_contents":true,"api":"eJzlWFtvG7cS/isDFjixgdVKVuw0FVC0ruumSdPYsBz4wTLq0e5olw2X3JJcO4Kh/34w3ItWkmO4OXk7frGWl5lvht8MZ/ggPGZOTK7FWeXv0aZwYlJy4iYSKbnEytJLo8VEXJCvrHaAWWYpQ08pSL0wtkBeAAtjoTTOJ7wbMmuqklKYL8HnJC24HC2lYBodvCqe6Zm+zGljEKTjHbCQ1nnIUS3ALAD1shMOey8Hh5DkaDHxZB2gTmFhlDL3tUIEV2JC+zGcxlkMt9Org+PbVu6GLsYcpuHg+Pg2nmkRCVOSDRa9TcVE/CZ1elYFvSISJVosiJWKyfWD0FiQmAjTzUv2U4k+F9vOm5aUyIWkR0AsTQX30uXgDfxTkV3GIhKW/qmkpVRMvK0oEvQZi1KxNoYrIuH8Mnw6GcZ5RakYxWSBylEkXJJTgWLyIPyyDCu9lToTq9UNi3el0Y4cz49HI/63BbhKEnJORCIx2pP2vATLUskkeGf4t+N1D3090gdIjb/golEiohaCmf9Nid8w71o4j75yYdBVyjPxSsun4GWNr1mwtkRqTxlZEYmafvXQyzF7QVeFmFyPR6ObVSdxx7gTU5SWctJO3hFkZDKLZS4TVIFMmBZSS+eZB3cEKXoMVOGjc81BBiqzmRFInagqlToDZWrnQGKMTaVGTy7aFjc3lU7RyjClU7CkQjAxv1H1Y4rZqOlsEcjWd9macYTOS52x+7SxPm9+B5V/JabSftl9poxBBv/XA8xBEQlldCZ9FeQp9O3PsNsua9pLl9c/lMSCtEe7/Csx2vFq0sly99RajLvEWPOhoeR2sPwWYr9E6zn22etd7M9pYSw1J4EJwR7FWRzBLMTFTIDUzW8O6ZnYj+Gjq1CpJYw3skYsdoJq1XNnD/Xp2sUNbF0V88fppyulcM7b6rDdtOvMphp1QjCt7B0todXWowvsHRRgyRlV8ab9GNq0OwK5WBOs0niHMujasORo/MP3h6NVnw09Uz70KPKNben0fUNjDl6PRq9erbbo3LPneDOyTlq+N7ahtcif0lPhHsmE2zZtiQv6OGXfSzYNfC5dG/UbOK9vVjsx1kP56zruvhJYK2FYacmhB1j53Fj5PHTiipwvpHY+HPQV6tTd83GJNe6QCnqYr+rU8E0cOSRFiTcWFbCa5yD+IDXBqSqYqFMfwzssyL1wAfA6XfXwvu/lsC8yOzXVPNyVT1P76s309SF0anqEjuFPXMKcgAU8i8KDUXzwclyzuMutfdzrfPuNYDcC/yfURwfx0ejw1eFqfQv0MJ90F8NX0qMW8DzunupMoU7DyTf3UA/KeXszfSWSej852Gv07IOxkJii4EhjhHtXqMjtPyfKuriKoNI1VkoBLSFH3ToGd6cb4750t24avF4FJ/1VX+2Ej3/Aptie8uCCdxVfn6PxYa922QefowcuxayjxD/lmZPalWYB741OjQ5lz2ZS+gV9EMS+WEU7FcPqZlX/ReLzgEemQXhdhivUmZiI3PsyVDBzUmzVxXsuk01lE2pm3WQ4xFLGXZsSSzNsILuhuz/AmRarqJOY1DJaiSfv3/YlJpVVMHgDg08wm800wGDAIy+ep+nFpqot8B8ILTkP/9aIn5TRP3LOGX//6oej/yj0P4ZYfnl0+KRprb6nTXyugU+gCGbfRKIgnxtusDLyobD0uZiItYseml8rhkP2rm25Kque8MNOJXl8/hamYbuIxB1ayamOYyJ0QVxqc3yw9Hr9wet4FI/YMTIhbl0mXZf359tLEW3pNyXp2lmxsdmw2eSGvLbHYkZxQQuyxAXTAM43IXuyhTtbME65ccwbzk1N4joNO4b2RXKri7Cw1KublTGfqhIYCQdfRoaHbdfWfPwjdOPffQenOi2N1J4/j5UCV8NykKDmSwRDX0gpLKwp6lY99N7c/1CzN8i6vb2d6S+dVDNd9/8BVZJQ6R28Ob0MCM/PppfAPQ857+L6syaNg8rx9Ra6UuDcBrfbjelta03bgzr+PsUkh7b15Szf3ECAGrDk9sVKLlt/v7w8h2noOusWfY8+M7rgrXfTsw/nHbL9GC5zctQ0gQTj0Sgsc3X/HMFhM4Awx7Tdx8OHYVgbFltx16lTOGp3B84CWWts0LCLiQ9ZOdMq5seYcBqdfXOTLls3HFc+J+0bF/HgBmFSQy4gaZrMUF+u19cPI+xxrCtbKlByHLiqLI31P8uUUA3W55uYuPrEBUsdOtN62U74PLpt2AgVnOx5rkDdC0N+kOHz6j9WbUfDw/rN4v/l1aq54j199sNSoeRkX3v7oUmu3asBJ49J253fRCI3zvP0w8McHX20arXi4fAUxb3NOnGGDJxKx7/T7qHpi67fu2ieLPbh3z5/PWpOW97oZUjmquIvEYlPtOy9wq24mMoJU7IBbz17HNJLb9/OU9bGrfTm9FKsVv8F2elQgw==","sidebar_class_name":"get api-method","info_path":"docs/api/api-reference-postcodes-io","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Outward Codes","permalink":"/docs/api/outward-codes"},"next":{"title":"Places","permalink":"/docs/api/places"}}');var o=i(31325),s=i(31736),n=i(47812),r=i.n(n),d=i(38616),l=i.n(d),c=i(67994),u=i.n(c),p=i(54768),m=i.n(p),y=(i(24909),i(96847),i(78121));const f={id:"find-outcode",title:"Find an Outward Code",description:"Returns aggregated information for postcodes grouped by their shared outward code.",sidebar_label:"Find an Outward Code",hide_title:!0,hide_table_of_contents:!0,api:"eJzlWFtvG7cS/isDFjixgdVKVuw0FVC0ruumSdPYsBz4wTLq0e5olw2X3JJcO4Kh/34w3ItWkmO4OXk7frGWl5lvht8MZ/ggPGZOTK7FWeXv0aZwYlJy4iYSKbnEytJLo8VEXJCvrHaAWWYpQ08pSL0wtkBeAAtjoTTOJ7wbMmuqklKYL8HnJC24HC2lYBodvCqe6Zm+zGljEKTjHbCQ1nnIUS3ALAD1shMOey8Hh5DkaDHxZB2gTmFhlDL3tUIEV2JC+zGcxlkMt9Org+PbVu6GLsYcpuHg+Pg2nmkRCVOSDRa9TcVE/CZ1elYFvSISJVosiJWKyfWD0FiQmAjTzUv2U4k+F9vOm5aUyIWkR0AsTQX30uXgDfxTkV3GIhKW/qmkpVRMvK0oEvQZi1KxNoYrIuH8Mnw6GcZ5RakYxWSBylEkXJJTgWLyIPyyDCu9lToTq9UNi3el0Y4cz49HI/63BbhKEnJORCIx2pP2vATLUskkeGf4t+N1D3090gdIjb/golEiohaCmf9Nid8w71o4j75yYdBVyjPxSsun4GWNr1mwtkRqTxlZEYmafvXQyzF7QVeFmFyPR6ObVSdxx7gTU5SWctJO3hFkZDKLZS4TVIFMmBZSS+eZB3cEKXoMVOGjc81BBiqzmRFInagqlToDZWrnQGKMTaVGTy7aFjc3lU7RyjClU7CkQjAxv1H1Y4rZqOlsEcjWd9macYTOS52x+7SxPm9+B5V/JabSftl9poxBBv/XA8xBEQlldCZ9FeQp9O3PsNsua9pLl9c/lMSCtEe7/Csx2vFq0sly99RajLvEWPOhoeR2sPwWYr9E6zn22etd7M9pYSw1J4EJwR7FWRzBLMTFTIDUzW8O6ZnYj+Gjq1CpJYw3skYsdoJq1XNnD/Xp2sUNbF0V88fppyulcM7b6rDdtOvMphp1QjCt7B0todXWowvsHRRgyRlV8ab9GNq0OwK5WBOs0niHMujasORo/MP3h6NVnw09Uz70KPKNben0fUNjDl6PRq9erbbo3LPneDOyTlq+N7ahtcif0lPhHsmE2zZtiQv6OGXfSzYNfC5dG/UbOK9vVjsx1kP56zruvhJYK2FYacmhB1j53Fj5PHTiipwvpHY+HPQV6tTd83GJNe6QCnqYr+rU8E0cOSRFiTcWFbCa5yD+IDXBqSqYqFMfwzssyL1wAfA6XfXwvu/lsC8yOzXVPNyVT1P76s309SF0anqEjuFPXMKcgAU8i8KDUXzwclyzuMutfdzrfPuNYDcC/yfURwfx0ejw1eFqfQv0MJ90F8NX0qMW8DzunupMoU7DyTf3UA/KeXszfSWSej852Gv07IOxkJii4EhjhHtXqMjtPyfKuriKoNI1VkoBLSFH3ToGd6cb4750t24avF4FJ/1VX+2Ej3/Aptie8uCCdxVfn6PxYa922QefowcuxayjxD/lmZPalWYB741OjQ5lz2ZS+gV9EMS+WEU7FcPqZlX/ReLzgEemQXhdhivUmZiI3PsyVDBzUmzVxXsuk01lE2pm3WQ4xFLGXZsSSzNsILuhuz/AmRarqJOY1DJaiSfv3/YlJpVVMHgDg08wm800wGDAIy+ep+nFpqot8B8ILTkP/9aIn5TRP3LOGX//6oej/yj0P4ZYfnl0+KRprb6nTXyugU+gCGbfRKIgnxtusDLyobD0uZiItYseml8rhkP2rm25Kque8MNOJXl8/hamYbuIxB1ayamOYyJ0QVxqc3yw9Hr9wet4FI/YMTIhbl0mXZf359tLEW3pNyXp2lmxsdmw2eSGvLbHYkZxQQuyxAXTAM43IXuyhTtbME65ccwbzk1N4joNO4b2RXKri7Cw1KublTGfqhIYCQdfRoaHbdfWfPwjdOPffQenOi2N1J4/j5UCV8NykKDmSwRDX0gpLKwp6lY99N7c/1CzN8i6vb2d6S+dVDNd9/8BVZJQ6R28Ob0MCM/PppfAPQ857+L6syaNg8rx9Ra6UuDcBrfbjelta03bgzr+PsUkh7b15Szf3ECAGrDk9sVKLlt/v7w8h2noOusWfY8+M7rgrXfTsw/nHbL9GC5zctQ0gQTj0Sgsc3X/HMFhM4Awx7Tdx8OHYVgbFltx16lTOGp3B84CWWts0LCLiQ9ZOdMq5seYcBqdfXOTLls3HFc+J+0bF/HgBmFSQy4gaZrMUF+u19cPI+xxrCtbKlByHLiqLI31P8uUUA3W55uYuPrEBUsdOtN62U74PLpt2AgVnOx5rkDdC0N+kOHz6j9WbUfDw/rN4v/l1aq54j199sNSoeRkX3v7oUmu3asBJ49J253fRCI3zvP0w8McHX20arXi4fAUxb3NOnGGDJxKx7/T7qHpi67fu2ieLPbh3z5/PWpOW97oZUjmquIvEYlPtOy9wq24mMoJU7IBbz17HNJLb9/OU9bGrfTm9FKsVv8F2elQgw==",sidebar_class_name:"get api-method",info_path:"docs/api/api-reference-postcodes-io",custom_edit_url:null},h=void 0,b={},g=[];function w(e){const t={code:"code",p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Find an Outward Code"}),"\n",(0,o.jsx)(r(),{method:"get",path:"/outcodes/{outcode}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"Returns aggregated information for postcodes grouped by their shared outward code."}),"\n",(0,o.jsxs)(t.p,{children:["The outward code is the first half of any postcode (3-4 characters and followed by a space). E.g. ",(0,o.jsx)(t.code,{children:"SW1A"})," is the outward code for ",(0,o.jsx)(t.code,{children:"SW1A 1AA"}),"."]}),"\n",(0,o.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:[{name:"outcode",in:"path",description:"Specifies the outward code you wish to query.",required:!0,example:"SW1A",style:"simple",explode:!1,schema:{type:"string"}}]}),"\n",(0,o.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Success",content:{"application/json":{schema:{title:"Outcode Response",type:"object",required:["status","result"],properties:{status:{type:"integer",format:"int32",enum:[200]},result:{description:"Comprehensive geographical and administrative data for the specified outcode, including location coordinates, administrative boundaries, and related postal information",oneOf:[{required:["outcode","eastings","northings","admin_county","admin_district","admin_ward","longitude","latitude","country","parish","parliamentary_constituency"],properties:{outcode:{title:"Outcode",type:"string",description:'First part of the postcode before the space (e.g., "SW1A" in "SW1A 1AA"). Usually 2-4 characters.',example:"SW1A"},eastings:{title:"Eastings",type:"number",format:"int32",nullable:!0,description:"Ordnance Survey eastings coordinate (1m resolution). Returns 0 if location unavailable.",example:529740},northings:{title:"Northings",type:"number",format:"int32",nullable:!0,description:"Ordnance Survey northings coordinate (1m resolution). Returns 0 if location unavailable.",example:180066},admin_county:{title:"Administrative County",type:"array",items:{type:"string"},description:"Administrative counties within this outcode.",example:[]},admin_district:{title:"District",type:"array",items:{type:"string"},description:"District/unitary authorities within this outcode.",example:["Westminster","Wandsworth"]},admin_ward:{title:"Ward",type:"array",items:{type:"string"},description:"Administrative/electoral wards within this outcode.",example:["Nine Elms","St. James's"]},longitude:{title:"Longitude",type:"number",format:"double",nullable:!0,description:"WGS84 longitude coordinate. May be null if location unavailable.",example:-.132066},latitude:{title:"Latitude",type:"number",format:"double",nullable:!0,description:"WGS84 latitude coordinate. May be null if location unavailable.",example:51.50464},country:{title:"Country",type:"array",items:{type:"string"},description:"Countries within this outcode.",example:["England"]},parish:{title:"Parish",type:"array",items:{type:"string"},description:"Parishes (England) or communities (Wales) within this outcode.",example:["Wandsworth, unparished area","Westminster, unparished area"]},parliamentary_constituency:{title:"Parliamentary Constituency",type:"array",items:{type:"string"},description:"UK Parliamentary constituencies (July 2024 boundaries) that intersect this outcode.",example:["Cities of London and Westminster","Battersea"]}},title:"Outcode"}]}}}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(w,{...e})}):w(e)}}}]);
\ No newline at end of file
diff --git a/build/assets/js/runtime~main.4ee5051f.js b/build/assets/js/runtime~main.4ee5051f.js
new file mode 100644
index 000000000..d6f67cf72
--- /dev/null
+++ b/build/assets/js/runtime~main.4ee5051f.js
@@ -0,0 +1 @@
+(()=>{"use strict";var e,a,d,c,t,r={},f={};function b(e){var a=f[e];if(void 0!==a)return a.exports;var d=f[e]={id:e,loaded:!1,exports:{}};return r[e].call(d.exports,d,d.exports,b),d.loaded=!0,d.exports}b.m=r,e=[],b.O=(a,d,c,t)=>{if(!d){var r=1/0;for(i=0;i{
"postcode": "SW1A 1AA",
"quality": 1,
"eastings": 529090,
"northings": 179645,
"country": "England",
"nhs_ha": "London",
"longitude": -0.141563,
"latitude": 51.50101,
"european_electoral_region": "London",
"primary_care_trust": "Westminster",
"region": "London",
"lsoa": "Westminster 018C",
"msoa": "Westminster 018",
"incode": "1AA",
"outcode": "SW1A",
"parliamentary_constituency": "Cities of London and Westminster",
"parliamentary_constituency_2024": "Cities of London and Westminster",
"senedd_constituency": null,
"senedd_constituency_no": null,
"admin_district": "Westminster",
"parish": "Westminster, unparished area",
"admin_county": "(pseudo) England (UA/MD/LB)",
"date_of_introduction": "198001",
"date_of_termination": null,
"index_of_multiple_deprivation": 24862,
"admin_ward": "St James's",
"ced": null,
"ccg": "NHS North West London",
"nuts": "Westminster",
"pfa": "Metropolitan Police",
"nhs_region": "London",
"ttwa": "London",
"national_park": "England (non-National Park)",
"bua": "City of Westminster",
"icb": "NHS North West London Integrated Care Board",
"cancer_alliance": "West London",
"lsoa11": "Westminster 018C",
"msoa11": "Westminster 018",
"lsoa21": "Westminster 018C",
"msoa21": "Westminster 018",
"oa21": "E00023938",
"ruc11": "(England/Wales) Urban major conurbation",
"ruc21": "Urban: Nearer to a major town or city",
"lep1": "London",
"lep2": null,
"codes": {
"admin_district": "E09000033",
"admin_county": "E99999999",
"admin_ward": "E05013806",
"parish": "E43000236",
"parliamentary_constituency": "E14001172",
"parliamentary_constituency_2024": "E14001172",
"ccg": "E38000256",
"ccg_id": "W2U3Z",
"ced": "E99999999",
"nuts": "TLI35",
"lsoa": "E01004736",
"msoa": "E02000977",
"lau2": "E09000033",
"pfa": "E23000001",
"nhs_region": "E40000003",
"ttwa": "E30000234",
"national_park": "E65000001",
"bua": "E63012036",
"icb": "E54000027",
"cancer_alliance": "E56000021",
"lsoa11": "E01004736",
"msoa11": "E02000977",
"lsoa21": "E01004736",
"msoa21": "E02000977",
"oa21": "E00023938",
"ruc11": "A1",
"ruc21": "UN1",
"lep1": "E37000051",
"lep2": null
}
}
| Field | Type | Description | Example |
|---|---|---|---|
postcode | string | UK postcode format: 2-4 character outward code, a space, and a 3-character inward code. Updated monthly from Royal Mail. | "SW1A 2AA" |
outcode | string | The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district. | "SW1A" |
incode | string | The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area. | "1AA" |
quality | integer | Indicates accuracy of the grid reference location (1-9 scale, 1 being most accurate). | 1 |
eastings | integer | null | Ordnance Survey grid reference easting (X-coordinate) with 1-meter resolution. May be null if geolocation unavailable. | 530047 |
northings | integer | null | Ordnance Survey grid reference northing (Y-coordinate) with 1-meter resolution. May be null if geolocation unavailable. | 179951 |
country | string | The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man). | "England" |
nhs_ha | string | null | The NHS health authority area for this postcode. | "London" |
admin_county | string | null | The administrative county for this postcode. May be empty for areas without county-level administration. | "" |
admin_district | string | null | The administrative district or unitary authority for this postcode. | "Westminster" |
admin_ward | string | null | The electoral/administrative ward for this postcode. | "St. James's" |
longitude | number | null | WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable. | -0.12767 |
latitude | number | null | WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable. | 51.503541 |
parliamentary_constituency | string | null | The UK Parliamentary constituency for this postcode. | "Cities of London and Westminster" |
european_electoral_region | string | null | The European Electoral Region for this postcode. | "London" |
primary_care_trust | string | null | The healthcare administrative area for this postcode. Different naming conventions apply across UK regions. | "Westminster" |
region | string | null | The regional designation for this postcode (formerly Government Office Regions or GORs). | "London" |
parish | string | null | The civil parish (England) or community (Wales) for this postcode. | "Westminster, unparished area" |
lsoa | string | null | 2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data. | "Westminster 018C" |
msoa | string | null | 2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data. | "Westminster 018" |
ced | string | null | The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions. | null |
ccg | string | null | NHS Clinical Commissioning Group responsible for planning healthcare services in England. | "NHS North West London" |
nuts | string | null | International Territorial Levels (ITL) code for statistical geography (formerly NUTS - Nomenclature of Units for Territorial Statistics). | "Westminster" |
codes | object | Standard 9-character codes (ONS/GSS) for various administrative boundaries. Useful for data linking with official statistics. | - |
codes.admin_district | string | null | Official 9-character GSS code for this administrative district. | "E09000033" |
codes.admin_county | string | null | Official 9-character GSS code for this administrative county. | "E99999999" |
codes.admin_ward | string | null | Official 9-character GSS code for this administrative ward. | "E05013806" |
codes.parish | string | null | Official 9-character GSS code for this parish. | "E43000236" |
codes.parliamentary_constituency | string | null | Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024. | "E14000639" |
codes.ccg | string | null | Official 9-character GSS code for this Clinical Commissioning Group. | "E38000256" |
codes.ccg_id | string | null | Short code identifier for this Clinical Commissioning Group. | "W2U3Z" |
codes.ced | string | null | Official 9-character GSS code for this County Electoral District. | "E99999999" |
codes.nuts | string | null | Official code for this International Territorial Level area. | "TLI32" |
codes.lau2 | string | null | Local Administrative Unit level 2 code for this area. | "E09000033" |
codes.lsoa | string | null | Official 9-character GSS code for this 2021 Census LSOA. | "E01004736" |
codes.msoa | string | null | Official 9-character GSS code for this 2021 Census MSOA. | "E02000977" |
codes.pfa | string | null | Official 9-character GSS code for this Police Force Area. | "E23000001" |
pfa | string | null | The police force area for this postcode. | "Metropolitan Police" |
date_of_introduction | string | null | The date the postcode was introduced in YYYYMM format. | "198001" |
date_of_termination | string | null | The date the postcode was terminated in YYYYMM format. null for live postcodes. | null |
index_of_multiple_deprivation | integer | null | ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales — values are not directly comparable across countries. | 14843 |
parliamentary_constituency_2024 | string | null | The UK Parliamentary constituency for this postcode based on July 2024 boundaries. | "Cities of London and Westminster" |
senedd_constituency | string | null | The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere. | "Caerdydd Penarth" |
senedd_constituency_no | integer | null | The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere. | 14 |
nhs_region | string | null | The NHS England Region for this postcode. Only applicable to English postcodes. | "London" |
ttwa | string | null | The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work. | "London" |
national_park | string | null | The National Park this postcode falls within, if any. | null |
bua | string | null | The Built-up Area (2022) for this postcode. | "Greater London" |
icb | string | null | The NHS Integrated Care Board responsible for healthcare planning in this area. | "NHS North West London ICB" |
cancer_alliance | string | null | The Cancer Alliance for this postcode. | "RM Partners (West London)" |
lsoa11 | string | null | 2011 Census LSOA code. Alias for the 'lsoa' field. | "Westminster 018C" |
msoa11 | string | null | 2011 Census MSOA code. Alias for the 'msoa' field. | "Westminster 018" |
lsoa21 | string | null | 2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area. | "Westminster 018C" |
msoa21 | string | null | 2021 Census MSOA code. In Scotland this is the Intermediate Zone. | "Westminster 018" |
oa21 | string | null | 2021 Census Output Area code - the smallest census geography. | "E00004185" |
ruc11 | string | null | The 2011 Census Rural-Urban Classification for this postcode. | "Urban major conurbation" |
ruc21 | string | null | The 2021 Census Rural-Urban Classification for this postcode. | "Urban major conurbation" |
lep1 | string | null | The primary Local Enterprise Partnership for this postcode. | "London" |
lep2 | string | null | The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas. | null |
codes.nhs_region | string | null | Official 9-character GSS code for this NHS England Region. | "E40000003" |
codes.ttwa | string | null | Travel to Work Area code. | "E30000234" |
codes.national_park | string | null | Official 9-character GSS code for this National Park. | null |
codes.bua | string | null | Built-up Area (2022) code. | "E34004786" |
codes.icb | string | null | Official 9-character GSS code for this Integrated Care Board. | "E54000027" |
codes.cancer_alliance | string | null | Official 9-character GSS code for this Cancer Alliance. | "E56000009" |
codes.lsoa11 | string | null | Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa. | "E01004736" |
codes.msoa11 | string | null | Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa. | "E02000977" |
codes.lsoa21 | string | null | Official 9-character GSS code for this 2021 Census LSOA. | "E01004736" |
codes.msoa21 | string | null | Official 9-character GSS code for this 2021 Census MSOA. | "E02000977" |
codes.oa21 | string | null | 2021 Census Output Area code. | "E00004185" |
codes.ruc11 | string | null | 2011 Census Rural-Urban Classification code. | "A1" |
codes.ruc21 | string | null | 2021 Census Rural-Urban Classification code. | "A1" |
codes.lep1 | string | null | Official 9-character GSS code for the primary Local Enterprise Partnership. | "E37000051" |
codes.lep2 | string | null | Official 9-character GSS code for the secondary Local Enterprise Partnership. | null |
codes.parliamentary_constituency_2024 | string | null | Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries. | "E14000639" |
| Field | Type | Description | Example |
|---|---|---|---|
postcode | string | UK postcode format: 2-4 character outward code, a space, and a 3-character inward code. Updated monthly from Royal Mail. | "SW1A 2AA" |
outcode | string | The first part of a postcode before the space (2-4 characters). This generally identifies the postal town or district. | "SW1A" |
incode | string | The second part of a postcode after the space (always 3 characters). Helps identify specific streets or buildings within a postal area. | "1AA" |
quality | integer | Indicates accuracy of the grid reference location (1-9 scale, 1 being most accurate). | 1 |
eastings | integer | null | Ordnance Survey grid reference easting (X-coordinate) with 1-meter resolution. May be null if geolocation unavailable. | 530047 |
northings | integer | null | Ordnance Survey grid reference northing (Y-coordinate) with 1-meter resolution. May be null if geolocation unavailable. | 179951 |
country | string | The UK constituent country for this postcode (England, Scotland, Wales, Northern Ireland, Channel Islands, or Isle of Man). | "England" |
nhs_ha | string | null | The NHS health authority area for this postcode. | "London" |
admin_county | string | null | The administrative county for this postcode. Null where the postcode falls outside a county-level authority (the underlying GSS code is then a pseudo such as E99999999, surfaced under codes.admin_county). | null |
admin_district | string | null | The administrative district or unitary authority for this postcode. | "Westminster" |
admin_ward | string | null | The electoral/administrative ward for this postcode. | "St. James's" |
longitude | number | null | WGS84 longitude coordinate (east-west position). May be null if geolocation unavailable. | -0.12767 |
latitude | number | null | WGS84 latitude coordinate (north-south position). May be null if geolocation unavailable. | 51.503541 |
parliamentary_constituency | string | null | The UK Parliamentary constituency for this postcode. | "Cities of London and Westminster" |
european_electoral_region | string | null | The European Electoral Region for this postcode. | "London" |
primary_care_trust | string | null | The healthcare administrative area for this postcode. Different naming conventions apply across UK regions. | "Westminster" |
region | string | null | The regional designation for this postcode (formerly Government Office Regions or GORs). | "London" |
parish | string | null | The civil parish (England) or community (Wales) for this postcode. | "Westminster, unparished area" |
lsoa | string | null | 2021 Census LSOA code (smaller statistical area, typically 1,000-1,500 residents). Now points to 2021 data. | "Westminster 018C" |
msoa | string | null | 2021 Census MSOA code (mid-size statistical area, typically 5,000-7,000 residents). Now points to 2021 data. | "Westminster 018" |
ced | string | null | The county electoral division for English postcodes. Will be null for postcodes without a grid reference or in other UK regions. | null |
ccg | string | null | NHS Clinical Commissioning Group responsible for planning healthcare services in England. | "NHS North West London" |
nuts | string | null | International Territorial Levels (ITL) code for statistical geography (formerly NUTS - Nomenclature of Units for Territorial Statistics). | "Westminster" |
codes | object | Standard 9-character codes (ONS/GSS) for various administrative boundaries. Useful for data linking with official statistics. | - |
codes.admin_district | string | null | Official 9-character GSS code for this administrative district. | "E09000033" |
codes.admin_county | string | null | Official 9-character GSS code for this administrative county. | "E99999999" |
codes.admin_ward | string | null | Official 9-character GSS code for this administrative ward. | "E05013806" |
codes.parish | string | null | Official 9-character GSS code for this parish. | "E43000236" |
codes.parliamentary_constituency | string | null | Official 9-character GSS code for this Parliamentary Constituency (July 2024 boundaries). Alias for codes.parliamentary_constituency_2024. | "E14000639" |
codes.ccg | string | null | Official 9-character GSS code for this Clinical Commissioning Group. | "E38000256" |
codes.ccg_id | string | null | Short code identifier for this Clinical Commissioning Group. | "W2U3Z" |
codes.ced | string | null | Official 9-character GSS code for this County Electoral District. | "E99999999" |
codes.nuts | string | null | Official code for this International Territorial Level area. | "TLI32" |
codes.lau2 | string | null | Local Administrative Unit level 2 code for this area. | "E09000033" |
codes.lsoa | string | null | Official 9-character GSS code for this 2021 Census LSOA. | "E01004736" |
codes.msoa | string | null | Official 9-character GSS code for this 2021 Census MSOA. | "E02000977" |
codes.pfa | string | null | Official 9-character GSS code for this Police Force Area. | "E23000001" |
pfa | string | null | The police force area for this postcode. | "Metropolitan Police" |
date_of_introduction | string | null | The date the postcode was introduced in YYYYMM format. | "198001" |
date_of_termination | string | null | The date the postcode was terminated in YYYYMM format. null for live postcodes. | null |
index_of_multiple_deprivation | integer | null | ONS Index of Multiple Deprivation (IMD) rank for this postcode's LSOA. Lower ranks correspond to more deprived areas. England, Wales, Scotland and Northern Ireland use independent IMD scales — values are not directly comparable across countries. | 14843 |
parliamentary_constituency_2024 | string | null | The UK Parliamentary constituency for this postcode based on July 2024 boundaries. | "Cities of London and Westminster" |
senedd_constituency | string | null | The Senedd Cymru (Welsh Parliament) constituency for this postcode. Only applicable to Welsh postcodes; null elsewhere. | "Caerdydd Penarth" |
senedd_constituency_no | integer | null | The Senedd Cymru (Welsh Parliament) constituency number for this postcode. Only applicable to Welsh postcodes; null elsewhere. | 14 |
nhs_region | string | null | The NHS England Region for this postcode. Only applicable to English postcodes. | "London" |
ttwa | string | null | The Travel to Work Area for this postcode. TTWAs are areas where most people both live and work. | "London" |
national_park | string | null | The National Park this postcode falls within, if any. | null |
bua | string | null | The Built-up Area (2022) for this postcode. | "Greater London" |
icb | string | null | The NHS Integrated Care Board responsible for healthcare planning in this area. | "NHS North West London ICB" |
cancer_alliance | string | null | The Cancer Alliance for this postcode. | "RM Partners (West London)" |
lsoa11 | string | null | 2011 Census LSOA code. Alias for the 'lsoa' field. | "Westminster 018C" |
msoa11 | string | null | 2011 Census MSOA code. Alias for the 'msoa' field. | "Westminster 018" |
lsoa21 | string | null | 2021 Census LSOA code. In Scotland this is the Data Zone, in Northern Ireland the Small Area. | "Westminster 018C" |
msoa21 | string | null | 2021 Census MSOA code. In Scotland this is the Intermediate Zone. | "Westminster 018" |
oa21 | string | null | 2021 Census Output Area code - the smallest census geography. | "E00004185" |
ruc11 | string | null | The 2011 Census Rural-Urban Classification for this postcode. | "Urban major conurbation" |
ruc21 | string | null | The 2021 Census Rural-Urban Classification for this postcode. | "Urban major conurbation" |
lep1 | string | null | The primary Local Enterprise Partnership for this postcode. | "London" |
lep2 | string | null | The secondary Local Enterprise Partnership for this postcode, if it falls within overlapping LEP areas. | null |
codes.nhs_region | string | null | Official 9-character GSS code for this NHS England Region. | "E40000003" |
codes.ttwa | string | null | Travel to Work Area code. | "E30000234" |
codes.national_park | string | null | Official 9-character GSS code for this National Park. | null |
codes.bua | string | null | Built-up Area (2022) code. | "E34004786" |
codes.icb | string | null | Official 9-character GSS code for this Integrated Care Board. | "E54000027" |
codes.cancer_alliance | string | null | Official 9-character GSS code for this Cancer Alliance. | "E56000009" |
codes.lsoa11 | string | null | Official 9-character GSS code for this 2011 Census LSOA. Alias for codes.lsoa. | "E01004736" |
codes.msoa11 | string | null | Official 9-character GSS code for this 2011 Census MSOA. Alias for codes.msoa. | "E02000977" |
codes.lsoa21 | string | null | Official 9-character GSS code for this 2021 Census LSOA. | "E01004736" |
codes.msoa21 | string | null | Official 9-character GSS code for this 2021 Census MSOA. | "E02000977" |
codes.oa21 | string | null | 2021 Census Output Area code. | "E00004185" |
codes.ruc11 | string | null | 2011 Census Rural-Urban Classification code. | "A1" |
codes.ruc21 | string | null | 2021 Census Rural-Urban Classification code. | "A1" |
codes.lep1 | string | null | Official 9-character GSS code for the primary Local Enterprise Partnership. | "E37000051" |
codes.lep2 | string | null | Official 9-character GSS code for the secondary Local Enterprise Partnership. | null |
codes.parliamentary_constituency_2024 | string | null | Official 9-character GSS code for this Parliamentary Constituency based on July 2024 boundaries. | "E14000639" |
| Quality Value | Description |
|---|---|
| 1 | Within the actual building (most accurate) |
| 2 | Same as 1, but verified by Landline maps (Scotland only) |
| 3 | Approximate location within 50m |
| 4 | Postcode unit mean (averaged from addresses with same postcode) |
| 5 | Estimated by ONS using surrounding postcodes |
| 6 | Postcode sector mean (mainly PO Boxes) |
| 8 | Historical postcode (pre-Gridlink®) |
| 9 | No grid reference available |
GET https://api.postcodes.io/scotland/postcodes/AB101XG
The above would match any of these inputs: "AB10 1XG", "ab101xg", "Ab10 1Xg", etc.
{
"status": 200,
"result": {
"postcode": "AB10 1XG",
"pc_compact": "AB101XG",
"postcode_district": "AB10",
"postcode_sector": "AB10 1",
"incode": "1XG",
"outcode": "AB10",
"user_type": "0",
"date_of_introduction": "198001",
"date_of_deletion": null,
"linked_small_user_postcode": null,
"longitude": -2.10250,
"latitude": 57.14945,
"eastings": 393859,
"northings": 806073,
"split_indicator": "0",
"grid_link_indicator": "1",
"grid_link_positional_accuracy": "1",
"council_area": "Aberdeen City",
"electoral_ward": "Midstocket/Rosemount",
"registration_district": "RD20",
"enterprise_region": "Highlands and Islands",
"strategic_development_planning_area": "SD01",
"local_government_district": "Aberdeen City",
"local_government_district_1991": "City of Aberdeen",
"uk_parliamentary_constituency": "Aberdeen South",
"scottish_parliamentary_region": "North East Scotland",
"scottish_parliamentary_constituency": "Aberdeen Central",
"health_board_area": "Grampian",
"health_board_area_2006": "Grampian",
"health_board_area_1995": "Grampian",
"integration_authority": "Aberdeen City",
"output_area": "S00136537",
"output_area_2011": "S00088970",
"output_area_2001": "S00000700",
"output_area_1991": null,
"data_zone": "West End North - 01",
"data_zone_2011": "S01006571",
"data_zone_2001": "S01000125",
"intermediate_zone": "West End North",
"intermediate_zone_2011": "S02000007",
"intermediate_zone_2001": "S02000017",
"locality": "Aberdeen",
"locality_2020": "Aberdeen",
"locality_2001": "Aberdeen",
"locality_1991": null,
"settlement": "Aberdeen, Milltimber, and Peterculter",
"settlement_2020": "Aberdeen Settlement",
"settlement_2001": "Aberdeen Settlement",
"civil_parish": "Old Machar",
"island": "Mainland of Scotland",
"national_park": null,
"travel_to_work_area": "Aberdeen",
"lau_level_1": "Aberdeen City",
"itl_level_2": "North Eastern Scotland",
"itl_level_3": "Aberdeen City and Aberdeenshire",
"urban_rural_6_fold": "1",
"urban_rural_8_fold": "1",
"scottish_index_of_multiple_deprivation": 6414,
"roa_community_planning_partnership": "Aberdeen City",
"roa_local": "Aberdeen City",
"census_household_count": 0,
"census_household_count_2011": 8,
"census_household_count_2001": 12,
"census_household_count_1991": null,
"census_population_count": 0,
"census_population_count_2011": 18,
"census_population_count_2001": 26,
"census_population_count_1991": null,
"never_digitised": false,
"codes": {
"council_area": "S12000033",
"electoral_ward": "S13002841",
"enterprise_region": "S99999999",
"local_government_district": "S12000033",
"local_government_district_1991": "S99999999",
"uk_parliamentary_constituency": "S14000061",
"scottish_parliamentary_region": "S17000016",
"scottish_parliamentary_constituency": "S16000094",
"health_board_area": "S08000020",
"health_board_area_2006": "S08000006",
"health_board_area_1995": "0",
"integration_authority": "S37000002",
"data_zone": "S01013550",
"data_zone_2011": "S01006571",
"data_zone_2001": "S01000125",
"intermediate_zone": "S02002527",
"intermediate_zone_2011": "S02000007",
"intermediate_zone_2001": "S02000017",
"locality": "S19000001",
"settlement": "S20000001",
"civil_parish": "S07000001",
"island": "S20000001",
"national_park": null,
"travel_to_work_area": "S22000047",
"lau_level_1": "TLM50",
"itl_level_2": "TLM5",
"itl_level_3": "TLM50",
"registration_district": "RD20",
"strategic_development_planning_area": "SD01",
"roa_community_planning_partnership": "S12000033",
"roa_local": "S12000033"
}
}
}
{
"status": 200,
"result": {
"postcode": "AB10 1XG",
"pc_compact": "AB101XG",
"postcode_district": "AB10",
"postcode_sector": "AB10 1",
"incode": "1XG",
"outcode": "AB10",
"user_type": "0",
"date_of_introduction": "198001",
"date_of_deletion": null,
"linked_small_user_postcode": null,
"longitude": -2.10250,
"latitude": 57.14945,
"eastings": 393859,
"northings": 806073,
"split_indicator": "0",
"grid_link_indicator": "1",
"grid_link_positional_accuracy": "1",
"council_area": "Aberdeen City",
"electoral_ward": "Midstocket/Rosemount",
"registration_district": "RD20",
"enterprise_region": "Highlands and Islands",
"strategic_development_planning_area": "SD01",
"local_government_district": "Aberdeen City",
"local_government_district_1991": "City of Aberdeen",
"uk_parliamentary_constituency": "Aberdeen South",
"scottish_parliamentary_region": "North East Scotland",
"scottish_parliamentary_region_2021": "North East Scotland",
"scottish_parliamentary_constituency": "Aberdeen Central",
"scottish_parliamentary_constituency_2021": "Aberdeen Central",
"health_board_area": "Grampian",
"health_board_area_2006": "Grampian",
"health_board_area_1995": "Grampian",
"integration_authority": "Aberdeen City",
"output_area": "S00136537",
"output_area_2011": "S00088970",
"output_area_2001": "S00000700",
"output_area_1991": null,
"data_zone": "West End North - 01",
"data_zone_2011": "S01006571",
"data_zone_2001": "S01000125",
"intermediate_zone": "West End North",
"intermediate_zone_2011": "S02000007",
"intermediate_zone_2001": "S02000017",
"locality": "Aberdeen",
"locality_2020": "Aberdeen",
"locality_2001": "Aberdeen",
"locality_1991": null,
"settlement": "Aberdeen, Milltimber, and Peterculter",
"settlement_2020": "Aberdeen Settlement",
"settlement_2001": "Aberdeen Settlement",
"civil_parish": "Old Machar",
"island": "Mainland of Scotland",
"national_park": null,
"travel_to_work_area": "Aberdeen",
"lau_level_1": "Aberdeen City",
"itl_level_2": "North Eastern Scotland",
"itl_level_3": "Aberdeen City and Aberdeenshire",
"urban_rural_6_fold": "1",
"urban_rural_8_fold": "1",
"scottish_index_of_multiple_deprivation": 6414,
"roa_community_planning_partnership": "Aberdeen City",
"roa_local": "Aberdeen City",
"census_household_count": 0,
"census_household_count_2011": 8,
"census_household_count_2001": 12,
"census_household_count_1991": null,
"census_population_count": 0,
"census_population_count_2011": 18,
"census_population_count_2001": 26,
"census_population_count_1991": null,
"never_digitised": false,
"codes": {
"council_area": "S12000033",
"electoral_ward": "S13002841",
"enterprise_region": "S99999999",
"local_government_district": "S12000033",
"local_government_district_1991": "S99999999",
"uk_parliamentary_constituency": "S14000061",
"scottish_parliamentary_region": "S17000026",
"scottish_parliamentary_region_2021": "S17000014",
"scottish_parliamentary_constituency": "S16000151",
"scottish_parliamentary_constituency_2021": "S16000074",
"health_board_area": "S08000020",
"health_board_area_2006": "S08000006",
"health_board_area_1995": "0",
"integration_authority": "S37000002",
"data_zone": "S01013550",
"data_zone_2011": "S01006571",
"data_zone_2001": "S01000125",
"intermediate_zone": "S02002527",
"intermediate_zone_2011": "S02000007",
"intermediate_zone_2001": "S02000017",
"locality": "S19000001",
"settlement": "S20000001",
"civil_parish": "S07000001",
"island": "S20000001",
"national_park": null,
"travel_to_work_area": "S22000047",
"lau_level_1": "TLM50",
"itl_level_2": "TLM5",
"itl_level_3": "TLM50",
"registration_district": "RD20",
"strategic_development_planning_area": "SD01",
"roa_community_planning_partnership": "S12000033",
"roa_local": "S12000033"
}
}
}