Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Filterable

Filterable

Filter result for specific attribute, e.g. "line_1", "postcode", "organisation_name"

Hierarchy

Index

Properties

Properties

Optional filter

filter: ("id" | "dataset" | "country_iso" | "country_iso_2" | "country" | "language" | "line_1" | "line_2" | "line_3" | "post_town" | "postcode" | "county" | "county_code" | "uprn" | "udprn" | "umprn" | "postcode_outward" | "postcode_inward" | "dependant_locality" | "double_dependant_locality" | "thoroughfare" | "dependant_thoroughfare" | "building_number" | "building_name" | "sub_building_name" | "po_box" | "department_name" | "organisation_name" | "postcode_type" | "su_organisation_indicator" | "delivery_point_suffix" | "premise" | "administrative_county" | "postal_county" | "traditional_county" | "district" | "ward" | "longitude" | "latitude" | "eastings" | "northings")[]

You can reduce the size of the response payload selecting for only the attributes you want to see

example
{
  filter: ["line_1", "line_2", "line_3", "post_town", "postcode"],
}