Skip to content

Attribution, usage limits and referrer requirements for Nominatim search #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m-mohr merged 2 commits into from
Apr 15, 2026
Merged

Attribution, usage limits and referrer requirements for Nominatim search #240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f64c31d
Attribution, usage limits and referrer requirements for Nominatim sea…
m-mohr Apr 10, 2026
7b63c19
Add referer header
m-mohr Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 34 additions & 13 deletions src/components/GeocodingSearch.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import { ref, shallowRef, watch } from 'vue'
import { debounce } from 'vuetify/lib/util/helpers.mjs'
import type { PlaceResult } from '../composables/useAreaOfInterest'
import { mdiHelpCircleOutline } from '@mdi/js'

const emit = defineEmits<{
(e: 'location-selected', place: PlaceResult): void
Expand All @@ -18,8 +19,18 @@ watch(

isLoadingPlaces.value = true
try {
const referer = 'https://github.com/fieldsoftheworld/ftw-inference-app'
const response = await fetch(
`https://nominatim.openstreetmap.org/search?format=json&q=${encodeURIComponent(newSearch)}`,
// User-Agent or Referer are required by Nominatim's usage policy.
// User-Agent is not working in Chrome, thus sending both.
// Referer is usually set by the browser, but let's ensure it's set.
{
headers: {
'User-Agent': referer,
Referer: referer,
},
},
)
const data = await response.json()
suggestedPlaces.value = data?.map((place: any) => ({
Expand All @@ -31,7 +42,7 @@ watch(
} finally {
isLoadingPlaces.value = false
}
}, 500),
}, 1000),
)

const onLocationSelected = (item: { value: PlaceResult; title: string } | null) => {
Expand All @@ -42,16 +53,26 @@ const onLocationSelected = (item: { value: PlaceResult; title: string } | null)
</script>

<template>
<v-autocomplete
@update:model-value="onLocationSelected"
v-model:search="placeSearch"
:loading="isLoadingPlaces"
:items="suggestedPlaces"
label="Search for a place"
item-title="title"
return-object
hide-details
dense
variant="outlined"
></v-autocomplete>
<div class="d-flex align-center mb-2 ga-2">
<v-autocomplete
@update:model-value="onLocationSelected"
v-model:search="placeSearch"
:loading="isLoadingPlaces"
:items="suggestedPlaces"
label="Search for a place"
item-title="title"
return-object
hide-details
dense
variant="outlined"
></v-autocomplete>
<v-tooltip max-width="400" open-on-click>
<template #activator="{ props }">
<v-icon class="ml-1" :icon="mdiHelpCircleOutline" size="x-small" v-bind="props"></v-icon>
</template>
Geocoding provided by Nominatim.<br />
&copy; OpenStreetMap, https://openstreetmap.org<br />
License: ODbL
</v-tooltip>
</div>
</template>
Loading