Skip to main content

OpenStreetMap Provider

OpenStreetMap (through Nominatim) is a free geocoding service that doesn't require an API key.

Usage​

import { LocationAutocomplete } from '@julekgwa/react-native-places-autocomplete';

export default function App() {
  return (
    <LocationAutocomplete
      provider="openstreetmap"
      queryOptions={{
        limit: 10,
      }}
      onLocationSelect={(location) => {
        console.log(location);
      }}
    />
  );
}

Configuration Options​

<LocationAutocomplete
  provider="openstreetmap"
  queryOptions={{
    countrycodes: 'us,ca', // Limit to specific countries
    'accept-language': 'en', // Preferred language
    limit: 10, // Max number of results
    addressdetails: 1, // Include address details
  }}
/>

Query options​

Below are the supported queryOptions for the OpenStreetMap (Nominatim) provider. Use these to control response format, paging, bounding boxes, language, and other provider-specific behavior.

NameTypeRequiredDefaultDescriptionExample
limitnumberNo10Maximum number of results to return.10
polygon_geojsonbooleanNofalseReturn polygon geometry in GeoJSON format.true
viewbox[number,number,number,number]No—Bounding box to bias/restrict results: [left, top, right, bottom] (minLon, maxLat, maxLon, minLat).[ -0.56316, 51.683979, 0.27897, 51.28043 ]
boundedbooleanNofalseRestrict results strictly to the viewbox area when true.true
accept-languagestringNoenPreferred language for results (ISO 639-1).'en'
countrycodesstringNo—Comma-separated ISO 3166-1 alpha-2 country codes to limit search.'de,gb'
layerstringNo—Restrict results to a specific layer (e.g. address,poi,railway).'address'
polygon_thresholdnumberNo—Polygon simplification threshold. Smaller = more detailed polygons.0.003
offsetnumberNo0Result offset within the full result set (for pagination).20
format'json' | 'xml' | 'jsonv2' | 'geojson' | 'geocodejson'No'json'Response format.'geojson'

Response Format​

// OpenStreetMap (Nominatim) Raw Response Type
interface OpenStreetMapResult {
  place_id: number | string;
  licence?: string;
  osm_type?: 'node' | 'way' | 'relation' | string;
  osm_id?: number | string;
  lat: string;
  lon: string;
  class?: string;
  type?: string;
  place_rank?: number;
  importance?: number;
  addresstype?: string;
  name?: string;
  display_name: string;
  address?: {
    road?: string;
    suburb?: string;
    city?: string;
    county?: string;
    state?: string;
    'ISO3166-2-lvl4'?: string;
    postcode?: string;
    country?: string;
    country_code?: string;
    [key: string]: unknown;
  };
  boundingbox?: [string, string, string, string];
}

// LocationSuggestion with OpenStreetMap raw data
interface LocationSuggestion<Raw = OpenStreetMapResult> {
  place_id: string;
  display_name: string;
  lat: string;
  lon: string;
  type: string;
  importance: number;
  raw?: Raw; // Contains the original OpenStreetMap response
}

Example of received data in onLocationSelect:

<LocationAutocomplete
  provider="openstreetmap"
  onLocationSelect={(location) => {
    console.log(location.display_name); // Full formatted address
    console.log(location.lat, location.lon); // Coordinates
    console.log(location.raw?.address); // Structured address components
  }}
/>

Rate Limits​

OpenStreetMap has usage limits: