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

Fincaraiz Location Autocomplete API Documentation

GET https://scrappa.co/api/fincaraiz/location-autocomplete?term=medellin

Scrappa's GET /api/fincaraiz/location-autocomplete resolves a Colombian place name into the ids the search endpoint needs.

Pass the term, get back typed matches — city, department, zone, commune, or neighbourhood — each with a UUID id, a type, and coordinates.

Each result also carries search_filter_value, which is exactly the {id, type} pair to pass to the search endpoint as a location. Copying from there removes the most common integration mistake on this platform: sending the id without its type, or sending a numeric estate id that belongs to a different vocabulary and matches nothing.

A term that matches nothing returns an empty list, which is a valid 200.

Fincaraiz Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/fincaraiz/location-autocomplete?term=medellin
Auth header
x-api-key
Cost
1 credit/request
term = medellin
Response preview
200 OK
{
    "success": true,
    "term": "medellin",
    "returned": 2,
    "locations": [
        {
            "id": "183f0a11-0000-4000-8000-000000000000",
            "type": "CITY",
            "name": "Medellin",
            "slug": [
                "medellin"
            ],
            "estate": {
                "id": "2d63ee80-0000-4000-8000-000000000000",
...

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.

term string Required

Place name to resolve, for example medellin or bogota.

Example value medellin

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/fincaraiz/location-autocomplete?term=medellin",
    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/fincaraiz/location-autocomplete?term=medellin');

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/fincaraiz/location-autocomplete?term=medellin', 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/fincaraiz/location-autocomplete?term=medellin',
    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/fincaraiz/location-autocomplete?term=medellin")
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/fincaraiz/location-autocomplete?term=medellin", 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/fincaraiz/location-autocomplete?term=medellin', 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/fincaraiz/location-autocomplete?term=medellin")
        .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/fincaraiz/location-autocomplete?term=medellin", 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/fincaraiz/location-autocomplete?term=medellin"
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/fincaraiz/location-autocomplete?term=medellin"));
            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/fincaraiz/location-autocomplete?term=medellin',
            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/fincaraiz/location-autocomplete?term=medellin")
        .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 term returned locations meta

Common locations fields

id type name slug
JSON Response
200 OK
{
    "success": true,
    "term": "medellin",
    "returned": 2,
    "locations": [
        {
            "id": "183f0a11-0000-4000-8000-000000000000",
            "type": "CITY",
            "name": "Medellin",
            "slug": [
                "medellin"
            ],
            "estate": {
                "id": "2d63ee80-0000-4000-8000-000000000000",
                "name": "Antioquia"
            },
            "coordinates": [
                -75.5762,
                6.2442
            ],
            "search_filter_value": {
                "id": "183f0a11-0000-4000-8000-000000000000",
                "type": "CITY"
            }
        }
    ],
    "meta": {
        "billable": true,
        "endpoint_family": "location-autocomplete",
        "attempts": 1
    }
}

Errors

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

503

Upstream Unavailable

The upstream request failed after retries, or returned a response this endpoint cannot read (`upstream_unavailable`, `parser_drift`). Retryable and never billed.

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

Unreadable Response

The platform answered successfully with a body this endpoint cannot read, so nothing is published and nothing is charged (`parser_drift`). Retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "location-autocomplete"
    },
    "error": {
        "code": "parser_drift",
        "message": "Fincaraiz returned an unreadable response. Please retry."
    },
    "success": false
}
422

Validation Error

The term is missing or too long. Non-billable.

{
    "errors": {
        "term": [
            "The term field is required."
        ]
    },
    "message": "The term field is required."
}

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 Endpoints

Fincaraiz API FAQ

Why do I need both an id and a type for a location?

The search endpoint requires each location to carry both. An id alone is rejected. Every autocomplete result includes a search_filter_value field containing the ready-made pair.

Can I use the estate ids from the vocabulary endpoint in search?

No. The two id sets are unrelated: search geography uses UUIDs, the vocabulary uses small integers. Feeding an estate number into search returns zero results.

Try It Live

Test this endpoint in our interactive playground with real data.