Skip to content
Scrappa Get API key
Portal Inmobiliario API 1 credit/request

Portal Inmobiliario Search API Documentation

GET https://scrappa.co/api/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2

Search current Portal Inmobiliario listings for sale (venta) or rent (arriendo) in a comuna or region. Filter by property type, bedrooms, bathrooms, price in CLP or UF, area, parking, publisher and condition, then sort and page. The page size is fixed at 48 and the portal serves at most 42 pages (2000 results). Prices come in the listing currency (CLP or UF) with the CLP value added. Project cards show ranges, so a bedroom filter matches a project when one of its units fits. A search without results is a successful empty response.

Portal Inmobiliario Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2
Auth header
x-api-key
Cost
1 credit/request
operation = arriendo location = providencia-metropolitana
Response preview
200 OK
{
    "success": true,
    "data": {
        "listings": [
            {
                "id": "MLC4623230902",
                "url": "https://www.portalinmobiliario.com/MLC-4623230902-departamento-remodelado-metro-tobalaba-_JM",
                "title": "Departamento Remodelado / Metro Tobalaba",
                "headline": "Departamento en arriendo",
                "is_project": false,
                "price": {
                    "amount": 780000,
                    "currency": "CLP",
                    "amount_clp": 780000,
...

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.

14 optional filters available.

operation string Required

venta (sale) or arriendo (rent).

Example value arriendo
location string Required

Location slug from the locations endpoint, e.g. providencia-metropolitana. An unknown slug returns a non-billable 404.

Example value providencia-metropolitana
property_type string Optional

departamento, casa, oficina, terreno, sitio, parcela, bodega, estacionamiento, industrial, agricola or otros. Defaults to departamento.

Example value departamento
bedrooms integer Optional

0 (studio), 1, 2, 3 or 4. 4 means 4 or more.

Example value 2
bathrooms integer Optional

1, 2 or 3. 3 means 3 or more.

Example value 10
price_min integer Optional

Minimum price, inclusive, in the currency parameter. Whole numbers.

Example value 10
price_max integer Optional

Maximum price, inclusive, in the currency parameter. Whole numbers.

Example value 10
currency string Optional

CLP or UF. Applies to price_min and price_max. Listings priced in the other currency are converted. Defaults to CLP.

Example value USD
area_min integer Optional

Minimum area in square metres, whole numbers.

Example value 10
area_max integer Optional

Maximum area in square metres, whole numbers.

Example value 10
area_type string Optional

total or covered. Applies to the area filters. Defaults to total.

Example value example
parking integer Optional

0 (no parking), 1 (one space) or 2 (two or more).

Example value 10
publisher string Optional

particular (private owner) or profesional (agency).

Example value example
condition string Optional

usadas (used properties) or proyectos (new projects).

Example value example
sort string Optional

relevance, price_asc, price_desc, newest or oldest. Defaults to relevance.

Example value relevance
page integer Optional

Page number from 1 to 42. The page size is fixed at 48. Defaults to 1.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2",
    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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2');

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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2', 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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2',
    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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2")
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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2", 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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2', 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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2")
        .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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2", 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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2"
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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2"));
            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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2',
            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/portal-inmobiliario/search?operation=arriendo&location=providencia-metropolitana&property_type=departamento&bedrooms=2")
        .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 data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "listings": [
            {
                "id": "MLC4623230902",
                "url": "https://www.portalinmobiliario.com/MLC-4623230902-departamento-remodelado-metro-tobalaba-_JM",
                "title": "Departamento Remodelado / Metro Tobalaba",
                "headline": "Departamento en arriendo",
                "is_project": false,
                "price": {
                    "amount": 780000,
                    "currency": "CLP",
                    "amount_clp": 780000,
                    "is_from": false,
                    "previous_amount": null,
                    "is_price_drop": false
                },
                "bedrooms": 2,
                "bathrooms": 2,
                "area_m2": 80,
                "area_type": "covered",
                "location_text": "Av. Providencia 2457, Providencia, Metro Tobalaba - Mall Costanera, Providencia",
                "images": [
                    "https://http2.mlstatic.com/D_NQ_NP_902199-MLC118508683130_102026-O-departamento-remodelado-metro-tobalaba.webp"
                ],
                "category_id": "MLC183186"
            }
        ],
        "currency_conversions": {
            "uf_clp": 41215.78,
            "usd_clp": 986.58
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true,
        "pagination": {
            "page": 1,
            "per_page": 48,
            "total": 264,
            "page_count": 6,
            "results_limit": 2000,
            "has_more": true,
            "next_page": 2
        }
    }
}

Errors

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

422

Validation Error

A public parameter or range is invalid. This response is not billable.

{
    "errors": {
        "page": [
            "The portal serves at most 42 pages (2000 results) per search."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The listing id or the location slug is unknown. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Portal Inmobiliario resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

Portal Inmobiliario blocked every route, did not answer or returned a page the API could not read. Retry shortly. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Portal Inmobiliario 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.