---
title: "Find overlapping features"
method: POST
path: "/v1/spatial/overlap"
tags: ["Spatial Analysis"]
---

# Find overlapping features

`POST /v1/spatial/overlap`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/spatial/overlap`
- Auth: one of:
  - `bearerAuth` (a scheme the document does not define)
  - `ApiKeyAuth` (a scheme the document does not define)

Returns intersection geometries between the input geometry/address and table features, including overlap area/length and overlap percentages against both input and target geometries. Supports custom output attribute names, units of measure, optional buffer distance, and pagination.

## Query parameters

- `offset` integer
- `limit` integer

## Headers

- `X-Request-Id` string

## Request body

- OverlapsRequest
  - `tableName` string, required: Name of the table containing spatial data used by the operation.
  - `location` Location
    - `format` 'wkt' | 'geojson' | 'lonlat' | 'address': Format of the location input. Allowed values: WKT, GEOJSON, LonLat, Address. Default value is WKT.
    - `value` string, required: Input geometry or address value. Geometry coordinates must use EPSG:4326 (longitude, latitude).
    - `country` string: Country for address input. Mandatory when format is Address.
  - `attributeFilter` string: Optional scalar attribute filter expression using logical operators (AND/OR/NOT) and comparison operators such as =, <>, <, <=, >, >=, IS NULL, LIKE, BETWEEN, and IN.
  - `attributes` string[], required: List of table attributes to include in the response. Use ["*"] to return all scalar table attributes.
  - `uom` string, required: Unit of measure used for overlap length/area output. Allowed units: mi, km, ft, m, nm.
  - `areaAttributeName` string: Custom name of intersection area parameter when intersection area is polygon. Default value is "intersectionArea".
  - `lengthAttributeName` string: Custom name of intersection length parameter when intersection area is linestring. Default value is "intersectionLength".
  - `percentTargetAttributeName` string: Custom name of parameter indicating percentage of overlap with target geometry. Default value is "percentageOfTarget".
  - `percentInputAttributeName` string: Custom name of parameter indicating percentage of overlap with input geometry. Default value is "percentageOfInput".
  - `uomAttributeName` string: Custom name of unit-of-measure attribute in the response. Default value is "uom".
  - `bufferDistance` string: Distance by which the input geometry will be expanded. Supports positive values for all geometry types. Negative values are only supported for polygon geometries to create inward buffers.

## Response `200`

Successful retrieval of overlaps operations

## Other responses

- `400`: Invalid request
- `401`: Unauthorized: Invalid token
- `403`: Forbidden
- `429`: Too many requests
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/precisely/apis/feature-api.md) · [All operations](https://skmtc.dev/precisely/apis/feature-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/feature-api/revisions/6dc26f89c0aa?raw)