Sign in

v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
new transaction

Return the surveys intersecting/overlapping the parcel boundary (based off 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.

post/tx/address

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.

Request body

addressstring

Complete address as a single string (excluding country code).

addressIdstring

GNAF(Geocoded National Address File) identifier for an address (only for Australia).

countrystring required

Country code as per ISO 3166-1 alpha 2.

streetAddressstring

Street address.

citystring

City name.

postcodestring

Postal/zip code.

statestring

State code.

resourcesstring

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).

sincestring

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.

untilstring

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.

aiOn3dCoveragestring

When set to true, performs coverage check using the 3D attribute coverage boundary of the resource.

previewstring

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.

Example request

{
  "address": "1 Foo St, Testville, CO, 12345",
  "addressId": "GAQLD155997576",
  "country": "US",
  "streetAddress": "1 foo st",
  "city": "seattle",
  "postcode": "123456",
  "state": "WA",
  "resources": "raster:Vert,raster:TrueOrtho,aiPacks:roof_objects",
  "dates": "all",
  "overlap": "all"
}

Response

Surveys returned that match parcel boundary for given address

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"
      }
    }
  ]
}