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

Graana Agency Profile API Documentation

GET https://scrappa.co/api/graana/agency?id=17580

Scrappa's GET /api/graana/agency returns the public profile of one Graana agency by id. Take the id from agency_id on a listing or from the agency search.

What you get

name, url, address, phone, email, website, description, city_id, city, type, services, coordinates and logo. The counts are total_sale, total_rent, sale_by_type and rent_by_type (per city and subtype) and cities. featured_listings holds up to 15 current listings of the agency in the search row shape. For all its properties call the search endpoint with agency_id, city_id and purpose.

Notes

The profile is cached for a few minutes. A field the agency left empty is null. An id that has no agency returns 404, which is never billed.

Graana Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/graana/agency?id=17580
Auth header
x-api-key
Cost
1 credit/request
id = 17580
Response preview
200 OK
{
    "success": true,
    "agency": {
        "id": 17580,
        "url": "https://www.graana.com/agencies/17580",
        "name": "ASK GROUP",
        "address": "Pakistan Town",
        "phone": "03000000002",
        "email": "agency@example.com",
        "website": null,
        "description": null,
        "city_id": 1,
        "city": "Islamabad",
        "type": null,
...

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.

id integer Required

Agency id from a listing or agency search, for example 17580.

Example value 17580

Request Examples

PHP
<?php

$curl = curl_init();

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

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/graana/agency?id=17580', 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/graana/agency?id=17580',
    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/graana/agency?id=17580")
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/graana/agency?id=17580", 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/graana/agency?id=17580', 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/graana/agency?id=17580")
        .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/graana/agency?id=17580", 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/graana/agency?id=17580"
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/graana/agency?id=17580"));
            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/graana/agency?id=17580',
            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/graana/agency?id=17580")
        .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 agency meta
JSON Response
200 OK
{
    "success": true,
    "agency": {
        "id": 17580,
        "url": "https://www.graana.com/agencies/17580",
        "name": "ASK GROUP",
        "address": "Pakistan Town",
        "phone": "03000000002",
        "email": "agency@example.com",
        "website": null,
        "description": null,
        "city_id": 1,
        "city": "Islamabad",
        "type": null,
        "services": null,
        "coordinates": null,
        "logo": null,
        "total_sale": 39,
        "total_rent": 0,
        "sale_by_type": [
            {
                "city_id": 1,
                "subtype": "house",
                "count": 4
            },
            {
                "city_id": 1,
                "subtype": "residential_plot",
                "count": 35
            }
        ],
        "rent_by_type": [],
        "cities": [
            {
                "city_id": 1,
                "city": "Islamabad",
                "count": 39
            }
        ],
        "featured_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": "agency",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

404

Not Found

Nothing exists with that identifier on Graana (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "agency"
    },
    "error": {
        "code": "not_found",
        "message": "No Graana record exists with that identifier."
    },
    "success": false
}
422

Validation Error

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

{
    "errors": {
        "purpose": [
            "The id field is required."
        ]
    },
    "message": "The id field is required."
}
503

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": "agency"
    },
    "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.