Transactional Content API

Use the Transactional Content API to access different Nearmap content types, including Vertical, Panorama, DSM, DTM, and AI Packs.

The Transactional Content API is a single API platform for accessing the majority of Nearmap content types, including Vertical, Panorama, DSM, DTM, and AI Packs, charged per transaction using "Transactional Credits". It is the recommended API for property assessment workflows that need multiple content types co-registered to the same AOI.

You can use the Transactional Content API to:

  • Retrieve imagery or AI features using coordinates (latitude and longitude) or address
  • View additional imagery surrounding a property
  • View multiple datasets for a single location
  • Retrieve imagery for property assessment workflows related to real estate, insurance, solar panel installations and landscaping

Key benefits

  • Single platform: access all supported content types through one API.
  • Credit-based billing: both usage allocation and consumption are measured in Transactional Credits.
  • Multi-dataset retrieval: request multiple content types for the same AOI in a single transaction, with precise spatial alignment guaranteed.
  • Flexible location input: query by point/radius, bounding box, polygon, or street address.

How it works

Retrieving imagery is a two-step process.

Step 1 - Request coverage

Call the /coverage/v2/tx endpoint with one of the following location inputs:

  • Point/radius
  • Bounding box
  • Polygon
  • Address

The response includes:

  • Resource information is returned as x and y coordinates for each content type and survey
  • A transactionToken valid for 30 days from the time it's generated, used to authenticate subsequent content requests.
  • The costOfTransaction field showing the exact amount of credits deducted.
  • Pagination details if more than 20 surveys match. Pass the transactionToken in subsequent calls to return remaining surveys to ensure you are not charged again for the coverage call.

Note: Credits are deducted from your balance on the coverage call, not on content retrieval.

Step 2 - Request content

Use the transactionToken and resource IDs from Step 1 to retrieve content::

  • Raster imagery (Vertical, Panorama, DSM, DTM) using <Anchor label="/staticmap/v3/surveys/{surveyId}/{type}.{format}" target="_blank" href="https://developer.nearmap.com/reference/get_surveys-surveyid-type-format-1">/staticmap/v3/surveys/{surveyId}/{type}.{format}</Anchor>
  • AI - /ai/features/v4/tx/surveyresources/{aiResourceId}/features.json.

Note: Access to AI content via this API requires the AI assessment add-on product - /ai/features/v4/tx/surveyresources/{aiResourceId}/features.json. Contact your Account Manager if you do not have access. - ``