Skip to content
Scrappa Get API key

Autocomplete

The Google Maps Autocomplete API provides automatic query predictions as users type. Helps users find places, addresses, and points of interest quickly. Accepts both "q" and "query" parameters for consistency with other autocomplete endpoints.

Run this endpoint

Autocomplete 1 credit/request

Endpoint

GET https://scrappa.co/api/maps/autocomplete?q=bakery
Request preview GET
https://scrappa.co/api/maps/autocomplete?q=bakery
Auth header x-api-key
Cost 1 credit/request
q = bakery
Response preview 200 OK
{
    "search_parameters": {
        "engine": "google_maps_autocomplete",
        "q": "bakery",
        "hl": "en",
        "gl": null,
        "google_domain": null
    },
    "suggestions": [
        {
            "type": "place",
            "place_id": "ChIJo5WzdY-4QIYRSL3AEsOhcYc",
            "google_id": "0x8640b88f75b395a3:0x8771a1c312c0bd48",
            "main_text": "Bakery near me",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

4 optional filters available.

q string Required

The partial search term to get autocomplete suggestions for. Accepts both "q" (consistent with Google Hotels) and "query".

Example value bakery
hl string Optional

Language code for results. Default: en. Examples: en, de, fr, es. Format: ISO 639-1 two-letter language code.

Example value en
gl string Optional

Country/region code for geo-filtering results. Examples: us, de, uk, jp. Format: ISO 3166-1 alpha-2 country code.

Example value us
ll string Optional

Latitude and longitude to bias results toward a specific location. Format: "latitude,longitude" (e.g., 40.7128,-74.0060 for New York City).

Example value example
google_domain string Optional

Google domain to use for the search. Examples: google.com, google.de, google.com.br, google.co.uk.

Example value example

Request Examples

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/maps/autocomplete?q=bakery",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

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

curl_close($curl);

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

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/maps/autocomplete?q=bakery');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/maps/autocomplete?q=bakery', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/maps/autocomplete?q=bakery',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/maps/autocomplete?q=bakery")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/maps/autocomplete?q=bakery", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/maps/autocomplete?q=bakery', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/maps/autocomplete?q=bakery")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/maps/autocomplete?q=bakery", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/maps/autocomplete?q=bakery"
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/maps/autocomplete?q=bakery"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/maps/autocomplete?q=bakery',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/maps/autocomplete?q=bakery")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

search_parameters suggestions response_time_ms

Common suggestions fields

type place_id google_id main_text
JSON Response
200 OK
{
    "search_parameters": {
        "engine": "google_maps_autocomplete",
        "q": "bakery",
        "hl": "en",
        "gl": null,
        "google_domain": null
    },
    "suggestions": [
        {
            "type": "place",
            "place_id": "ChIJo5WzdY-4QIYRSL3AEsOhcYc",
            "google_id": "0x8640b88f75b395a3:0x8771a1c312c0bd48",
            "main_text": "Bakery near me",
            "subtext": "Houston, TX",
            "main_text_highlights": [
                {
                    "offset": 0,
                    "length": 6
                }
            ],
            "latitude": 29.7604,
            "longitude": -95.3698,
            "country": "US"
        }
    ],
    "response_time_ms": 587
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

The q/query, locale, domain, or ll parameters failed validation before the Google Maps autocomplete request ran.

{
    "errors": {
        "query": [
            "The query field is required when q is not present."
        ]
    },
    "message": "The request validation failed"
}
503

Autocomplete Temporarily Unavailable

No provider/proxy path was available to complete the Google Maps autocomplete request.

{
    "error": "Service temporarily unavailable. Please retry.",
    "suggestions": [],
    "response_time_ms": 1500,
    "search_parameters": {
        "q": "bakery",
        "gl": "us",
        "hl": "en",
        "engine": "google_maps_autocomplete",
        "google_domain": "google.com"
    }
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Related reading

Try It Live

Test this endpoint in our interactive playground with real data.