Skip to content
Scrappa Get API key
MagicBricks API 1 credit/request

MagicBricks Property Search API Documentation

GET https://scrappa.co/api/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&limit=10

Search property listings in one Indian city by category (buy or rent), property type, locality, keyword and page. Each item carries the listing card fields, so no separate detail call is needed: price in rupees, carpet and covered area in square feet, bedrooms, bathrooms, floor, furnishing, possession, property type, owner type, locality, city and the image gallery. Up to 150 items per page. A valid query with zero results is a successful response; an unknown property type is a 422 validation error and an unknown listing is a 404.

MagicBricks Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&limit=10
Auth header
x-api-key
Cost
1 credit/request
city = Mumbai property_type = flat
Response preview
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "id": 84564631,
                "title": "Parleshwar Aangan by Panom Developers is a premium residential project spread across approx 2.5 acres in Vile Parle East",
                "url": "https://www.magicbricks.com/propertyDetails/2-BHK-700-Sq-ft-Multistorey-Apartment-FOR-Sale-Vile-Parle-East-in-Mumbai&id=4d423834353634363331",
                "price": 28411600,
                "currency": "INR",
                "price_display": "2.84 Cr",
                "carpet_area": 680,
                "covered_area": 700,
                "area_unit": "sqft",
...

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.

5 optional filters available.

city string Required

City ref-no such as 4320 for Mumbai, or a city name resolved against /cities. Example: Mumbai.

Example value Mumbai
property_type string Required

Required. Property type name such as flat, house, villa, plot, builder floor or studio, or the upstream numeric code, for example 10002. Upstream rejects a search without it.

Example value flat
category string Optional

buy for sale listings or rent for rental listings. Defaults to buy.

Example value buy
locality integer Optional

Locality ref-no from /localities or /autocomplete, for example 60017 for Andheri East.

Example value 10
keyword string Optional

Free-text keyword passed to the upstream search, for example Andheri.

Example value running shoes
page integer Optional

One-based page number. Defaults to 1.

Example value 1
limit integer Optional

Listings per page, 1 to 150. Defaults to 30.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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/magicbricks/v1/search?city=Mumbai&category=buy&property_type=flat&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": {
        "items": [
            {
                "id": 84564631,
                "title": "Parleshwar Aangan by Panom Developers is a premium residential project spread across approx 2.5 acres in Vile Parle East",
                "url": "https://www.magicbricks.com/propertyDetails/2-BHK-700-Sq-ft-Multistorey-Apartment-FOR-Sale-Vile-Parle-East-in-Mumbai&id=4d423834353634363331",
                "price": 28411600,
                "currency": "INR",
                "price_display": "2.84 Cr",
                "carpet_area": 680,
                "covered_area": 700,
                "area_unit": "sqft",
                "bedrooms": 2,
                "bathrooms": 2,
                "floor": "7 of 11 Floor",
                "furnishing": "Unfurnished",
                "possession": "Ready to Move",
                "property_type": "Multistorey Apartment",
                "owner_type": "Builder",
                "locality": "Vile Parle East",
                "city": "Mumbai",
                "images": [
                    "https://img.staticmb.com/mbphoto/property/cropped_images/ver2/XIwvQlc61t8ZIpanz4mAnTVN99s9dcu1ES0F3mY9EQVU88F8V9DF/Photo_h470_w1080/84564631_13_ivingroom_470_1080.jpeg"
                ]
            }
        ],
        "page": 1,
        "limit": 10,
        "total": 60167,
        "has_more": true
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

422

Validation Error

A public parameter is missing or invalid, or a city, locality or property type cannot be resolved. No upstream call is made and the response is not billable.

{
    "errors": {
        "city": [
            "The city field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

The requested MagicBricks resource does not exist. The response is not billable.

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

Unexpected Upstream Response

MagicBricks answered with a body that is not the documented shape. The response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "magicbricks_search"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "MagicBricks returned an unexpected response."
    },
    "success": false
}
503

Upstream Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "magicbricks_search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The MagicBricks API 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.