Use your API Key to authenticate with all Nearmap's HTTP-based services: WMS, WMTS, TMS and Image API. The API Key must be sent with every request to the service.
The API key can be sent with the request using the apikey URL parameter or an HTTP Authorization header.
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 and TMS services, both for Australia and the US:
See our Tile API, WMS, and TMS 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.
The Manage API Keys page of your Nearmap profile contains handy links to our WMS services containing your API Key. Click on the WMS links icon. The following screen will pop up:
Click on the Australia or United States button to copy the WMS link, including your API Key, to the clipboard. Paste it into your GIS application when prompted.
Note: New Zealand uses Australia WMS link.
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.
Here are examples of cURL commands for our TMS API: