Ideal Postcodes API Typings
Options
All
  • Public
  • Public/Protected
  • All
Menu

Umprn Address

Standard Address object returned by the API that represents a single Multiple Residence premise on Royal Mail's Postcode Address File.

UMPRN addresses will always return a UMPRN attribute.

API Documentation for umprn/:umprn: ideal-postcodes.co.uk/documentation/umprn.

Hierarchy

Index

Properties

Properties

administrative_county

administrative_county: string

Administrative County

ideal-postcodes.co.uk/documentation/paf-data/#administrative_county

building_name

building_name: string

Building Name

ideal-postcodes.co.uk/documentation/paf-data/#building_name

building_number

building_number: string

Building Number

ideal-postcodes.co.uk/documentation/paf-data/#building_number

country

country: string

Country

ideal-postcodes.co.uk/documentation/paf-data/#country

county

county: string

County

ideal-postcodes.co.uk/documentation/paf-data/#county

delivery_point_suffix

delivery_point_suffix: string

Delivery Point Suffix

ideal-postcodes.co.uk/documentation/paf-data/#delivery_point_suffix

department_name

department_name: string

Department Name

ideal-postcodes.co.uk/documentation/paf-data/#department_name

dependant_locality

dependant_locality: string

Dependant Locality

ideal-postcodes.co.uk/documentation/paf-data/#dependant_locality

dependant_thoroughfare

dependant_thoroughfare: string

Dependant Thoroughfare

ideal-postcodes.co.uk/documentation/paf-data/#dependant_thoroughfare

district

district: string

District

ideal-postcodes.co.uk/documentation/paf-data/#district

double_dependant_locality

double_dependant_locality: string

Double Dependant Locality

ideal-postcodes.co.uk/documentation/paf-data/#double_dependant_locality

eastings

eastings: AddressNumber

Eastings

ideal-postcodes.co.uk/documentation/paf-data/#eastings

latitude

latitude: AddressNumber

Latitude

ideal-postcodes.co.uk/documentation/paf-data/#latitude

line_1

line_1: string

Address Line 1

ideal-postcodes.co.uk/documentation/paf-data/#line_1

line_2

line_2: string

Address Line 2

ideal-postcodes.co.uk/documentation/paf-data/#line_2

line_3

line_3: string

Address Line 3

ideal-postcodes.co.uk/documentation/paf-data/#line_3

longitude

longitude: AddressNumber

Longitude

ideal-postcodes.co.uk/documentation/paf-data/#longitude

northings

northings: AddressNumber

Northings

ideal-postcodes.co.uk/documentation/paf-data/#northings

organisation_name

organisation_name: string

Organisation Name

ideal-postcodes.co.uk/documentation/paf-data/#organisation_name

po_box

po_box: string

PO Box

ideal-postcodes.co.uk/documentation/paf-data/#po_box

post_town

post_town: string

Post Town

ideal-postcodes.co.uk/documentation/paf-data/#post_town

postal_county

postal_county: string

Postal County

ideal-postcodes.co.uk/documentation/paf-data/#postal_county

postcode

postcode: string

Postcode

ideal-postcodes.co.uk/documentation/paf-data/#postcode

postcode_inward

postcode_inward: string

Inward Postcode

ideal-postcodes.co.uk/documentation/paf-data/#postcode_inward

postcode_outward

postcode_outward: string

Outward Postcode

ideal-postcodes.co.uk/documentation/paf-data/#postcode_outward

postcode_type

postcode_type: string

Postcode Type

ideal-postcodes.co.uk/documentation/paf-data/#postcode_type

premise

premise: string

Premise

ideal-postcodes.co.uk/documentation/paf-data/#premise

su_organisation_indicator

su_organisation_indicator: string

SU Organisation Indicator

ideal-postcodes.co.uk/documentation/paf-data/#su_organisation_indicator

sub_building_name

sub_building_name: string

Sub Building Name

ideal-postcodes.co.uk/documentation/paf-data/#sub_building_name

thoroughfare

thoroughfare: string

Thoroughfare

ideal-postcodes.co.uk/documentation/paf-data/#thoroughfare

traditional_county

traditional_county: string

Traditional County

ideal-postcodes.co.uk/documentation/paf-data/#traditional_county

udprn

udprn: number

UDPRN

Unique ID provided to a premise in Royal Mail's Postcode Address File.

ideal-postcodes.co.uk/documentation/paf-data/#udprn_code

umprn

umprn: number

ward

ward: string

Ward

ideal-postcodes.co.uk/documentation/paf-data/#ward