Scrappa's GET /api/goplaceit/search returns property and new-development projects for sale or rent in Chile, Mexico and Colombia as structured JSON. Set country (cl, mx, co) and mode (buy, rent).
What you get
Each row has id, entity_type (property or project), title, price, price_from, currency, mode, type, country, commune, rooms, baths, area_m2, image and the public url. Projects carry ranges (bedrooms_min, bedrooms_max, area_m2_min) and price_from instead of single values. A price of 0 is shown as null. Search rows have no coordinates: read latitude and longitude from listing.
Filters are honoured
Goplaceit ignores a sort, type or filter it does not know, so unknown values are rejected with 422. Bedrooms, bathrooms, area, type, mode, country, commune and entity type are checked again on every row. A row that breaks one is never returned and is counted in filtered_out_count. applied_filters echoes what was used.
Currencies and price
Use currency with price_min or price_max: CLP or UF for cl, MXN or USD for mx, COP for co. Goplaceit converts currencies, so a UF filter also returns CLP rows of equal value. Every row has its own currency. Price sorts (price_asc, price_max) order the raw number across currencies, so they are not a single-currency order.
Locations
Take region and commune ids from /api/goplaceit/location-autocomplete or /api/goplaceit/locations. Province is not offered because Goplaceit does not apply it.
Pagination
page is 1-based and per_page is 1-50 (default 20). pagination is computed by Scrappa. A page past the last one returns an empty listings list with the correct totals, never another page's data.
Run this endpoint
Endpoint
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.
17 optional filters available.
string
Required
cl, mx or co.
cl
string
Required
buy for sale listings or rent for rentals.
rent
string
Optional
house, apartment, office, land, parking or storage.
apartment
string
Optional
property for single listings, project for new developments. Default: both.
example
integer
Optional
Region id from locations or location-autocomplete.
13
integer
Optional
Commune id from locations or location-autocomplete.
10
integer
Optional
Neighborhood id from locations (parent: commune).
10
integer
Optional
Minimum bedrooms.
3
integer
Optional
Maximum bedrooms.
10
integer
Optional
Minimum bathrooms.
10
integer
Optional
Maximum bathrooms.
10
number
Optional
Minimum built area in square metres.
10
number
Optional
Maximum built area in square metres.
10
number
Optional
Minimum price in the given currency. Needs currency.
10
number
Optional
Maximum price in the given currency. Needs currency.
10
string
Optional
CLP or UF (cl), MXN or USD (mx), COP (co). Only with a price filter.
USD
string
Optional
featured (default), newest, oldest, price_asc or price_max.
relevance
integer
Optional
Result page, 1-based.
1
integer
Optional
Listings per page, 1-50 (default 20).
20
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20",
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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20');
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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20', 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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20',
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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20")
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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20", 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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20', 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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20")
.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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20", 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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20"
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/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20"));
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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20',
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/goplaceit/search?country=cl&mode=rent&property_type=apartment®ion=13&bedrooms_min=3&per_page=20")
.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
total_results
returned
filtered_out_count
pagination
applied_filters
listings
meta
Common listings fields
id
entity_type
title
price
{
"success": true,
"total_results": 6367,
"returned": 1,
"filtered_out_count": 0,
"pagination": {
"page": 1,
"per_page": 20,
"total_pages": 319,
"has_next_page": true
},
"applied_filters": {
"country": "cl",
"mode": "rent",
"property_type": "apartment",
"region": 13,
"bedrooms_min": 3,
"sort": "featured"
},
"listings": [
{
"id": 13248055,
"entity_type": "property",
"title": "Departamento en Arriendo en Estoril",
"price": 90,
"price_from": null,
"currency": {
"id": 2,
"code": "UF",
"symbol": "UF",
"name": "Unidad de Fomento",
"iso_code": "CLF"
},
"mode": "rent",
"type": "apartment",
"type_label": "Departamento",
"country": "cl",
"commune": {
"id": 288,
"name": "Las Condes"
},
"bedrooms": 4,
"bedrooms_min": null,
"bedrooms_max": null,
"bathrooms": 3,
"bathrooms_min": null,
"bathrooms_max": null,
"area_m2": 160,
"area_m2_min": null,
"area_m2_max": null,
"image": "https://example.com/photo-220x220.jpg",
"url": "https://www.goplaceit.com/cl/propiedad/arriendo/departamento/las-condes/13248055-departamento-en-arriendo-en-estoril"
}
],
"meta": {
"endpoint_family": "search",
"billable": true,
"attempts": 1
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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."
}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": "search"
},
"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.