Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Grav Geocoding Plugin

The Geocoding Plugin is an extension for Grav CMS. Converts addresses into geographic coordinates.

Buy Me A Coffee


  • Geocoding: convert human readable address into coordinates (lat/lon)
  • Use Grav builtin caching
  • Hide search results from cache via sha256 hashes
  • Prevent XSS by validating/encoding given input


Installing the Geocoding plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.

GPM Installation (Preferred)

To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:

bin/gpm install geocoding

This will install the Geocoding plugin into your /user/plugins-directory within Grav. Its files can be found under /your/site/grav/user/plugins/geocoding.

Manual Installation

To install the plugin manually, download the zip-version of this repository and unzip it under /your/site/grav/user/plugins. Then rename the folder to geocoding. You can find these files on GitHub or via

You should now have all the plugin files under


NOTE: This plugin is a modular component for Grav which may require other plugins to operate, please see its blueprints.yaml-file on GitHub.

Admin Plugin

If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu and clicking on the Add button.


Before configuring this plugin, you should copy the user/plugins/geocoding/geocoding.yaml to user/config/plugins/geocoding.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true
nominatim_host: ''
country_code: ''

Note that if you use the Admin Plugin, a file with your configuration named geocoding.yaml will be saved in the user/config/plugins/-folder once the configuration is saved in the Admin.

By using the Openstreetmap Nominatim service you aggree to their usage policy

You can directly debug Nominatim API request using your browser:


Go to to test the example below.

{% set location_query = uri.query('location') %}
{% set location = geocoding.getLocation(location_query) %}

{% if location != null %}
<a href="{{ }},{{ location.lon }}">
  {{ }}
{% elseif location_query != null %}
<div class="notices red">
    Location "{{ location_query }}" not found.
{% endif %}


Converts addresses into geographic coordinates







No packages published