Interface Response

Type declaration

• code: 2000

  Format: int32

• message: "Success"

• result: { administrative_county: string; building_name: string; building_number: string; country: string; country_iso: string; country_iso_2: string; county: string; county_code: string; dataset: string; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: string | number; id: string; language: string; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: string | number; organisation_name: string; po_box: string; post_town: string; postal_county: string; postcode: string; postcode_inward: string; postcode_outward: string; postcode_type: "S" | "L"; premise: string; su_organisation_indicator: string; sub_building_name: string; thoroughfare: string; traditional_county: string; udprn: number; umprn: string | number; uprn: string; ward: string } & { country?: "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; country_iso_2?: "GB" | "IM" | "JE" | "GG"; dataset?: "mr"; language?: "en" }