LocationIQ

https://docs.locationiq.com/docs/
Admin
LocationIQ provides cost-effective and scalable APIs for various location services, including...
Tokens:43,163
Snippets:274
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Sources and Destinations Parameter Example

Source: https://docs.locationiq.com/docs/matrix-api

Example of how to specify indices for sources and destinations parameters.

```text
sources=0;5;7&destinations=5;1;4;2;3;6
```

--------------------------------

### Nearby API Request Examples

Source: https://docs.locationiq.com/docs/nearby-poi

Implementation examples for querying nearby locations using various programming languages and tools.

```php
<?php

$curl = curl_init('https://us1.locationiq.com/v1/nearby?key=YOUR_ACCESS_TOKEN&lat=-37.870983&lon=144.980714&tag=restaurant&radius=100&format=json');

curl_setopt_array($curl, array(
  CURLOPT_RETURNTRANSFER    =>  true,
  CURLOPT_FOLLOWLOCATION    =>  true,
  CURLOPT_MAXREDIRS         =>  10,
  CURLOPT_TIMEOUT           =>  30,
  CURLOPT_CUSTOMREQUEST     =>  'GET',
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```python
import requests

url = "https://us1.locationiq.com/v1/nearby"

data = {
    'key': 'YOUR_ACCESS_TOKEN',
    'lat': '-37.870983',
    'lon': '144.980714',
    'tag': 'restaurant',
    'radius': 100,
    'format': 'json'
}

response = requests.get(url, params=data)

print(response.text)
```

```shell
curl --request GET \
  --url 'https://us1.locationiq.com/v1/nearby?key=YOUR_ACCESS_TOKEN&lat=-37.870983&lon=144.980714&tag=restaurant&radius=100&format=json'
```

```javascript
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://us1.locationiq.com/v1/nearby?key=YOUR_ACCESS_TOKEN&lat=-37.870983&lon=144.980714&tag=restaurant&radius=100&format=json",
  "method": "GET"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

--------------------------------

### Optimize API Request Examples

Source: https://docs.locationiq.com/docs/optimize-api

Examples of API requests for round trips with varying numbers of stops and constraints.

```HTTP
https://us1.locationiq.com/v1/optimize/driving/-0.127627,51.503355;-0.087199,51.509562;-0.076134,51.508037?key=<YOUR_ACCESS_TOKEN>'
```

```HTTP
https://us1.locationiq.com/v1/optimize/driving/-0.127627,51.503355;-0.087199,51.509562;-0.076134,51.508037;-0.142001,51.501284?key=<YOUR_ACCESS_TOKEN>&source=first&destination=last
```

--------------------------------

### Matrix API Example Requests

Source: https://docs.locationiq.com/docs/matrix-api

Various examples of Matrix API requests for different matrix sizes and annotation requirements.

```HTTP
https://us1.locationiq.com/v1/matrix/driving/-0.127627,51.503355;-0.087199,51.509562;-0.076134,51.508037?key=<YOUR_ACCESS_TOKEN>
```

```HTTP
https://us1.locationiq.com/v1/matrix/driving/-0.127627,51.503355;-0.087199,51.509562;-0.142001,51.501284?sources=0&key=<YOUR_ACCESS_TOKEN>
```

```HTTP
https://us1.locationiq.com/v1/matrix/driving/-0.127627,51.503355;-0.087199,51.509562;-0.142001,51.501284?annotations=distance,duration&key=<YOUR_ACCESS_TOKEN>
```

--------------------------------

### Reverse Geocoding Request Examples

Source: https://docs.locationiq.com/docs/reverse-geocoding

Implementation examples for performing reverse geocoding requests across different programming languages.

```shell
curl --request GET \
     --url 'https://us1.locationiq.com/v1/reverse?lat=51.5233879&lon=-0.1582367&format=json&key=kiara' \
     --header 'accept: application/json'
```

```javascript
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://us1.locationiq.com/v1/reverse?key=YOUR_ACCESS_TOKEN&lat=-37.870662&lon=144.9803321&format=json",
  "method": "GET"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

```python
import requests

url = "https://us1.locationiq.com/v1/reverse"

data = {
    'key': 'YOUR_ACCESS_TOKEN',
    'lat': '-37.870662',
    'lon': '144.9803321',
    'format': 'json'
}

response = requests.get(url, params=data)

print(response.text)
```

```php
<?php

$curl = curl_init('https://us1.locationiq.com/v1/reverse?key=YOUR_ACCESS_TOKEN&lat=-37.870662&lon=144.9803321&format=json');

curl_setopt_array($curl, array(
  CURLOPT_RETURNTRANSFER    =>  true,
  CURLOPT_FOLLOWLOCATION    =>  true,
  CURLOPT_MAXREDIRS         =>  10,
  CURLOPT_TIMEOUT           =>  30,
  CURLOPT_CUSTOMREQUEST     =>  'GET',
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Autocomplete Request Examples

Source: https://docs.locationiq.com/docs/autocomplete

Standard GET requests to the Autocomplete API using various programming languages.

```shell
curl --request GET \
  --url 'https://api.locationiq.com/v1/autocomplete?key=YOUR_ACCESS_TOKEN&q=Empire'
```

```php
<?php
$curl = curl_init('https://api.locationiq.com/v1/autocomplete?key=YOUR_ACCESS_TOKEN&q=Empire');

curl_setopt_array($curl, array(
  CURLOPT_RETURNTRANSFER    =>  true,
  CURLOPT_FOLLOWLOCATION    =>  true,
  CURLOPT_MAXREDIRS         =>  10,
  CURLOPT_TIMEOUT           =>  30,
  CURLOPT_CUSTOMREQUEST     =>  'GET',
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo 'cURL Error #:' . $err;
} else {
  echo $response;
}
```

```python
import requests

url = "https://api.locationiq.com/v1/autocomplete"

data = {
    'key': 'YOUR_ACCESS_TOKEN',
    'q': 'Empire'
}

response = requests.get(url, params=data)

print(response.text)
```

```javascript
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.locationiq.com/v1/autocomplete?key=YOUR_ACCESS_TOKEN&q=Empire",
  "method": "GET"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

--------------------------------

### Request Balance using cURL

Source: https://docs.locationiq.com/docs/balance-api

Command line example to fetch balance data.

```shell
curl --request GET \
  --url 'https://us1.locationiq.com/v1/balance?key=YOUR_ACCESS_TOKEN&format=json'
```

--------------------------------

### Map Matching API Response Example

Source: https://docs.locationiq.com/docs/map-matching-api

Example JSON response structure returned by the Map Matching API.

```json
{
  "code": "ok",
  "tracepoints": {
    "waypoint_index": 0,
    "matchings_index": 0,
    "alternatives_count": 0,
    "distance": 8.414822,
    "location": [
      -0.161136,
      51.523832
    ],
    "name": "Huntsworth Mews"
  },
  "matchings": {
    "duration": 109.3,
    "distance": 752.4,
    "weight": 109.3,
    "geometry": "}fnyHbn^|@_@O_BeDlAw@}G~@uB@WXs@fE}Ab@OxBpU",
    "confidence": 0,
    "weight_name": "routability",
    "legs": {
      "steps": [],
      "weight": 10.2,
      "distance": 36.7,
      "summary": "",
      "duration": 10.2
    }
  }
}
```

--------------------------------

### Balance API Response Example

Source: https://docs.locationiq.com/docs/balance-api

JSON structure returned by the Balance API.

```json
{
    "status": "ok",
    "balance": {
        "day": 30000,
        "bonus" : 0
    }
}
```

--------------------------------

### Request Example for Nearest API

Source: https://docs.locationiq.com/docs/nearest-api

An example request querying the two nearest snapped locations for a specific coordinate with bearing constraints.

```http
https://us1.locationiq.com/v1/nearest/driving/-0.142001,51.501284?key=<YOUR_ACCESS_TOKEN>&number=2&bearings=0,20
```

--------------------------------

### Directions API Request Example

Source: https://docs.locationiq.com/docs/directions-api

A sample request URL for a route in London with three coordinates and overview disabled.

```text
https://us1.locationiq.com/v1/directions/driving/-0.127627,51.503355;-0.087199,51.509562;-0.076134,51.508037?key=<YOUR_ACCESS_TOKEN>&overview=false
```

--------------------------------

### Matrix API JSON Response Example

Source: https://docs.locationiq.com/docs/matrix-api

Example of a successful JSON response containing distance and duration matrices along with waypoint details.

```json
{
    "code": "Ok",
    "distances": [
        [0, 3833.6, 1552.8],
        [3763.8, 0, 4963],
        [1622.7, 4953.2, 0]
    ],
    "durations": [
        [0, 529, 185.7],
        [472.3, 0, 622.4],
        [197.7, 663.1, 0]
    ],
    "sources": [{
        "hint": "dRJAiW_vt4sOAAAAAAAAAAAAAAAAAAAA1kBzQQAAAAAAAAAAAAAAAA4AAAAAAAAAAAAAAAAAAAAIFwEAIhL-_zzgEQN1Df7_--ARAwAAzxB42O4j",
        "distance": 85.752389,
        "location": [-0.12643, 51.503164],
        "name": "Downing Street"
    }, {
        "hint": "BdAMgP___38BAAAAKAAAAFsAAAC7AAAAdwJqP1dc30EhbYFCWlnxQgEAAAAoAAAAWwAAALsAAAAIFwEAYKv-_zr5EQNhq_7_OvkRAwQA3wB42O4j",
        "distance": 0.069405,
        "location": [-0.0872, 51.509562],
        "name": "King William Street"
    }, {
        "hint": "inUjk411I5MAAAAADwAAAF0AAAAfAQAAAAAAAIdkSEB2P51Ba9xvQgAAAAAHAAAAMAAAAJEAAAAIFwEARdb9__DVEQNP1f3_5NgRAwYAXwV42O4j",
        "distance": 85.827043,
        "location": [-0.141755, 51.500528],
        "name": "Ambassador's Court"
    }],
    "destinations": [{
        "hint": "dRJAiW_vt4sOAAAAAAAAAAAAAAAAAAAA1kBzQQAAAAAAAAAAAAAAAA4AAAAAAAAAAAAAAAAAAAAIFwEAIhL-_zzgEQN1Df7_--ARAwAAzxB42O4j",
        "distance": 85.752389,
        "location": [-0.12643, 51.503164],
        "name": "Downing Street"
    }, {
        "hint": "BdAMgP___38BAAAAKAAAAFsAAAC7AAAAdwJqP1dc30EhbYFCWlnxQgEAAAAoAAAAWwAAALsAAAAIFwEAYKv-_zr5EQNhq_7_OvkRAwQA3wB42O4j",
        "distance": 0.069405,
        "location": [-0.0872, 51.509562],
        "name": "King William Street"
    }, {
        "hint": "inUjk411I5MAAAAADwAAAF0AAAAfAQAAAAAAAIdkSEB2P51Ba9xvQgAAAAAHAAAAMAAAAJEAAAAIFwEARdb9__DVEQNP1f3_5NgRAwYAXwV42O4j",
        "distance": 85.827043,
        "location": [-0.141755, 51.500528],
        "name": "Ambassador's Court"
    }]
}
```

--------------------------------

### Timezone Conversion Implementation

Source: https://docs.locationiq.com/docs/quickstart-convert-time-across-timezones

Comprehensive examples demonstrating how to fetch timezone data and calculate local meeting times for multiple locations.

```php
<?php
$access_token = "YOUR_ACCESS_TOKEN"; // Replace with your actual access token
$base_url = "https://us1.locationiq.com/v1/timezone?key=" . $access_token . "&lat=%s&lon=%s&timestamp=%s";
$meeting_time_ny = new DateTime("2024-11-14 11:00:00", new DateTimeZone("America/New_York"));
$meeting_timestamp = $meeting_time_ny->getTimestamp();

$locations = [
    "New York" => [40.7128, -74.0060],
    "San Francisco" => [37.7749, -122.4194],
    "London" => [51.5074, -0.1278],
    "Cape Town" => [-33.9249, 18.4241],
    "Singapore" => [1.3521, 103.8198],
    "Tokyo" => [35.6762, 139.6503]
];

$results = [];

foreach ($locations as $city => $coords) {
    $url = sprintf($base_url, $coords[0], $coords[1], $meeting_timestamp);
    $response = file_get_contents($url);
    if ($response !== false) {
        $timezone_info = json_decode($response, true)["timezone"];
        $offset = $timezone_info["offset_sec"];
        $local_time = clone $meeting_time_ny;
        $local_time->modify(sprintf("%+d seconds", $offset + 18000)); // 18000 is NY's offset from UTC
        $results[$city] = [
            "time" => $local_time->format("g:i A"),
            "date" => $local_time->format("F j, Y"),
            "timezone" => $timezone_info["full_name"]
        ];
    } else {
        echo "Failed to retrieve timezone information for $city, " . error_get_last()['message'] . "\n";
    }
}

echo "Meeting time in New York: " . $meeting_time_ny->format("g:i A, F j, Y") . "\n";
foreach ($results as $city => $info) {
    echo "Meeting time in $city: {$info['time']}, {$info['date']} ({$info['timezone']})\n";
}
```

```python
import urllib.request
import json
from datetime import datetime
from zoneinfo import ZoneInfo

access_token = "YOUR_ACCESS_TOKEN"  # Replace with your actual access token
base_url = f"https://us1.locationiq.com/v1/timezone?key={access_token}&lat={{}}}&lon={{}}&timestamp={{}}"

# Define the meeting time in New York (EST)
meeting_time_ny = datetime(2024, 11, 14, 11, 0, tzinfo=ZoneInfo("America/New_York"))
meeting_timestamp = int(meeting_time_ny.timestamp())

# Dictionary of locations with their coordinates
locations = {
    "New York": (40.7128, -74.0060),
    "San Francisco": (37.7749, -122.4194),
    "London": (51.5074, -0.1278),
    "Cape Town": (-33.9249, 18.4241),
    "Singapore": (1.3521, 103.8198),
    "Tokyo": (35.6762, 139.6503),
    "Unknown Location": (35.6892, 51.3890)  # Coordinates for Tehran, intentionally unlabeled
}

results = {}

def get_timezone_info(city, coords):
    url = base_url.format(coords[0], coords[1], meeting_timestamp)
    try:
        with urllib.request.urlopen(url) as response:
            data = json.loads(response.read().decode())
            timezone_info = data["timezone"]
            tz = ZoneInfo(timezone_info["name"])
            local_time = meeting_time_ny.astimezone(tz)
            results[city] = {
                "time": local_time.strftime("%I:%M %p"),
                "date": local_time.strftime("%B %d, %Y"),
                "timezone": timezone_info["full_name"],
                "is_dst": "Yes" if timezone_info["now_in_dst"] == 1 else "No"
            }
    except urllib.error.URLError as e:
        print(f"Failed to retrieve timezone information for {city}: {str(e)}")

def print_results():
    print(f"Meeting time in New York: {meeting_time_ny.strftime('%I:%M %p, %B %d, %Y %Z')}")
    for city, info in results.items():
        print(f"Meeting time in {city}: {info['time']}, {info['date']}")
        print(f"  Timezone: {info['timezone']}")
        print(f"  Daylight Saving Time in effect: {info['is_dst']}")
        print()

# Fetch timezone information for all locations
for city, coords in locations.items():
    get_timezone_info(city, coords)

# Print results
print_results()
```

--------------------------------

### Directions API Response Example

Source: https://docs.locationiq.com/docs/directions-api

A sample JSON response containing route details, waypoints, and geometry data.

```json
{
  "code": "ok",
  "waypoints": {
    "distance": 159.132824,
    "location": [
      -0.161547,
      51.522462
    ],
    "name": "Balcombe Street"
  },
  "routes": {
    "legs": {
      "steps": [],
      "weight": 22.7,
      "distance": 104.2,
      "summary": "",
      "duration": 24.8
    },
    "weight_name": "routability",
    "geometry": "k~myHtp^KeA_@aEACCW",
    "weight": 22.6,
    "distance": 104.8,
    "duration": 24.8
  }
}
```

--------------------------------

### Response Example for Nearest API

Source: https://docs.locationiq.com/docs/nearest-api

A sample JSON response containing the waypoints and their associated metadata.

```json
{
    "waypoints": [{
            "nodes": [
                5393917730,
                5393917729
            ],
            "hint": "inUjk411IxMPAAAAAAAAACEAAABbAQAAlUZNQAAAAAD1D9xAA1aRQggAAAAAAAAAEAAAALAAAAAIFwEA3dX9_7zVEQNP1f3_5NgRAwIA3wB42O4j",
            "distance": 90.435751,
            "location": [
                -0.141859,
                51.500476
            ],
            "name": "Ambassador's Court"
        },
        {
            "nodes": [
                5393917731,
                5393917730
            ],
            "hint": "inUjk411IxMRAAAAAAAAABAAAABqAQAAHdpdQAAAAADMRVpAOMCXQggAAAAAAAAACAAAALgAAAAIFwEA0tX9_6DVEQNP1f3_5NgRAwEALxZ42O4j",
            "distance": 93.4557,
            "location": [
                -0.14187,
                51.500448
            ],
            "name": "Ambassador's Court"
        }
    ],
    "code": "Ok"
}
```

--------------------------------

### Optimize API JSON Response Example

Source: https://docs.locationiq.com/docs/optimize-api

Represents a successful API response containing waypoints and trip details.

```json
{
    "code": "Ok",
    "waypoints": [{
        "waypoint_index": 0,
        "trips_index": 0,
        "hint": "dRJAiW_vt4sOAAAAAAAAAAAAAAAAAAAA1kBzQQAAAAAAAAAAAAAAAA4AAAAAAAAAAAAAAAAAAAAIFwEAIhL-_zzgEQN1Df7_--ARAwAAzxB42O4j",
        "distance": 85.752389,
        "location": [-0.12643, 51.503164],
        "name": "Downing Street"
    }, {
        "waypoint_index": 1,
        "trips_index": 0,
        "hint": "BdAMgP___38BAAAAKAAAAFsAAAC7AAAAdwJqP1dc30EhbYFCWlnxQgEAAAAoAAAAWwAAALsAAAAIFwEAYKv-_zr5EQNhq_7_OvkRAwQA3wB42O4j",
        "distance": 0.069405,
        "location": [-0.0872, 51.509562],
        "name": "King William Street"
    }, {
        "waypoint_index": 2,
        "trips_index": 0,
        "hint": "kXleipl5XooAAAAAFgAAAAAAAAAAAAAAAAAAAOHmE0EAAAAAAAAAAAAAAAAWAAAAAAAAAAAAAAAIFwEAlNn-_zzwEQOa1v7_RfMRAwAAbwt42O4j",
        "distance": 101.342282,
        "location": [-0.075372, 51.50726],
        "name": ""
    }],
    "trips": [{
        "legs": [{
            "steps": [],
            "weight": 529,
            "distance": 3826.2,
            "summary": "",
            "duration": 529
        }, {
            "steps": [],
            "weight": 3505.1,
            "distance": 1274.1,
            "summary": "",
            "duration": 228.4
        }, {
            "steps": [],
            "weight": 3783.4,
            "distance": 4260.8,
            "summary": "",
            "duration": 509.1
        }],
        "weight_name": "routability",
        "geometry": "wejyHduWAsApLXh@_t@|@uD{@mDzJkThBsIqDyrAXqAeL{U{PgMaJ_MeVwHmGwBhAuUbEoQrBbFnCeMpB_AhCsRs@Ir@HiCrRqB~@aClNsC`e@cClP{C`_@N~iBfBbUpEjSdDdGtDhDnHbFpHvB{@`Kd@dF|Hq@@rA",
        "weight": 7817.5,
        "distance": 9361.1,
        "duration": 1266.5
    }]
}
```

--------------------------------

### Query Nearby POI with Key-Value Format

Source: https://docs.locationiq.com/docs/nearby-poi

Examples for fetching tourism-related records within a 50-meter radius using different programming environments.

```php
<?php

$curl = curl_init('https://us1.locationiq.com/v1/nearby?key=YOUR_ACCESS_TOKEN&lat=40.748428&lon=-73.985654&tag=tourism:*&radius=50&format=json');

curl_setopt_array($curl, array(
  CURLOPT_RETURNTRANSFER    =>  true,
  CURLOPT_FOLLOWLOCATION    =>  true,
  CURLOPT_MAXREDIRS         =>  10,
  CURLOPT_TIMEOUT           =>  30,
  CURLOPT_CUSTOMREQUEST     =>  'GET',
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```python
import requests

url = "https://us1.locationiq.com/v1/nearby"

data = {
    'key': 'YOUR_ACCESS_TOKEN',
    'lat': '40.748428',
    'lon': '-73.985654',
    'tag': 'tourism:*',
    'radius': 50,
    'format': 'json'
}

response = requests.get(url, params=data)

print(response.text)
```

```shell
curl --request GET \
  --url 'https://us1.locationiq.com/v1/nearby?key=YOUR_ACCESS_TOKEN&lat=40.748428&lon=-73.985654&tag=tourism:*&radius=50&format=json'
```

```javascript
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://us1.locationiq.com/v1/nearby?key=YOUR_ACCESS_TOKEN&lat=40.748428&lon=-73.985654&tag=tourism:*&radius=50&format=json",
  "method": "GET"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

--------------------------------

### RouteLeg object structure

Source: https://docs.locationiq.com/docs/routing-api

Example of a RouteLeg object configured with steps disabled and annotations enabled.

```json
{
  "distance": 30.0,
  "duration": 100.0,
  "weight": 100.0,
  "steps": [],
  "annotation": {
    "distance": [5,5,10,5,5],
    "duration": [15,15,40,15,15],
    "datasources": [1,0,0,0,1],
    "metadata": { "datasource_names": ["traffic","lua profile","lua profile","lua profile","traffic"] },
    "nodes": [49772551,49772552,49786799,49786800,49786801,49786802],
    "speed": [0.3, 0.3, 0.3, 0.3, 0.3]
  }
}
```

--------------------------------

### Route object structure

Source: https://docs.locationiq.com/docs/routing-api

Example of a Route object with three input coordinates, geometry set to geojson, and steps disabled.

```json
{
  "distance": 90.0,
  "duration": 300.0,
  "weight": 300.0,
  "weight_name": "duration",
  "geometry": {"type": "LineString", "coordinates": [[120.0, 10.0], [120.1, 10.0], [120.2, 10.0], [120.3, 10.0]]},
  "legs": [
    {
      "distance": 30.0,
      "duration": 100.0,
      "steps": []
    },
    {
      "distance": 60.0,
      "duration": 200.0,
      "steps": []
    }
  ]
}
```

--------------------------------

### Make a Reverse Geocoding API Call

Source: https://docs.locationiq.com/docs/reverse-geocoding

Use these examples to perform a reverse geocoding request. Replace YOUR_ACCESS_TOKEN with your valid API key.

```http
https://us1.locationiq.com/v1/reverse?key=YOUR_ACCESS_TOKEN&lat=48.8584&lon=2.2945&format=json
```

```curl
curl "https://us1.locationiq.com/v1/reverse?key=YOUR_ACCESS_TOKEN&lat=48.8584&lon=2.2945&format=json"
```

--------------------------------

### Autocomplete API JSON Response Example

Source: https://docs.locationiq.com/docs/autocomplete

A sample JSON array containing location objects returned by the Autocomplete API.

```json
[
    {
        "place_id": "0",
        "osm_id": "34633854",
        "osm_type": "way",
        "licence": "https://locationiq.com/attribution",
        "lat": "40.7484284",
        "lon": "-73.985654619873",
        "boundingbox": [
            "40.7479226",
            "40.7489422",
            "-73.9864855",
            "-73.9848259"
        ],
        "class": "tourism",
        "type": "attraction",
        "display_name": "Empire State Building, 350, 5th Avenue, New York City, New York, 10018, United States of America",
        "display_place": "Empire State Building",
        "display_address": "350, 5th Avenue, New York City, New York, 10018, United States of America",
        "address": {
            "name": "Empire State Building",
            "house_number": "350",
            "road": "5th Avenue",
            "city": "New York City",
            "state": "New York",
            "postcode": "10018",
            "country": "United States of America"
        }
    },
    {
        "place_id": "0",
        "osm_id": "34633854",
        "osm_type": "way",
        "licence": "https://locationiq.com/attribution",
        "lat": "40.7484284",
        "lon": "-73.985654619873",
        "boundingbox": [
            "40.7479226",
            "40.7489422",
            "-73.9864855",
            "-73.9848259"
        ],
        "class": "office",
        "type": "yes",
        "display_name": "Empire State Building, 350, 5th Avenue, New York City, New York, 10018, United States of America",
        "display_place": "Empire State Building",
        "display_address": "350, 5th Avenue, New York City, New York, 10018, United States of America",
        "address": {
            "name": "Empire State Building",
            "house_number": "350",
            "road": "5th Avenue",
            "city": "New York City",
            "state": "New York",
            "postcode": "10018",
            "country": "United States of America"
        }
    }
]
```

--------------------------------

### Filtered Autocomplete Requests

Source: https://docs.locationiq.com/docs/autocomplete

Examples of using query parameters to filter search results by layers, country codes, or tags.

```shell
curl --request GET \
  --url 'https://api.locationiq.com/v1/autocomplete?key=YOUR_ACCESS_TOKEN&q=United&layers=country'
```

```shell
curl --request GET \
  --url 'https://api.locationiq.com/v1/autocomplete?key=YOUR_ACCESS_TOKEN&q=Tor&countrycodes=us,ca'
```

```shell
curl --request GET \
  --url 'https://api.locationiq.com/v1/autocomplete?key=YOUR_ACCESS_TOKEN&q=Lon&layers=city&tag=!place:village'
```

--------------------------------

### Initialize Map and Handle Click Events

Source: https://docs.locationiq.com/docs/examples-leaflet

This example sets up a Leaflet map with LocationIQ tiles and attaches a click event listener to display coordinates in a popup.

```html
<!-- Replace <YOUR_API_ACCESS_TOKEN> with your LocationIQ token before using this code. -->
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Dealing with events</title>
        
        <link href="https://tiles.locationiq.com/v3/libs/leaflet/1.9.4/leaflet.css" rel="stylesheet" type="text/css"/>
        <script type="text/javascript" src="https://tiles.locationiq.com/v3/libs/leaflet/1.9.4/leaflet.js"></script>
        <script type="text/javascript" src="https://tiles.locationiq.com/v3/js/liq-styles-ctrl-leaflet.js?v=0.1.8"></script>
        
        <style type="text/css">
            body {
                margin: 0;
            }
            #map {
                width: 100vw;
                height: 100vh;
            }
        </style>
    </head>

    <body>
        <div id='map'></div>
        <script type="text/javascript">
            // Maps access token goes here
            var key = '<YOUR_API_ACCESS_TOKEN>';

            // Add layers that we need to the map
            var streets = L.tileLayer.Unwired({key: key, scheme: "streets"});

            // Initialize the map
            var map = L.map('map', {
                center: [39.73, -104.99], // Map loads with this location as center
                zoom: 14,
                scrollWheelZoom: false,
                layers: [streets]         // Show 'streets' by default
            });

            // Add the 'scale' control
            L.control.scale().addTo(map);

            // Add the 'layers' control
            L.control.layers({
                "Streets": streets
            }).addTo(map);

            // Add a 'marker'
            var marker = L.marker([39.723, -104.985], { draggable: true })
                .addTo(map)
                .bindPopup("<b>Hello world!</b><br>I am a popup.")
                .openPopup();

            // Add a 'circle'
            var circle = L.circle([39.73, -104.997], {
                color: 'red',
                fillColor: '#f03',
                fillOpacity: 0.5,
                radius: 500
            }).addTo(map).bindPopup("I am a circle.");

            // Add a 'polygon'
            var polygon = L.polygon([
                [39.726, -104.980],
                [39.734, -104.982],
                [39.739, -104.971]
            ]).addTo(map).bindPopup("I am a polygon.");

            var popup = L.popup()
                .setLatLng([39.7236, -104.985]);

            // onMapClick function to popup co-ordinates, Map click listener
            function onMapClick(e) {
                popup
                    .setLatLng(e.latlng)
                    .setContent("You clicked the map at " + e.latlng.toString())
                    .openOn(map);
            }

            map.on('click', onMapClick);
        </script>
    </body>
</html>
```

--------------------------------

### Implement Map Markers with Popups

Source: https://docs.locationiq.com/docs/examples-openlayer

This example sets up an OpenLayers map, defines custom marker styles, and initializes the DOM elements required for a popup overlay.

```html
<!doctype html>
<html lang="en">
    <head>
        <link rel="stylesheet" href="https://tiles.locationiq.com/v3/libs/openlayers/8.2.0/ol.css" type="text/css">
        <script src="https://tiles.locationiq.com/v3/libs/openlayers/8.2.0/ol.js"></script>
        <style>
            body { margin:0px; padding:0px; }
            #map { position:absolute; top:0px; bottom:0px; width:100%; }
        </style>
        <script src="https://tiles.locationiq.com/v3/libs/olms/12.0.0/olms.js" type="text/javascript"></script>
        <title>Add Popup to a marker</title>
    </head>
    <body>
        <style>
            .marker {
                display: block;
                border: none;
                cursor: pointer;
                padding: 0;
            }

            .ol-popup {
                position: absolute;
                background-color: white;
                box-shadow: 0 1px 4px rgba(0,0,0,0.2);
                padding: 15px;
                border-radius: 10px;
                border: 1px solid #cccccc;
                bottom: 12px;
                left: -50px;
                min-width: 150px;
            }
            .ol-popup:after, .ol-popup:before {
                top: 100%;
                border: solid transparent;
                content: " ";
                height: 0;
                width: 0;
                position: absolute;
                pointer-events: none;
            }
            .ol-popup:after {
                border-top-color: white;
                border-width: 10px;
                left: 48px;
                margin-left: -10px;
            }
            .ol-popup:before {
                border-top-color: #cccccc;
                border-width: 11px;
                left: 48px;
                margin-left: -11px;
            }
            .ol-popup-closer {
                text-decoration: none;
                position: absolute;
                top: 2px;
                right: 8px;
            }
            .ol-popup-closer:after {
                content: "✖";
            }
        </style>
        <div id="map"></div>
        <div id="popup" class="ol-popup">
            <a href="#" id="popup-closer" class="ol-popup-closer"></a>
            <div id="popup-content"></div>
        </div>
        <script type="text/javascript">
            var key = 'pk.aa7f5d0539c5675b7f3429402939d8fa';   //Insert your LocationIQ access token here

            var styleJson = 'https://tiles-staging.locationiq.com/v3/streets/vector.json?key=' + key;

            const map = new ol.Map({
                target: 'map',
                view: new ol.View({
                    center: ol.proj.fromLonLat([-122.42, 37.779]),
                    zoom: 12
                })
            });
  

            //to create a marker
            var marker1 = new ol.Feature({
                        geometry: new ol.geom.Point(
                        ol.proj.fromLonLat([-122.444733, 37.767443])
                    ),
                    name: 'marker1'
                });
            
            //to enhance style and add icon to the map
            marker1.setStyle(new ol.style.Style({
                image: new ol.style.Icon({ 
                    scale: 0.5,               //scale to adjust the proportion of the icon   
                    src: 'https://tiles.locationiq.com/static/images/marker.png',           //link of the icon
                })
            }));

            //to create a marker
            var marker2 = new ol.Feature({
                    geometry: new ol.geom.Point(
                    ol.proj.fromLonLat([-122.4727000, 37.786258])
                ),
                name: 'marker2'  
            });
            
            //to enhance style and add icon to the map
            marker2.setStyle(new ol.style.Style({
                image: new ol.style.Icon({ 
                    scale: 0.5,                 //scale to adjust the proportion of the icon   
                    src: 'https://tiles.locationiq.com/static/images/marker50px.png',             //link to the icon
                })
            }));

            //Let’s include the markers and create a vector source with it
            var vectorSource = new ol.source.Vector({
                features: [marker1, marker2]          
            });

            //Let’s create a vector layer, with a source created above
            var vectorLayer = new ol.layer.Vector({
                source: vectorSource,
                zIndex: 1
            });
            
            //Elements that make up the popup.
            var container = document.getElementById('popup');
            var content = document.getElementById('popup-content');
            var closer = document.getElementById('popup-closer');
```

--------------------------------

### Initialize Map and Add Lines with OpenLayers

Source: https://docs.locationiq.com/docs/examples-openlayer

Full HTML implementation including OpenLayers library imports, map initialization, marker creation from GeoJSON, and LineString geometry definition.

```html
<!doctype html>
<html lang="en">
    <head>
        <link rel="stylesheet" href="https://tiles.locationiq.com/v3/libs/openlayers/8.2.0/ol.css" type="text/css">
        <script src="https://tiles.locationiq.com/v3/libs/openlayers/8.2.0/ol.js"></script>
        <style>
            body { margin:0px; padding:0px; }
            #map { position:absolute; top:0px; bottom:0px; width:100%; }
        </style>
        <script src="https://tiles.locationiq.com/v3/libs/olms/12.0.0/olms.js" type="text/javascript"></script>
        <title>Add Lines</title>
    </head>
    <body>
        <style>
            .marker {
                display: block;
                border: none;
                border-radius: 50%;
                cursor: pointer;
                padding: 0;
            }
            
        </style>
        <div id="map"></div>
        <script type="text/javascript">
            var key = 'pk.aa7f5d0539c5675b7f3429402939d8fa';   //Insert your LocationIQ access token here

            var styleJson = 'https://tiles-staging.locationiq.com/v3/streets/vector.json?key=' + key;

            const map = new ol.Map({
                target: 'map',
                view: new ol.View({
                    center: ol.proj.fromLonLat([-122.42, 37.779]),
                    zoom: 12
                })
            });
 

            //Add markers from geojson. This list can be generated dynamically with an AJAX call as well.
            var geojson = {
                "type": "FeatureCollection",
                "features": [
                    {
                        "type": "Feature",
                        "properties": {
                            "message": "Foo",
                            "iconSize": [60, 60]
                        },
                        "geometry": {
                            "type": "Point",
                            "coordinates": [
                                -122.487377,
                                37.772487
                            ]
                        }
                    },
                    {
                        "type": "Feature",
                        "properties": {
                            "message": "Bar",
                            "iconSize": [50, 50]
                        },
                        "geometry": {
                            "type": "Point",
                            "coordinates": [
                                -122.461627,
                                37.752945
                            ]
                        }
                    },
                    {
                        "type": "Feature",
                        "properties": {
                            "message": "Baz",
                            "iconSize": [40, 40]
                        },
                        "geometry": {
                            "type": "Point",
                            "coordinates": [
                                -122.431415,
                                37.761766
                            ]
                        }
                    }
                ]
            };

            //Add markers to map
            geojson.features.forEach(function(marker) {
                // create a DOM element for the marker
                let markerEle = marker;
                var el = document.createElement('div');
                el.className = 'marker';
                el.style.backgroundImage = 'url(https://placekitten.com/g/' + marker.properties.iconSize.join('/') + '/)';
                el.style.width = marker.properties.iconSize[0] + 'px';
                el.style.height = marker.properties.iconSize[1] + 'px';

                //Instead of this click listener, we can attach a popup / infowindow to this marker (see `Add Popup to a marker` example)
                el.addEventListener('click', function() {
                    window.alert(markerEle.properties.message);
                });

                // add marker to map
                var marker = new ol.Overlay({
                        position: ol.proj.fromLonLat(marker.geometry.coordinates),
                        positioning: 'center-center',
                        element: el,
                        stopEvent: false,
                        className: 'marker'
                    });
                map.addOverlay(marker);
            });

            //Let's declare a line string
            var lineString1 = new ol.geom.LineString([
                        [-122.487377,37.772487],       //Start coordinates
                        [-122.461627,37.752945]       //End coordinates
                    ]);
```

--------------------------------

### Nearby-POI API JSON Response Example

Source: https://docs.locationiq.com/docs/quickstart-find-coffee-shops-in-new-york-city-using-nearby-poi-api

Example of the JSON response returned by the Nearby-POI API containing details about nearby cafes.

```json
[
    {
        "place_id": "420615862231",
        "osm_type": "node",
        "osm_id": "1426275725",
        "lat": "40.7566921",
        "lon": "-73.9867194",
        "class": "amenity",
        "type": "cafe",
        "tag_type": "cafe",
        "name": "Europa Cafe",
        "display_name": "Europa Cafe, 3, Times Square, New York, New York, 10036, United States",
        "address": {
            "name": "Europa Cafe",
            "house_number": "3",
            "road": "Times Square",
            "city": "New York",
            "state": "New York",
            "postcode": "10036",
            "country": "United States",
            "country_code": "US"
        },
        "boundingbox": ["40.7566921", "40.7566921", "-73.9867194", "-73.9867194"],
        "distance": 18
    },
    {
        "place_id": "421425835742",
        "osm_type": "node",
        "osm_id": "1426250385",
        "lat": "40.7566173",
        "lon": "-73.9858991",
        "class": "amenity",
        "type": "cafe",
        "tag_type": "cafe",
        "name": "Starbucks",
        "display_name": "Starbucks, Times Square, New York, New York, 10036, United States",
        "address": {
            "name": "Starbucks",
            "road": "Times Square",
            "city": "New York",
            "state": "New York",
            "postcode": "10036",
            "country": "United States",
            "country_code": "US"
        },
        "boundingbox": ["40.7566173", "40.7566173", "-73.9858991", "-73.9858991"],
        "distance": 87
    },
    // ... (other entries)
]
```
Tokens:
Raw