<!--
{
  "availability" : [
    "MapKit JS: 5.78.1 -"
  ],
  "documentType" : "symbol",
  "framework" : "MapKitJS",
  "identifier" : "/documentation/MapKitJS/AddressFilter",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "MapKit JS"
    ],
    "preciseIdentifier" : "cl/mapkit.AddressFilter"
  },
  "title" : "AddressFilter"
}
-->

# AddressFilter

An object that filters which address options to include or exclude in search results.

```
class AddressFilter
```

## Overview

Use this object to filter search results by criteria, such as country, region, and municipality. See [`AddressCategory`](/documentation/MapKitJS/AddressCategory) for more information.

## Topics

### Creating filters

[`static excluding(categories: AddressCategory[]): AddressFilter;`](/documentation/MapKitJS/AddressFilter/excluding)

A list of categories to exclude from a search.

[`static including(categories: AddressCategory[]): AddressFilter;`](/documentation/MapKitJS/AddressFilter/including)

A list of categories to include in a search.

[`static excludingAllCategories: () => AddressFilter;`](/documentation/MapKitJS/AddressFilter/excludingAllCategories)

A value that excludes all address categories.

[`static includingAllCategories: () => AddressFilter;`](/documentation/MapKitJS/AddressFilter/includingAllCategories)

A value that includes all address categories.

### Querying filter behavior

[`excludesCategory(category: AddressCategory): boolean;`](/documentation/MapKitJS/AddressFilter/excludesCategory)

A Boolean value that indicates whether to exclude a category from a search.

[`includesCategory(category: AddressCategory): boolean;`](/documentation/MapKitJS/AddressFilter/includesCategory)

A Boolean value that indicates whether to include a category from a search.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)