Bayut

Agent Stories API

GET https://api.dataextractorpro.com/agent-stories ⚡ 1 Credit

The Agent Stories API retrieves real estate agent stories, highlights, and featured updates to showcase agent activity and promotions.

Overview

This API endpoint allows programmatically extracting clean, structured data for Bayut.

Authentication

Include your API key in the request header:

                                x-api-key: YOUR_API_KEY
                            

Request Parameters

Parameter	Type	Required	Description & Allowed Values	Try Parameter
agent_externalID agent_externalID	text	Required	Value for parameter agent_externalID can be obtained from agent search endpoint.

Code Examples

Error Responses

400 Invalid Parameters

One or more required parameters are missing or invalid.

{
    "status": "error",
    "message": "Parameter 'q' is required"
}

401 Unauthorized

Invalid or missing API key in x-api-key header.

{
    "status": "error",
    "message": "Invalid API key"
}

429 Rate Limit / Quota Exceeded

API key usage quota has been exhausted.

{
    "status": "error",
    "message": "Usage limit reached"
}

500 Internal Server Error

An unexpected server error occurred during extraction.

{
    "status": "error",
    "message": "Internal extraction error"
}