Happy Endpoint

Search agents by name

Search for real estate agents by their name. Returns matching agents with basic profile info, badges, and listing counts.

GET
/agent-search-by-name

Authorization

RapidApiKey
X-RapidAPI-Key<token>

In: header

Query Parameters

query*string
  • Agent name to search for
  • Searches by name only
  • Example: vipul, john, anna
Length1 <= length <= 200
page?integer
  • Page number (starts from 1)
  • Results per page: 20
Default1
Range1 <= value
langs?string
  • Language code: en, ar, ru, zh
Default"en"

Header Parameters

X-RapidAPI-Host*string
Default"bayut14.p.rapidapi.com"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/agent-search-by-name?query=anna" \  -H "X-RapidAPI-Host: bayut14.p.rapidapi.com"
{
  "success": true,
  "data": {
    "agents": [
      null
    ],
    "total": 0,
    "page": 0,
    "totalPages": 0,
    "hitsPerPage": 0
  }
}
{
  "success": false,
  "message": "Invalid request: Missing required parameter",
  "error": "VALIDATION_ERROR"
}
{
  "success": false,
  "message": "Internal server error. Please try again later.",
  "error": "INTERNAL_ERROR"
}
{
  "success": false,
  "message": "Service temporarily unavailable. Please try again later.",
  "error": "API_ERROR"
}