Scrappa's GET /api/graana/search returns Graana property for sale and rent in Pakistan as structured JSON, with city, area, price, bedroom, bathroom, size and type filters, sort and paging.
What you get
One request returns one page of listings, Graana's own match count in total, the real page and per_page, total_pages and has_more. Each listing has id, url, title, purpose (sale or rent), type, subtype, price (amount as a number and currency PKR), area (size and unit), bedrooms, bathrooms, location, agency_id, poster_name, status, verified, total_images, cover_image, images and created_at. A missing bedroom or bathroom count is null, never 0, for example on plots. Address, coordinates and description are in the listing endpoint.
A city is required
Graana searches one city at a time. Pass purpose and city_id; take the id from /api/graana/cities. Take area ids from /api/graana/autocomplete, whose search_params can be passed as they are.
Filters are honoured
Graana applies every filter itself, so total and the paging describe the real result set. Bedroom and bathroom counts are exact, not "or more". Prices are in PKR; for rent the price is monthly. A size filter needs area_unit and matches only listings measured in that unit, because Graana keeps the unit the poster chose (marla, kanal, sqft or sqyd). Unknown parameters and unknown values return 422 instead of being ignored. applied_filters echoes what was sent.
Sorting
sort is newest (default), price_asc or price_desc. No other value is accepted.
Pagination
page is 1-based and per_page is 1 to 50 (default 25). A page past the last one returns an empty listings list with the requested page. Graana sends no count there, so total and total_pages are null. An empty first page means no match and has total 0. It never returns another page's listings.
Agency listings
Set agency_id (with city_id and purpose) to list the properties of one agency. Take the id from a listing or from the agency endpoints.
Not available
Graana publishes no fees, no agent profile, no reviews and no price history. These fields are not in the response.
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.
15 optional filters available.
string
Required
sale or rent.
sale
integer
Required
City id from the cities endpoint, for example 2 for Lahore. Graana searches one city at a time.
2
string
Optional
Area ids from the autocomplete endpoint. Comma-separated, for example 830,829.
1234567890
string
Optional
residential, plot or commercial.
example
string
Optional
house, flat, upper_portion, lower_portion, pent_house, room, basement, guest_house, residential_plot, commercial_plot, agricultural_land, farmhouse_plot, plot_file, office, shop, warehouse, factory, building, plaza, hall or land. Comma-separated.
example
string
Optional
Exact bedroom counts, for example 3 or 2,3. Comma-separated.
3
string
Optional
Exact bathroom counts, for example 2. Comma-separated.
example
number
Optional
Minimum price in PKR. For rent this is the monthly rent.
10
number
Optional
Maximum price in PKR. For rent this is the monthly rent.
10
number
Optional
Minimum size in the unit of area_unit.
10
number
Optional
Maximum size in the unit of area_unit.
10
string
Optional
marla, kanal, sqft or sqyd. Required with area_min or area_max. Only listings measured in this unit match.
example
string
Optional
Only listings of these agencies. Comma-separated agency ids.
1234567890
boolean
Optional
true for listings that carry a verified property record.
true
string
Optional
newest (default), price_asc or price_desc.
price_asc
integer
Optional
Result page, 1-based.
1
integer
Optional
Listings per page, 1 to 50. Default 25.
25
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25",
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25');
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25', 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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25',
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25")
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25", 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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25', 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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25")
.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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25", 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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25"
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25"));
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25',
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/graana/search?purpose=sale&city_id=2&bedrooms=3&sort=price_asc&per_page=25")
.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
page
per_page
total
total_pages
has_more
applied_filters
listings
+1 more
Common listings fields
id
url
title
purpose
{
"success": true,
"page": 1,
"per_page": 25,
"total": 1473,
"total_pages": 59,
"has_more": true,
"applied_filters": {
"purpose": "sale",
"city_id": 2,
"sort": "price_asc",
"bedrooms": [
3
]
},
"listings": [
{
"id": 1559223,
"url": "https://www.graana.com/property/1559223",
"title": "5 Marla House for Sale",
"purpose": "sale",
"type": "residential",
"subtype": "house",
"price": {
"amount": 29500000,
"currency": "PKR"
},
"area": {
"size": 5,
"unit": "marla"
},
"bedrooms": 5,
"bathrooms": 5,
"location": {
"area_id": 9580,
"area": "Wapda Town",
"city_id": 2,
"city": "Lahore"
},
"agency_id": 2344,
"poster_name": "M Qaisar",
"status": "published",
"verified": false,
"total_images": 3,
"cover_image": "https://images.graana.com/images/original/cc517755497c782be011d5fefbb0d8d0",
"images": [
{
"url": "https://images.graana.com/images/original/8fe6eb3dd4661ca841ecce8dadd750f4",
"type": "image"
},
{
"url": "https://images.graana.com/images/original/cc517755497c782be011d5fefbb0d8d0",
"type": "cover"
}
],
"created_at": "2026-10-24T09:32:45.278Z"
}
],
"meta": {
"endpoint_family": "search",
"billable": true,
"attempts": 1
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Filters Rejected
Graana refused the filter combination (`upstream_rejected`). Non-billable.
{
"meta": {
"attempts": 1,
"billable": false,
"retryable": false,
"endpoint_family": "search"
},
"error": {
"code": "upstream_rejected",
"message": "Graana could not accept the requested filters."
},
"success": false
}Validation Error
A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected, never ignored. Non-billable.
{
"errors": {
"purpose": [
"The selected purpose is invalid."
]
},
"message": "The selected purpose is invalid."
}Upstream Unavailable
Graana could not be reached after retries, answered with an error or changed its format (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited.
{
"meta": {
"attempts": 3,
"billable": false,
"retryable": true,
"endpoint_family": "search"
},
"error": {
"code": "upstream_unavailable",
"message": "Graana 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.