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

Fincaraiz Route Resolver API Documentation

GET https://scrappa.co/api/fincaraiz/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia

Scrappa's GET /api/fincaraiz/route-resolver turns a public Fincaraiz URL into the filter values it represents — this is the supported way to translate between the platform's two id vocabularies.

Pass a path such as /venta/apartamentos/medellin/antioquia. The response reports the resolved view and status, the URL parts, and the filter set behind that page: operation_type_id, property_type_id, currencyID, order, and the location tree carrying both the department name and its search UUID.

Because it returns the UUID the search endpoint wants, this removes the most common integration error on this platform — reaching for the numbered vocabulary id, which silently matches nothing.

Fincaraiz Route Resolver API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/fincaraiz/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia
Auth header
x-api-key
Cost
1 credit/request
url = /venta/apartamentos/medellin/antioquia
Response preview
200 OK
{
    "success": true,
    "route": {
        "status": 200,
        "view": "searchPage",
        "urlParts": {
            "path": "/venta/apartamentos/medellin/antioquia",
            "query": "",
            "fragment": ""
        },
        "extras": {
            "operation_type_id": 1,
            "property_type_id": [
                2
...

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.

url string Required

Public Fincaraiz path, for example /venta/apartamentos/medellin/antioquia.

Example value /venta/apartamentos/medellin/antioquia

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/fincaraiz/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia",
    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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia');

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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia', 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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia',
    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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia")
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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia", 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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia', 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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia")
        .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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia", 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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia"
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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia"));
            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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia',
            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/route-resolver?url=%2Fventa%2Fapartamentos%2Fmedellin%2Fantioquia")
        .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 route meta
JSON Response
200 OK
{
    "success": true,
    "route": {
        "status": 200,
        "view": "searchPage",
        "urlParts": {
            "path": "/venta/apartamentos/medellin/antioquia",
            "query": "",
            "fragment": ""
        },
        "extras": {
            "operation_type_id": 1,
            "property_type_id": [
                2
            ],
            "order": 2,
            "filters": []
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "route-lookup",
        "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": "route-lookup"
    },
    "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": "route-lookup"
    },
    "error": {
        "code": "parser_drift",
        "message": "Fincaraiz returned an unreadable response. Please retry."
    },
    "success": false
}
422

Validation Error

No url was supplied. Non-billable.

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

Route Not Found

That URL does not resolve to a Fincaraiz route (`not_found`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "route-lookup"
    },
    "error": {
        "code": "not_found",
        "message": "That URL does not resolve to a Fincaraiz route."
    },
    "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

Why not just use the ids from the vocabulary endpoint in search?

Because they are a different id set. Search geography uses UUIDs; the vocabulary numbers locations. The route resolver returns both in one call, which is the supported translation.

Try It Live

Test this endpoint in our interactive playground with real data.