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

LankaPropertyWeb Agent Profile API Documentation

GET https://scrappa.co/api/lankapropertyweb/agent?slug=prince-estates-5864978

Scrappa's GET /api/lankapropertyweb/agent returns the public profile of one LankaPropertyWeb agent or agency and a page of its current listings.

What you get

slug, id, name, url, verified, logo, areas_covered, services and listings. Each listing has id, type, url, title, price, price_label, price_period, currency, location, image and a short description. Use id and type with the listing endpoint for the full record.

Pagination

page selects the listing page, 30 listings per page. pagination has page, total_pages, returned and has_more. A page past the last one returns an empty list with the real page.

Privacy

Phone numbers are never returned.

Notes

Take slug from /api/lankapropertyweb/agents or from agent.agency.slug of a listing. An unknown slug returns 404, which is never billed.

LankaPropertyWeb Agent Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/lankapropertyweb/agent?slug=prince-estates-5864978
Auth header
x-api-key
Cost
1 credit/request
slug = prince-estates-5864978
Response preview
200 OK
{
    "success": true,
    "data": {
        "slug": "prince-estates-5864978",
        "id": 5864978,
        "name": "Prince Estates",
        "url": "https://www.lankapropertyweb.com/agents/prince-estates-5864978",
        "verified": true,
        "logo": "https://www.lankapropertyweb.com/images/pics/profiles/251881_1765289294_6177.png",
        "areas_covered": "Colombo",
        "services": [
            "Residential sales",
            "Rentals",
            "Commercial property",
...

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.

slug string Required

Agent slug from the agents list or a listing, for example prince-estates-5864978.

Example value prince-estates-5864978
page integer Optional

Listing page, 30 listings per page.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/lankapropertyweb/agent?slug=prince-estates-5864978",
    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/lankapropertyweb/agent?slug=prince-estates-5864978');

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/lankapropertyweb/agent?slug=prince-estates-5864978', 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/lankapropertyweb/agent?slug=prince-estates-5864978',
    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/lankapropertyweb/agent?slug=prince-estates-5864978")
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/lankapropertyweb/agent?slug=prince-estates-5864978", 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/lankapropertyweb/agent?slug=prince-estates-5864978', 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/lankapropertyweb/agent?slug=prince-estates-5864978")
        .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/lankapropertyweb/agent?slug=prince-estates-5864978", 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/lankapropertyweb/agent?slug=prince-estates-5864978"
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/lankapropertyweb/agent?slug=prince-estates-5864978"));
            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/lankapropertyweb/agent?slug=prince-estates-5864978',
            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/lankapropertyweb/agent?slug=prince-estates-5864978")
        .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": {
        "slug": "prince-estates-5864978",
        "id": 5864978,
        "name": "Prince Estates",
        "url": "https://www.lankapropertyweb.com/agents/prince-estates-5864978",
        "verified": true,
        "logo": "https://www.lankapropertyweb.com/images/pics/profiles/251881_1765289294_6177.png",
        "areas_covered": "Colombo",
        "services": [
            "Residential sales",
            "Rentals",
            "Commercial property",
            "Land"
        ],
        "listings": [
            {
                "id": "5886260",
                "type": "rent",
                "url": "https://www.lankapropertyweb.com/rentals/property_details-5886260.html",
                "title": "The Address 606 \u2013 1BR Luxury Apt. | 23rd & 24th Floor | Tower 1 | 845 sqft | Rent: LKR 350,000/month",
                "price": 350000,
                "price_label": "Rs. 350,000",
                "price_period": "month",
                "price_qualifier": null,
                "currency": "LKR",
                "location": "Colombo 3",
                "image": "https://www.lankapropertyweb.com/pics/5886260/5886260_1775336372_0122.jpeg",
                "description": "Modern elegance meets coastal charm in this beautifully crafted 1-bedroom residence"
            }
        ],
        "pagination": {
            "page": 1,
            "total_pages": 4,
            "returned": 1,
            "has_more": true
        }
    },
    "meta": {
        "endpoint_family": "agent",
        "billable": true
    }
}

Errors

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

404

Not Found

No LankaPropertyWeb agent has that slug. Take it from the agents list or a listing. (`NOT_FOUND`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "agent"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "No LankaPropertyWeb agent has that slug. Take it from the agents list or a listing."
    },
    "success": false
}
422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected before any lookup, never ignored. Non-billable.

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

Upstream Unavailable

LankaPropertyWeb could not be reached after retries, answered with an error or changed its format (`UPSTREAM_UNAVAILABLE`). Retryable and never billed. Clients are never rate limited.

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