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

Aqarmap Listing API Documentation

GET https://scrappa.co/api/aqarmap/listing?id=7360411

Scrappa's GET /api/aqarmap/listing returns the full public record of one Aqarmap listing by its numeric id from search.

What you get

Everything search returns, plus price_per_meter, the map pin in latitude and longitude, video_url, brochure, meta_title, meta_description, listing status, the compound, all amenities the property type supports in available_amenities, mortgage and registration data, the full payment_plans, the custom attributes, all translations and a seller block with active listing count, type and score.

Privacy

Phone and WhatsApp numbers are masked by Aqarmap and are never returned. An unknown or removed id returns a non-billable 404.

Aqarmap Listing API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/aqarmap/listing?id=7360411
Auth header
x-api-key
Cost
1 credit/request
id = 7360411
Response preview
200 OK
{
    "success": true,
    "data": {
        "listing": {
            "id": "7360411",
            "slug": "for-rent-cairo-helwan",
            "url": "https://aqarmap.com.eg/en/listing/7360411/",
            "reference_id": 7360411,
            "title": "Apartment for rent in front of the Japanese Garden, 125 m",
            "description": "Apartment for rent facing the Japanese Garden, 3 bedrooms, 2 bathrooms.",
            "section": {
                "id": 2,
                "key": "rent",
                "title": "For rent"
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

id string Required

Numeric listing id from search, for example 7360411.

Example value 7360411
lang string Optional

en (default) or ar.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/aqarmap/listing?id=7360411",
    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/aqarmap/listing?id=7360411');

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/aqarmap/listing?id=7360411', 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/aqarmap/listing?id=7360411',
    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/aqarmap/listing?id=7360411")
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/aqarmap/listing?id=7360411", 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/aqarmap/listing?id=7360411', 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/aqarmap/listing?id=7360411")
        .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/aqarmap/listing?id=7360411", 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/aqarmap/listing?id=7360411"
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/aqarmap/listing?id=7360411"));
            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/aqarmap/listing?id=7360411',
            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/aqarmap/listing?id=7360411")
        .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": {
        "listing": {
            "id": "7360411",
            "slug": "for-rent-cairo-helwan",
            "url": "https://aqarmap.com.eg/en/listing/7360411/",
            "reference_id": 7360411,
            "title": "Apartment for rent in front of the Japanese Garden, 125 m",
            "description": "Apartment for rent facing the Japanese Garden, 3 bedrooms, 2 bathrooms.",
            "section": {
                "id": 2,
                "key": "rent",
                "title": "For rent"
            },
            "property_type": {
                "id": 1,
                "name": "Apartment",
                "plural_name": "Apartments",
                "slug": "apartment"
            },
            "price": {
                "amount": 10000,
                "currency": "EGP"
            },
            "area": {
                "value": 125,
                "unit": "sqm"
            },
            "address": "Helwan",
            "location": {
                "id": 67,
                "name": "Helwan",
                "slug": "cairo/helwan",
                "full_path": "Greater Cairo / Helwan",
                "type": null,
                "parent": {
                    "id": 1,
                    "name": "Greater Cairo",
                    "slug": "cairo",
                    "full_path": "Greater Cairo",
                    "type": null,
                    "parent": null
                }
            },
            "rooms": 3,
            "baths": 2,
            "floor": 1,
            "year_built": 2020,
            "finish_type": "SUPER_LUX",
            "finish_type_label": "Super lux",
            "amenities": [
                "ELEVATOR",
                "SECURITY"
            ],
            "payment_method": {
                "id": 1,
                "key": "from_owner_cash",
                "label": "From owner cash"
            },
            "payment_plans": [
                {
                    "price": 10000,
                    "down_payment": null,
                    "down_payment_percentage": null,
                    "total_down_payment": 0,
                    "total_remaining_amount": 10000,
                    "over_price": null,
                    "security_deposit": null,
                    "duration": 30
                }
            ],
            "property_view": {
                "id": 1
            },
            "is_price_negotiable": false,
            "is_resale": false,
            "is_primary": false,
            "is_mortgage": false,
            "is_featured": false,
            "main_photo": {
                "id": 47478477,
                "caption": null,
                "order": 1,
                "thumb_url": "https://img-1.aqarmap.com.eg/new-aqarmap-media/search-thumb-webp/2610/6adba8e739dc7555414291.jpg",
                "small_url": "https://img-1.aqarmap.com.eg/new-aqarmap-media/small/2610/6adba8e739dc7555414291.jpg",
                "large_url": "https://img-1.aqarmap.com.eg/new-aqarmap-media/large/2610/6adba8e739dc7555414291.jpg"
            },
            "photos": [],
            "photo_count": 5,
            "published_at": "2026-10-26T01:42:07+03:00",
            "updated_at": "2026-10-26T01:42:07+03:00",
            "latitude": 29.821,
            "longitude": 31.317,
            "featured_type": "not_featured",
            "registration_status": null,
            "mortgage_options": [],
            "seller": {
                "id": 4746422,
                "name": "Al Hoda Real Estate",
                "type": 1,
                "role": 1,
                "active_listings": 4684,
                "score": 4.42,
                "logo": null,
                "personal_photo": null,
                "has_valid_logo": false,
                "has_valid_personal_photo": false
            },
            "price_per_meter": 80,
            "status": {
                "id": 2,
                "key": "live",
                "label": "Live"
            },
            "video_url": null,
            "brochure": null,
            "meta_title": null,
            "meta_description": null,
            "available_amenities": [
                "ELEVATOR",
                "SECURITY",
                "BALCONY"
            ],
            "compound": null,
            "was_featured": false,
            "is_on_hold": false,
            "is_mortgage_approved": null,
            "attributes": [
                {
                    "name": "rooms",
                    "label": "Rooms",
                    "value": "3"
                },
                {
                    "name": "baths",
                    "label": "Baths",
                    "value": "2"
                }
            ],
            "translations": [
                {
                    "locale": "en",
                    "title": "Apartment for rent in Helwan",
                    "description": "Bright apartment.",
                    "address": "Helwan"
                }
            ],
            "parent_listing_id": null
        }
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true,
        "duration_ms": 520
    }
}

Errors

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

404

Not Found

Nothing exists with that identifier on Aqarmap (`NOT_FOUND`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Aqarmap resource was not found."
    },
    "success": false
}
422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "section": [
            "The selected section is invalid."
        ]
    },
    "message": "The selected section is invalid."
}
503

Upstream Unavailable

Aqarmap could not be reached after retries, refused the request or answered with a body this API cannot read safely (`UPSTREAM_UNAVAILABLE`). Never billed. Retry when `meta.retryable` is true.

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