Using API Key in a URL

Include the apikey=YOUR_API_KEY name/value pair in the URL (replacing "YOUR_API_KEY" with the sequence of characters that make up your API Key).

Here are example URL formats using API Key for our WMS services, both for Australia and the US.

WMS

• Simple: https://api.nearmap.com/wms/v1/latest/apikey/<APIKEY>
• Custom: https://api.nearmap.com/wms/v1/places/<PLACES_ID>/apikey/<APIKEY>

Tile API

All areas: https://api.nearmap.com/tiles/v3/Vert/21/1855981/1265938.jpg?apikey=YOUR_API_KEY

See our Tile API and WMS documentation for further examples for each of our APIs.

See our GIS and CAD Integration pages for specific instructions for various third-party GIS applications.

Using API Key in an HTTP Authorization Header

The API Key can be presented in an HTTP Authorization header . The format of the header is as follows:

Authorization: Apikey=YOUR_API_KEY

The case of the authorization type is significant: the string must be "Apikey" with a capital A and all other characters lowercase.