Scrappa's GET /api/fincaraiz/project returns one developer new-build project, addressed either by numeric id or by the public ref reference code taken from the project's own URL.
The record carries construction status (percentage_sold, percentage_finished), the target completion date, the builder and architect, the public link, and the image gallery.
Because the reference code can resolve to either a project or an individual listing, pass type=property when you expect a listing. An id or ref that does not resolve returns a non-billable 404.
This endpoint returns exactly one record, so page and per_page belong to /api/fincaraiz/projects. Passing either here is a non-billable 422 rather than a record that quietly ignores the pagination you asked for.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
3 optional filters available.
string
Optional
Numeric project id. Either id or ref is required.
2621770
string
Optional
Public project reference code from the project URL. Either id or ref is required.
example
string
Optional
project (default) or property, when resolving by ref.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/fincaraiz/project?id=2621770",
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/fincaraiz/project?id=2621770');
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/fincaraiz/project?id=2621770', 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/fincaraiz/project?id=2621770',
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/fincaraiz/project?id=2621770")
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/fincaraiz/project?id=2621770", 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/fincaraiz/project?id=2621770', 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/fincaraiz/project?id=2621770")
.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/fincaraiz/project?id=2621770", 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/fincaraiz/project?id=2621770"
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/project?id=2621770"));
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/fincaraiz/project?id=2621770',
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/fincaraiz/project?id=2621770")
.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
project
meta
{
"success": true,
"project": {
"id": "2621770",
"title": "OIKOS SAVANNA, Casas en Venta en Cajica",
"link": "proyectos/oikos-savanna-casas-en-venta-en-cajica/2621770",
"percentage_sold": 40,
"percentage_finished": 100,
"builder": "Oikos",
"images": [
"https://cdn4.fincaraiz.com.co/repo/img/example.jpg"
]
},
"meta": {
"billable": true,
"endpoint_family": "project",
"attempts": 1
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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": "project"
},
"error": {
"code": "upstream_unavailable",
"message": "Fincaraiz is temporarily unavailable. Please retry."
},
"success": false
}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": "project"
},
"error": {
"code": "parser_drift",
"message": "Fincaraiz returned an unreadable response. Please retry."
},
"success": false
}Validation Error
Neither id nor ref was supplied. Non-billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "project"
},
"error": {
"code": "unknown_filter",
"message": "id or ref is required."
},
"success": false
}Unsupported Filter
An index filter such as page or per_page was supplied to this single-record endpoint (`unknown_filter`). Non-billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "project"
},
"error": {
"code": "unknown_filter",
"message": "page is not a filter this endpoint can apply, so it is rejected rather than ignored. This endpoint accepts: id, ref, type."
},
"success": false
}Project Not Found
No project exists for that id or reference code (`not_found`). Non-billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "project"
},
"error": {
"code": "not_found",
"message": "No Fincaraiz project exists for that id or reference code."
},
"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 might a reference code return a listing instead of a project?
The reference code identifies a page, and a page can be a project or an individual listing. Pass type=property when you expect a listing.
Try It Live
Test this endpoint in our interactive playground with real data.