# Scrapfly Documentation ## Table of Contents ### Dashboard - [Intro](https://scrapfly.io/docs) - [Project](https://scrapfly.io/docs/project) - [Account](https://scrapfly.io/docs/account) - [Workspace & Team](https://scrapfly.io/docs/workspace-and-team) - [Billing](https://scrapfly.io/docs/billing) ### Products #### MCP Server - [Getting Started](https://scrapfly.io/docs/mcp/getting-started) - [Tools & API Spec](https://scrapfly.io/docs/mcp/tools) - [Authentication](https://scrapfly.io/docs/mcp/authentication) - [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples) - [FAQ](https://scrapfly.io/docs/mcp/faq) ##### Integrations - [Overview](https://scrapfly.io/docs/mcp/integrations) - [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop) - [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code) - [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt) - [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor) - [Cline](https://scrapfly.io/docs/mcp/integrations/cline) - [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf) - [Zed](https://scrapfly.io/docs/mcp/integrations/zed) - [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code) - [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode) - [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain) - [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex) - [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai) - [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai) - [n8n](https://scrapfly.io/docs/mcp/integrations/n8n) - [Make](https://scrapfly.io/docs/mcp/integrations/make) - [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier) - [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi) - [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder) - [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client) #### Web Scraping API - [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started) - [API Specification]() - [Monitoring](https://scrapfly.io/docs/monitoring) - [Customize Request](https://scrapfly.io/docs/scrape-api/custom) - [Debug](https://scrapfly.io/docs/scrape-api/debug) - [Anti Scraping Protection](https://scrapfly.io/docs/scrape-api/anti-scraping-protection) - [Proxy](https://scrapfly.io/docs/scrape-api/proxy) - [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode) - [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog) - [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify) - [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction) - [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering) - [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario) - [SSL](https://scrapfly.io/docs/scrape-api/ssl) - [DNS](https://scrapfly.io/docs/scrape-api/dns) - [Cache](https://scrapfly.io/docs/scrape-api/cache) - [Session](https://scrapfly.io/docs/scrape-api/session) - [Webhook](https://scrapfly.io/docs/scrape-api/webhook) - [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot) - [Errors](https://scrapfly.io/docs/scrape-api/errors) - [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout) - [Throttling](https://scrapfly.io/docs/throttling) - [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot) - [Billing](https://scrapfly.io/docs/scrape-api/billing) - [FAQ](https://scrapfly.io/docs/scrape-api/faq) #### Crawler API - [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started) - [API Specification]() - [Retrieving Results](https://scrapfly.io/docs/crawler-api/results) - [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format) - [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules) - [Webhook](https://scrapfly.io/docs/crawler-api/webhook) - [Billing](https://scrapfly.io/docs/crawler-api/billing) - [Errors](https://scrapfly.io/docs/crawler-api/errors) - [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot) - [FAQ](https://scrapfly.io/docs/crawler-api/faq) #### Screenshot API - [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started) - [API Specification]() - [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility) - [Webhook](https://scrapfly.io/docs/screenshot-api/webhook) - [Billing](https://scrapfly.io/docs/screenshot-api/billing) - [Errors](https://scrapfly.io/docs/screenshot-api/errors) #### Extraction API - [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started) - [API Specification]() - [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template) - [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt) - [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai) - [Webhook](https://scrapfly.io/docs/extraction-api/webhook) - [Billing](https://scrapfly.io/docs/extraction-api/billing) - [Errors](https://scrapfly.io/docs/extraction-api/errors) - [FAQ](https://scrapfly.io/docs/extraction-api/faq) #### Proxy Saver - [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started) - [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints) - [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations) - [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates) - [Protocols](https://scrapfly.io/docs/proxy-saver/protocols) - [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile) - [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security) - [Billing](https://scrapfly.io/docs/proxy-saver/billing) #### Cloud Browser API - [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started) - [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy) - [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock) - [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads) - [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume) - [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop) - [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode) - [Bring Your Own Proxy](https://scrapfly.io/docs/cloud-browser-api/bring-your-own-proxy) - [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions) ##### Integrations - [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer) - [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright) - [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium) - [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser) - [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use) - [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand) - [Billing](https://scrapfly.io/docs/cloud-browser-api/billing) - [Errors](https://scrapfly.io/docs/cloud-browser-api/errors) ### Tools - [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector) ### SDK - [Golang](https://scrapfly.io/docs/sdk/golang) - [Python](https://scrapfly.io/docs/sdk/python) - [TypeScript](https://scrapfly.io/docs/sdk/typescript) - [Scrapy](https://scrapfly.io/docs/sdk/scrapy) ### Integrations - [Getting Started](https://scrapfly.io/docs/integration/getting-started) - [LangChain](https://scrapfly.io/docs/integration/langchain) - [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex) - [CrewAI](https://scrapfly.io/docs/integration/crewai) - [Zapier](https://scrapfly.io/docs/integration/zapier) - [Make](https://scrapfly.io/docs/integration/make) - [n8n](https://scrapfly.io/docs/integration/n8n) ### Academy - [Overview](https://scrapfly.io/academy) - [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview) - [Tools](https://scrapfly.io/academy/tools-overview) - [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering) - [Static Scraping](https://scrapfly.io/academy/static-scraping) - [HTML Parsing](https://scrapfly.io/academy/html-parsing) - [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping) - [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping) - [Headless Browsers](https://scrapfly.io/academy/headless-browsers) - [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data) - [JSON Parsing](https://scrapfly.io/academy/json-parsing) - [Data Processing](https://scrapfly.io/academy/data-processing) - [Scaling](https://scrapfly.io/academy/scaling) - [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary) - [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking) - [Proxies](https://scrapfly.io/academy/proxies) --- # Real Estate Property Extraction Schema > This model has been tailored based on customer feedback and usage. If you need a specific model and enough generalist, you can contact us on the support link below. If some fields are missing, you can also contact us to add them. > > [Contact us](https://scrapfly.io/docs/support) ##### Real Estate Property Schema object - **name** \[string, null\] The name or title of the property listing, usually found as a header or title in the HTML page. - **date\_published** \[string, null\] COMPUTE: Convert date\_published\_raw to YYYY-MM-DD format. If date\_published\_raw is null or cannot be parsed, set to null. - **date\_published\_raw** \[string, null\] The raw date string as it appears on the webpage, which may include additional text or formatting. - **description** \[string, null\] A detailed description of the property, often found in the main content area of the listing. - **main\_image** \[string, null\] URL of the main image representing the property, usually the first image in the gallery or a prominently displayed image. Copy the exact URL as found in the document. Never construct or guess URLs. - **images** \[array, null\] A collection of image URLs representing different views of the property. ###### Items \[string\] ###### Items \[string\] - **year\_built** \[integer, null\] The year the property was built, often found in the property details or specifications section. - **breadcrumbs** \[array, null\] Breadcrumb navigation links showing the hierarchical location of the property listing on the website. ###### Items object - **name** \[string, null\] The name of the breadcrumb link, representing a category or location. - **link** \[string, null\] The URL of the breadcrumb link. - **location** \[object, null\] Location details of the property. - **city** \[string, null\] The city where the property is located. - **region** \[string, null\] The region or state where the property is located. - **other\_ads** \[array, null\] A list of other ads related to the property. ###### Items object - **image\_url** \[string, null\] URL of the image representing the property in other ads. Copy the exact URL as found in the document. Never construct or guess URLs. - **price** \[object, null\] Price details of the property in other ads. - **amount** \[number, null\] The price amount of the property in other ads. - **currency** \[string, null\] COMPUTE: Currency code in ISO3 format (e.g., USD, EUR, GBP). Derive from currency symbol if code not found ($ -> USD, € -> EUR, £ -> GBP). - **location** \[object, null\] Location details of the property in other ads. - **region** \[string, null\] The region or state of the property in other ads. - **city** \[string, null\] The city of the property in other ads. - **area** \[object, null\] The area details of the property in other ads. - **value** \[number, null\] The numerical value representing the area of the property in other ads. - **unit\_code** \[string, null\] The unit of measurement for the area, such as 'm2' or 'sq2'. - **raw** \[string, null\] The raw area string as it appears on the webpage, which may include the unit and additional text. - **additional\_property** \[array, null\] Additional features or attributes of the property not covered by other fields. ###### Items object - **name** \[string, null\] The name of an additional property feature or attribute. - **value** \[string, null\] The value of the additional property feature or attribute. - **address** \[object, null\] The address details of the property. - **postal\_code** \[string, null\] The postal code of the property, often found in the address section. - **street\_address** \[string, null\] The street address of the property, usually found in the address or contact details. - **address\_country** \[string, null\] The country where the property is located. - **address\_locality** \[string, null\] The locality or city where the property is located. - **address\_region** \[string, null\] The region or state where the property is located. - **raw** \[string, null\] The full raw address string as it appears on the webpage. - **area** \[object, null\] The area details of the property. - **value** \[number, null\] The numerical value representing the area of the property, often found in the specifications. - **unit\_code** \[string, null\] The unit of measurement for the area, such as 'sq2' or 'm2'. - **raw** \[string, null\] The raw area string as it appears on the webpage, which may include the unit and additional text. - **number\_of\_rooms** \[integer, null\] The total number of rooms in the property, including living rooms, bedrooms, etc. - **identifier** \[string, null\] A unique identifier for the property listing, often found in the URL or as a specific field, but not an URL - **trade\_info** \[array, null\] Details of trade actions related to the property, such as sale or rent. ###### Items object - **trade\_type** \[string, null\] The type of trade action, such as 'sale' or 'rent'. - **price** \[number, null\] The price of the property. - **currency** \[string, null\] COMPUTE: Currency code in ISO3 format (e.g., USD, EUR, GBP). Derive from currency symbol if code not found ($ -> USD, € -> EUR, £ -> GBP). - **price\_per\_area\_unit** \[number, null\] Only if trade\_info.price and area.value are present. Divide trade\_info.price by area.value to get price per area unit. Round it to 2 decimal places. - **furnished** \[boolean, null\] Indicates whether the property is furnished. - **url** \[string, null\] The URL of the property listing. Copy the exact URL as found in the document. Never construct or guess URLs. - **equipment** \[array, null\] A list of equipment or amenities available with the property. ###### Items string ###### Items string - **property\_type** \[string, null\] The type of property. - **floor\_number** \[integer, null\] The floor number the property is on. - **total\_floors** \[integer, null\] Total number of floors in the building. - **listing\_agent** \[string, null\] Information about the listing agent or real estate company. - **contact\_number** \[string, null\] Phone number for contact. - **email** \[string, null\] Email address for inquiries. - **availability\_status** \[string, null\] Current status of the property (e.g., available, sold, rented). *Default Value: available* - **listing\_type** \[string, null\] Specifies whether the listing is for rent or buy. - **rooms** \[array, null\] A list of rooms and their counts in the property. ###### Items object - **room\_type** \[string, null\] The type of room in the property. - **count** \[integer, null\] The number of rooms of this type in the property.