Skip to content
Scrappa Get API key
Property Finder API 1 credit/request

Property Finder Search API Documentation

GET https://scrappa.co/api/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10

Searches Property Finder property inventory across the UAE and the GCC hosts. category_id selects the vertical (1 buy, 2 rent, 3 and 4 commercial). Filter by area ids, bedroom count, property type ids, keywords and a price range, then sort and page. Each result carries the price, area, coordinates, images, agent and brokerage, reference, listing dates and the listing flags. A query that legitimately matches nothing returns an empty list as a successful response.

Property Finder Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "properties": [
            {
                "id": "154616682",
                "category_id": 1,
                "property_type": "Villa",
                "price": {
                    "value": 7649000,
                    "currency": "AED"
                }
            }
        ],
...

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.

13 optional filters available.

category_id integer Optional

1 buy, 2 rent, 3 and 4 commercial. Defaults to 1.

Example value 1
location_ids string Optional

Comma-separated location ids from the locations endpoint, e.g. 3811.

Example value 3811
bedrooms integer Optional

Exact number of bedrooms.

Example value 10
property_type_ids string Optional

Comma-separated property type ids.

Example value example
keywords string Optional

Free-text keywords.

Example value running shoes
price_type string Optional

daily, weekly, monthly or yearly. Rent listings only.

Example value example
min_price integer Optional

Minimum price in the listing currency.

Example value 10
max_price integer Optional

Maximum price in the listing currency.

Example value 10
sort string Optional

featured, newest, priceAsc, priceDesc or bedroomAsc. Defaults to featured.

Example value relevance
page integer Optional

Page number, 1-based. Defaults to 1.

Example value 1
limit integer Optional

Results per page, 1 to 50. Defaults to 30.

Example value 10
locale string Optional

en or ar. Defaults to en.

Example value en-US
country string Optional

ae, sa, qa, bh or eg. Defaults to ae.

Example value US

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10",
    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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10');

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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10', 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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10',
    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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10")
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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10", 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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10', 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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10")
        .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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10", 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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10"
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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10"));
            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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10',
            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/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10")
        .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": {
        "properties": [
            {
                "id": "154616682",
                "category_id": 1,
                "property_type": "Villa",
                "price": {
                    "value": 7649000,
                    "currency": "AED"
                }
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 10,
            "total_count": 56,
            "has_more": true
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

INVALID_PARAMETERS

HTTP INVALID_PARAMETERS

The upstream API rejected the request parameters. Not billed.

UPSTREAM_ERROR

HTTP UPSTREAM_ERROR

Property Finder could not be reached. Not billed.

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.