API Applications allow you to organise your Nearmap integrations, and to set different access restrictions for different integrations. You can have as many API Applications as you need on your Nearmap account.

As a Nearmap administrator, you can use the API Access tab to:

  • Create new API Applications
  • Manage your existing API applications
  • View which users have created an API Key for an API application
  • Create and manage your own API Keys (using the same interface as non-admin users)


You must be a Nearmap administrator to create and manage API Applications. 

Creating and managing an API Application

  1. Log in to Nearmap at https://admin.nearmap.com/welcome as a user who is a Nearmap administrator.

  2. Click the API Access tab at the top of the screen, then the API Applications. If you do not see the tab, it is likely that you are not a Nearmap administrator.

    1. To create a new API Application, click the Create New button.


    2. To edit an API Application, click the Edit Application pencil icon against the application you want to edit.
  3. Enter or change an Application Name. This can be any string of characters. A good name would describe the integration that you intend to have with Nearmap imagery.

  4. You can optionally specify restrictions on which IP addresses or web sites can load Nearmap imagery via an API Key associated with this API Application:

    • IP restrictions: only IP addresses in the ranges you specify will be able to load Nearmap imagery. CIDR addresses are accepted. For example, 192.168.34.0/24.

    • Referrer restrictions: only URLs that begin with one of the specified referrer prefixes are allowed access to Nearmap imagery. This is based on web browser support for the HTTP referrer header field. 

      Enter here your referrer address/addresses, in a comma-separated list. A referrer address can contain sub-directories. For example, https://mywebsite.com/myapplications/app1.

      You must explicitly include https:// or http:// at the start of a Referrer Restrictions URL, the restriction will not work if this is missing. 

      Note: There is a character limit of 1 to 100 characters for the referrer restrictions.


    If the purpose of these restrictions is not clear to you, we recommend that you do not enter any restrictions.

    1. If creating a new API Application, click the Save button.
    2. If editing an existing API Application, click the Update button.

Your API Application should be displayed on the screen. Each user on your Nearmap account can now create an API Key for that API Application.


Creating an API Key

To find out how to create and delete an API key, please read Managing API Keys.


Deleting an API Application

If you no longer need an existing API Application, you can log in to Nearmap to delete it.

  1. Log in to Nearmap at https://admin.nearmap.com/welcome.

  2. Click the API Access tab at the top of the screen, then the API Applications. If you do not see the tab, it is likely that you are not a Nearmap administrator.

  3. Find your API Application and click the Delete icon.