Skip to content
Scrappa Get API key
Goplaceit API 1 credit/request

Goplaceit Location Autocomplete API Documentation

GET https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl

Scrappa's GET /api/goplaceit/location-autocomplete finds regions and communes by name. Send q (at least 2 characters) and country.

What you get

Each match has id, name, level (region or commune), the region it belongs to, latitude, longitude and search_param, the name of the search parameter to send the id in. Matching ignores accents and case. Names that start with the text come first.

Built from cached lists

Goplaceit has no text suggest service, so Scrappa matches over its region and commune lists. The first request for a country after 24 hours builds that index from the lists, which can take several seconds. Later requests are served from the cache and cost no source lookup (meta.cached). Neighborhoods are not part of the index: use locations with commune.

Mexico

Mexican regions hold thousands of communes (about 25 MB in total), so for country=mx the index holds the regions only and meta.communes_included is false. Send region (an id from a first search) to match the communes of that one region. That region list is loaded once and cached for 24 hours. For Chile and Colombia the index holds every commune and region only narrows the matches.

Goplaceit Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl
Auth header
x-api-key
Cost
1 credit/request
q = providencia country = cl
Response preview
200 OK
{
    "success": true,
    "query": "providencia",
    "country": "cl",
    "total_results": 1,
    "returned": 1,
    "locations": [
        {
            "id": 297,
            "name": "Providencia",
            "level": "commune",
            "region": {
                "id": 13,
                "name": "Region Metropolitana"
...

Parameters

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

Runnable path

2 required parameters needed before sending a request.

2 optional filters available.

q string Required

Start or part of a place name, at least 2 characters.

Example value providencia
country string Required

cl, mx or co.

Example value cl
region integer Optional

Region id. Limits matches to that region. Needed to find communes in Mexico.

Example value US
limit integer Optional

Matches to return, 1-20 (default 20).

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl",
    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
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl');

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

fetch('https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl")
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
Python
import http.client
import json

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

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

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

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

try:
    response = requests.get('https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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/goplaceit/location-autocomplete?q=providencia&country=cl")
        .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());
        }
    }
}
Go
package main

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

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/goplaceit/location-autocomplete?q=providencia&country=cl"
C#
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/goplaceit/location-autocomplete?q=providencia&country=cl"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

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

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

void run();
RUST
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/goplaceit/location-autocomplete?q=providencia&country=cl")
        .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.

success query country total_results returned locations meta

Common locations fields

id name level region
JSON Response
200 OK
{
    "success": true,
    "query": "providencia",
    "country": "cl",
    "total_results": 1,
    "returned": 1,
    "locations": [
        {
            "id": 297,
            "name": "Providencia",
            "level": "commune",
            "region": {
                "id": 13,
                "name": "Region Metropolitana"
            },
            "latitude": -33.4314,
            "longitude": -70.6093,
            "search_param": "commune"
        }
    ],
    "meta": {
        "endpoint_family": "location-autocomplete",
        "billable": true,
        "cached": true,
        "attempts": 0,
        "communes_included": true
    }
}

Errors

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

422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters and unknown sort or type values are rejected, never ignored. Non-billable.

{
    "errors": {
        "sort": [
            "The selected sort is invalid."
        ]
    },
    "message": "The selected sort is invalid."
}
503

Source Unavailable

Goplaceit could not be reached in time, refused the request, or its answer changed shape (`upstream_unavailable`, `request_blocked`, `deadline_exhausted`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 2,
        "billable": false,
        "retryable": true,
        "endpoint_family": "location-autocomplete"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Goplaceit is temporarily unavailable. Please retry."
    },
    "success": false
}

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.

Try It Live

Test this endpoint in our interactive playground with real data.