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

Fincaraiz Location Geometry API Documentation

GET https://scrappa.co/api/fincaraiz/location-geometry?ids=183f0a11-0000-4000-8000-000000000000

Scrappa's GET /api/fincaraiz/location-geometry returns the polygon boundaries for one or more Colombian locations, ready to draw a region on a map.

Pass the ids you already have from location-autocomplete; several can be requested in one call by comma-separating them. Each result carries multi_polygon plus the location id, name, and type.

The list is bounded: at most 200 characters of comma-separated alphanumeric ids, and anything else is rejected with a 422 before the lookup rather than sent upstream.

Boundary payloads are large — a city outline is roughly a megabyte — so request only the regions you will actually draw. Ids that do not resolve are omitted from the response rather than failing the whole call.

Fincaraiz Location Geometry API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/fincaraiz/location-geometry?ids=183f0a11-0000-4000-8000-000000000000
Auth header
x-api-key
Cost
1 credit/request
ids = 183f0a11-0000-4000-8000-000000000000
Response preview
200 OK
{
    "success": true,
    "requested_ids": [
        "183f0a11-0000-4000-8000-000000000000"
    ],
    "returned": 1,
    "geometries": [
        {
            "id": "183f0a11-0000-4000-8000-000000000000",
            "name": "Medellin",
            "type": "CITY",
            "multi_polygon": {
                "coordinates": [
                    [
...

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.

ids string Required

One or more location UUIDs from location-autocomplete, comma-separated.

Example value 183f0a11-0000-4000-8000-000000000000

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/fincaraiz/location-geometry?ids=183f0a11-0000-4000-8000-000000000000",
    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-geometry?ids=183f0a11-0000-4000-8000-000000000000');

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-geometry?ids=183f0a11-0000-4000-8000-000000000000', 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-geometry?ids=183f0a11-0000-4000-8000-000000000000',
    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-geometry?ids=183f0a11-0000-4000-8000-000000000000")
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-geometry?ids=183f0a11-0000-4000-8000-000000000000", 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-geometry?ids=183f0a11-0000-4000-8000-000000000000', 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-geometry?ids=183f0a11-0000-4000-8000-000000000000")
        .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-geometry?ids=183f0a11-0000-4000-8000-000000000000", 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-geometry?ids=183f0a11-0000-4000-8000-000000000000"
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-geometry?ids=183f0a11-0000-4000-8000-000000000000"));
            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-geometry?ids=183f0a11-0000-4000-8000-000000000000',
            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-geometry?ids=183f0a11-0000-4000-8000-000000000000")
        .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 requested_ids returned geometries meta

Common geometries fields

id name type multi_polygon
JSON Response
200 OK
{
    "success": true,
    "requested_ids": [
        "183f0a11-0000-4000-8000-000000000000"
    ],
    "returned": 1,
    "geometries": [
        {
            "id": "183f0a11-0000-4000-8000-000000000000",
            "name": "Medellin",
            "type": "CITY",
            "multi_polygon": {
                "coordinates": [
                    [
                        [
                            -75.7,
                            6.1
                        ],
                        [
                            -75.6,
                            6.2
                        ]
                    ]
                ]
            }
        }
    ],
    "meta": {
        "billable": true,
        "endpoint_family": "location-geometry",
        "attempts": 1
    }
}

Errors

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

422

Validation Error

No ids were supplied. Non-billable.

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

Upstream Unavailable

The upstream request failed after retries. Retryable and never billed.

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

Unreadable Response

Fincaraiz answered 200 with something other than a list of boundaries (`parser_drift`). Nothing is charged for it. Retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "location-geometry"
    },
    "error": {
        "code": "parser_drift",
        "message": "Fincaraiz returned an unreadable response. 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.

Related Endpoints

Fincaraiz API FAQ

Where do the ids come from?

From location-autocomplete. Each result there carries an id that is valid for this endpoint.

Why is the response so large?

Boundary polygons describe every contour of the region. A single city outline is around a megabyte, so request only the regions you render.

Try It Live

Test this endpoint in our interactive playground with real data.