Introduction
The Nearmap Transactional Content API is a single API platform that delivers majority of Nearmap content types, including Vertical, Panorama, DSM, DTM, and AI Packs and charges for them in "Transactional Credits".
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
Why you should use the Transactional Content API
The Transactional Content API provides several benefits over other Nearmap APIs such as Coverage, AI Feature, and Image APIs. These benefits are as follows:
- The Transactional Content API is a single platform to access all Nearmap content types.
- Both usage allocation and consumption will be measured using transactional credits.
- You can retrieve multiple datasets that are precisely aligned for the same Area of Interest (AOI) in a single transaction.
Authentication
Access to Nearmap imagery is only available to authenticated subscribers. Transactions may be requested from Nearmap servers with an API Key. Please refer to the API Key Authentication guide for details on how to obtain and use an API Key.
HTTP Requests
Nearmap's Transactional Content API is designed to be accessed by an application in an automated manner via HTTP requests.
Using the Transactional Content API
Retrieving imagery using the Transactional Content API is a two-step process, which comprises:
- Requesting coverage.
- Requesting content.
Requesting coverage
You can request coverage via the API endpoint /coverage/v2/tx using one of the following:
- Point/radius
- Bounding box
- Polygon
- Address
The API returns the following information:
- Resource information is returned as x and y coordinates.
- In addition to resource information, the Coverage call also returns a
transactionToken, which is valid for 30 days from the time it's generated. - Not all content types are available in a single survey; different content types may be returned in separate surveys.
- When the coverage call returns more surveys than will fit on one page (default 20 records), you may make subsequent calls to return remaining surveys by passing the
transactionToken and setting an offset and/or a limit . Passing the token ensures that you are not charged again for the coverage call.
NOTE: Credits are deducted from your balance when making a coverage call. The exact amount of credits deducted is returned as costOfTransaction.
Requesting content
You can request raster or AI content using one of the following endpoints:
- For raster maps - /staticmap/v3/surveys/{surveyId}/{type}.{format}
- For AI assessment - /ai/features/v4/tx/surveyresources/{aiResourceId}/features.json. You
need this additional product to access AI assessment - https://api.nearmap.com/ai/assessment/v1/tx/surveyresources/{aiResourceId}
Parameters
For details about the parameters, refer to the API specifications below.
API Specifications
