Skip to content
Scrappa Get API key
Square Yards API 1 credit/request

Square Yards Agent Profile API Documentation

GET https://scrappa.co/api/squareyards/v1/agent?id=331378

Read the public profile of one agent by id: name, agency, location, languages, years of experience, RERA number, rating and review count when present, active listings, profile views, badges, the about sections and the agent current sale and rent listings in the same item shape as /search. The agent id is the agent.id of any listing. Phone numbers are never returned. An agent without a public profile is a non-billable 404.

Square Yards Agent Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/squareyards/v1/agent?id=331378
Auth header
x-api-key
Cost
1 credit/request
id = 331378
Response preview
200 OK
{
    "success": true,
    "data": {
        "profile_url": "https://www.squareyards.com/agent/agent/331378",
        "id": 331378,
        "name": "Yogesh Bapu Ghadigaonkar",
        "image": "https://img.squareyards.com/connect/profilepic/919987110619639185290230926953.jpg",
        "agency": "Aaradhya Fortune Pvt Ltd",
        "location": "Bhandup West, Mumbai",
        "languages": [
            "English",
            "Hindi",
            "Marathi"
        ],
...

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 integer Required

Agent id such as 331378, taken from agent.id of a search or listing item.

Example value 331378
slug string Optional

Optional agent slug from agent.slug. The slug is cosmetic upstream, so it can be left out.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

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

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/squareyards/v1/agent?id=331378', 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/squareyards/v1/agent?id=331378',
    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/squareyards/v1/agent?id=331378")
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/squareyards/v1/agent?id=331378", 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/squareyards/v1/agent?id=331378', 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/squareyards/v1/agent?id=331378")
        .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/squareyards/v1/agent?id=331378", 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/squareyards/v1/agent?id=331378"
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/squareyards/v1/agent?id=331378"));
            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/squareyards/v1/agent?id=331378',
            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/squareyards/v1/agent?id=331378")
        .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": {
        "profile_url": "https://www.squareyards.com/agent/agent/331378",
        "id": 331378,
        "name": "Yogesh Bapu Ghadigaonkar",
        "image": "https://img.squareyards.com/connect/profilepic/919987110619639185290230926953.jpg",
        "agency": "Aaradhya Fortune Pvt Ltd",
        "location": "Bhandup West, Mumbai",
        "languages": [
            "English",
            "Hindi",
            "Marathi"
        ],
        "experience_years": 7,
        "rera_number": "A041332501948",
        "rating": null,
        "review_count": null,
        "active_listings": 60,
        "profile_views": 1175,
        "badges": [
            "pro-agent"
        ],
        "about": {
            "description": null,
            "sections": {
                "Specialization": [
                    "New Sale",
                    "Commercial",
                    "Residential"
                ]
            }
        },
        "listings": {
            "sale": [],
            "rent": []
        }
    },
    "meta": {
        "endpoint_family": "agent",
        "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, property type, bedroom value or sort cannot be resolved. The response is not billable.

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

Resource Not Found

The requested Square Yards resource does not exist. The response is not billable.

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

Unexpected Upstream Response

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

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "agent"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The Square Yards API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Upstream Unavailable

Square Yards was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429.

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