---
title: "Return the surveys intersecting/overlapping with a bounding box"
method: GET
path: "/tx/bbox/{bbox}"
tags: ["new transaction"]
---

# Return the surveys intersecting/overlapping with a bounding box

`GET /tx/bbox/{bbox}`

## Request

- Base URL: `https://api.nearmap.com/coverage/v2`
- URL: `https://api.nearmap.com/coverage/v2/tx/bbox/{bbox}`
- Auth: one of:
  - API key in query parameter `apikey`
  - API key in header `Authorization`

Return the surveys intersecting/overlapping with a bounding box.

## Path parameters

- `bbox` string, required

## Query parameters

- `dates` 'all' | 'single', required
- `resources` string, required
- `since` string
- `until` string
- `limit` integer
- `sort` 'captureDate' | 'location' | 'firstPhotoTime' | 'lastPhotoTime' | 'pixelSize' | 'timezone' | 'utcOffset' | 'onlineTime'
- `offset` integer
- `overlap` 'full' | 'all'
- `filter` 'allTypes' | 'anyTypes'
- `aiOn3dCoverage` boolean
- `preview` boolean

## Response `200`

Surveys returned that match given bounding box

- 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

---

[API](https://skmtc.dev/nearmap/apis/transactional-coverage-api.md) - [All operations](https://skmtc.dev/nearmap/apis/transactional-coverage-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nearmap/apis/transactional-coverage-api/revisions/d14032800fee?raw)