Sign in

v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
paginated

Get the next page of requests with an existing transaction token

Return surveys matching the parameters of the request that generated the given transaction token. This request can provide a different offset and limit to fetch another page of surveys, and can change the sorting order.

get/tx

Query parameters

limitinteger

Limit the number of surveys in the result. Default is 20, Maximum is 1000.

sort'captureDate' | 'location' | 'firstPhotoTime' | 'lastPhotoTime' | 'pixelSize' | 'timezone' | 'utcOffset' | 'onlineTime'

The field by which to sort the surveys. Only one field can be specified. If this parameter is not used in the URL request, then the surveys are sorted by captureDate in descending order.

offsetinteger

Zero-based index of first record in the result.

Response

Surveys returned that match the original transaction, in the range [offset, offset+limit).

transactionTokenstring

Token used for all operations associated with this transaction

costOfTransactionnumber

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.

referencestring

Reference string supplied via the X-Nearmap-Ext-Reference header

geocodedAddressstring

Geocoded address (if address originally provided)

geocodedConfidencenumber

Confidence level (0 -> 1) of geocoded address

bboxstring

Bounding box covering the area of interest. The format is minX, minY, maxX, maxY

resourceServersobject

Resource type to URL template

tileSizeInPixelsinteger

Size of staticmap tiles in pixels

limitinteger

Requested limit on the number of survey results

offsetinteger

Zero-based index of first record in the result

totalinteger

Total number of surveys available

errorsError[]

Example response

{
  "surveys": [
    {
      "tags": {
        "postCatEventType": "hurricane",
        "postCatEventName": "Hurricane Idalia",
        "postCatEventDate": "2023-08-30"
      }
    }
  ]
}