---
title: "Return the surveys intersecting/overlapping the parcel boundary (based off address)"
method: POST
path: "/tx/address"
tags: ["new transaction"]
---

# Return the surveys intersecting/overlapping the parcel boundary (based off address)

`POST /tx/address`

Return the surveys intersecting/overlapping the parcel boundary (based off address). The caller has the option of passing the following parameter combinations:
* country + address
* country + streetAddress + state + postcode + city
* country + Address ID (GNAF ID for Australia)

If country + Address ID is provided any address parameters will be ignored.

## Query parameters

- `limit` integer
- `sort` 'captureDate' | 'location' | 'firstPhotoTime' | 'lastPhotoTime' | 'pixelSize' | 'timezone' | 'utcOffset' | 'onlineTime'
- `offset` integer

## Request body

- object
  - `address` string — Complete address as a single string (excluding country code).
  - `addressId` string — GNAF(Geocoded National Address File) identifier for an address (only for Australia).
  - `country` string, required — Country code as per ISO 3166-1 alpha 2.
  - `streetAddress` string — Street address.
  - `city` string — City name.
  - `postcode` string — Postal/zip code.
  - `state` string — State code.
  - `resources` string — Comma separated list of resource types. Each resource type is a colon separated namespace/type tuple, for example `raster:Vert`. Namespaces currently supported: * `raster` * `aiPacks` * `aiImpactAssessment` Supported `raster` resource types: * `Vert` - vertical orthorectified imagery * `DetailDtm` - aka DTM or bare earth elevation model * `DetailDsm` - aka DSM or surface model * `TrueOrtho` - True Ortho (strict top down imagery, derived from 3D) * `North`, `East`, `South`, `West` - panorama imagery Supported `aiPacks` resource types: * `building` * `building_char` * `construction` * `debris` * `pavement_marking` * `poles` * `pool` * `postcat` * `roof_char` * `roof_cond` * `roof_objects` * `solar` * `surface_permeability` * `surfaces` * `trampoline` * `vegetation` Supported `aiImpactAssessment` resource types: * `postcat`
  - `dates` 'all' | 'single' — Whether the customer wishes to access all dates available or only one date (per resource type).
  - `since` string — First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents since 5 months ago.
  - `until` string — Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents until 5 months ago.
  - `overlap` 'full' | 'all' — Whether or not to return metadata for imagery that only partially intersects the requested area. Default is to return all, such that surveys that only partially intersect the AOI will still be returned. If full is specified then only surveys completely within the given AOI are included.
  - `aiOn3dCoverage` string — When set to true, performs coverage check using the 3D attribute coverage boundary of the resource.
  - `preview` string — When true, a coverage request will not be charged credits, however it will also not include a transaction token in the response. All other behaviour should remain the same. This allows a client to check the coverage status of a location before committing to the transaction request.

## Response `200`

Surveys returned that match parcel boundary for given address

- TransactionResponse
  - `surveys` SurveyResult[]
    - `id` string — Unique id of survey.
    - `captureDate` string — Date that survey was captured on, in the format "YYYY-MM-DD".
    - `captureDateTime` string — Date and time the survey was captured".
    - `contentTypes` string[] — List of content types available for the survey.
    - `firstPhotoTime` string — Date and time in UTC of the first photo taken in the survey.
    - `lastPhotoTime` string — Date and time in UTC of the last photo taken in the survey.
    - `scale` object — Resource type information. Key is resource name (eg. Vert, DetailDsm etc)
    - `aiResourceId` string — Unique id of the AI resource.
    - `aiSystemVersion` string
    - `tags` object — Additional metadata about the survey such as post catastrophe events.
  - `transactionToken` string — Token used for all operations associated with this transaction
  - `costOfTransaction` number — Cost of transaction, in credits. The pricing table specifies the cost of the resources in the coverage response. The cost only includes the resources that have coverage available - if some of the resource types in the request weren't available, they don't contribute to the cost. That cost is multiplied by 1.5 if dates=all; and by the area covered by the transaction divided by 1000m², rounded up.
  - `reference` string — Reference string supplied via the `X-Nearmap-Ext-Reference` header
  - `geocodedAddress` string — Geocoded address (if address originally provided)
  - `geocodedConfidence` number — Confidence level (0 -> 1) of geocoded address
  - `bbox` string — Bounding box covering the area of interest. The format is minX, minY, maxX, maxY
  - `resourceServers` object — Resource type to URL template
  - `tileSizeInPixels` integer — Size of staticmap tiles in pixels
  - `limit` integer — Requested limit on the number of survey results
  - `offset` integer — Zero-based index of first record in the result
  - `total` integer — Total number of surveys available
  - `errors` Error[]

## Other responses

- `400` — Bad Request.
- `404` — Not Found for address query

---

[API](https://skmtc.net/nearmap/apis/tiles.md) · [All operations](https://skmtc.net/nearmap/apis/tiles/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nearmap/tiles/revisions/1f55d21ac4b9/schema)