{ "openapi": "3.0.1", "info": { "title": "Invitation Homes Scraper: US Single-Family Rentals, Rent & Fees", "description": "Scrape Invitation Homes (invitationhomes.com), US single-family rentals: homes for rent with rent, fees, lease terms, beds, baths, sq ft, coordinates, photos, availability and schools, plus markets and leasing offices. Filter by market, state, city, ZIP, rent. Export CSV, Excel, JSON, XML.", "version": "0.1", "x-build-id": "q37wh7gC1mGsek7OS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/recordsdata~invitationhomes-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-recordsdata-invitationhomes-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/recordsdata~invitationhomes-scraper/runs": { "post": { "operationId": "runs-sync-recordsdata-invitationhomes-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/recordsdata~invitationhomes-scraper/run-sync": { "post": { "operationId": "run-sync-recordsdata-invitationhomes-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional invitationhomes.com pages to read: a home page (invitationhomes.com/houses-for-rent/...), a market page (invitationhomes.com/markets/houses-for-rent/denver-colorado) or a market search page (invitationhomes.com/search/denver-colorado). Home pages are read as they are, with no filters. A market page returns every home of that market, narrowed by the filters below.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "Home addresses", "type": "array", "description": "Optional list of homes to read directly: the last part of a home URL, for example 1228-brook-farm-ln-charlotte-nc-28214, or the full URL. Filters are not applied to these homes.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000. Counts every row returned (homes, markets and offices together)." }, "recordTypes": { "title": "Record types", "type": "array", "description": "What to return. Listings: one row per home for rent (rent, fees, lease terms, bedrooms, bathrooms, size, coordinates, photos, availability, specials, schools). Markets: one row per market (20 US markets with live counts, cities served and highlights). Offices: one row per Invitation Homes leasing office with its address and brokerage licence.", "items": { "type": "string", "enum": [ "listings", "markets", "offices" ], "enumTitles": [ "Listings (homes for rent)", "Markets (20 US markets)", "Offices (leasing offices)" ] }, "default": [ "listings" ] }, "markets": { "title": "Markets", "type": "array", "description": "Only homes in these Invitation Homes markets. Leave empty for all 20 markets. For the markets, offices and homes of a single metro area this is the fastest filter.", "items": { "type": "string", "enum": [ "atlanta-georgia", "austin-texas", "charlotte-north-carolina", "chicago-illinois", "dallas-texas", "denver-colorado", "houston-texas", "jacksonville-florida", "las-vegas-nevada", "los-angeles-california", "miami-florida", "minneapolis-minnesota", "nashville-tennessee", "orlando-florida", "phoenix-arizona", "sacramento-california", "salt-lake-city-utah", "san-antonio-texas", "seattle-washington", "tampa-florida" ], "enumTitles": [ "Atlanta, GA", "Austin, TX", "Carolinas (Charlotte), NC", "Chicago, IL", "Dallas, TX", "Denver, CO", "Houston, TX", "Jacksonville, FL", "Las Vegas, NV", "Southern California (Los Angeles), CA", "South Florida (Miami), FL", "Minneapolis, MN", "Nashville, TN", "Orlando, FL", "Phoenix, AZ", "Northern California (Sacramento), CA", "Salt Lake City, UT", "San Antonio, TX", "Seattle, WA", "Tampa, FL" ] }, "default": [] }, "states": { "title": "States", "type": "array", "description": "Only homes in these states. Leave empty for all states.", "items": { "type": "string", "enum": [ "AZ", "CA", "CO", "FL", "GA", "IL", "MN", "NC", "NV", "TN", "TX", "UT", "WA" ], "enumTitles": [ "Arizona", "California", "Colorado", "Florida", "Georgia", "Illinois", "Minnesota", "North Carolina", "Nevada", "Tennessee", "Texas", "Utah", "Washington" ] }, "default": [] }, "cities": { "title": "Cities", "type": "array", "description": "Only homes in these cities, for example Charlotte, Marietta or Oak Forest. Combine with a state or market to keep the run short, because the city is only known after a home page is opened for most homes.", "default": [], "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Only homes in these 5-digit ZIP codes, for example 30315. The fastest way to look at one neighbourhood: homes of other ZIP codes are never opened.", "default": [], "items": { "type": "string" } }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Only homes with at least this many bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Only homes with at least this many bathrooms (2.5 is allowed)." }, "minRent": { "title": "Min monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Lowest base rent per month in US dollars, before the monthly fees." }, "maxRent": { "title": "Max monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Highest base rent per month in US dollars, before the monthly fees." }, "minSqft": { "title": "Min size (sq ft)", "minimum": 0, "type": "integer", "description": "Smallest living area in square feet." }, "maxSqft": { "title": "Max size (sq ft)", "minimum": 0, "type": "integer", "description": "Largest living area in square feet." }, "availableBy": { "title": "Available by (date)", "type": "string", "description": "Only homes that can be moved into on or before this date, written YYYY-MM-DD, for example 2026-12-01." }, "onlyWithSpecial": { "title": "Only homes with a special offer", "type": "boolean", "description": "Keep only homes with an active leasing special (for example a free month of rent).", "default": false }, "onlyNewConstruction": { "title": "Only new construction", "type": "boolean", "description": "Keep only homes marked as new construction.", "default": false }, "includeContactDetails": { "title": "Include leasing office contact data", "type": "boolean", "description": "Add the business phone numbers and e-mail of the Invitation Homes leasing offices (no personal data). Off by default.", "default": false }, "maxPageReads": { "title": "Max home pages to open", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety limit for searches that must open many home pages to find matches, for example a city or rent filter without a state. Homes skipped by address are not counted.", "default": 6000 }, "maxRunSeconds": { "title": "Max run time (seconds)", "minimum": 30, "maximum": 86400, "type": "integer", "description": "Stop collecting after this many seconds and return what was gathered, so a very wide search cannot run for hours.", "default": 3600 }, "onlyNew": { "title": "Only new rows (monitor mode)", "type": "boolean", "description": "Only new rows: skip every home, market or office this same search already returned in an earlier run. Schedule the run daily to get just the new rentals.", "default": false }, "stateKey": { "title": "Monitor name (optional)", "type": "string", "description": "Name of this monitor. Leave empty to derive it from your filters. Use a name to keep two monitors with the same filters apart.", "default": "" }, "resetSeen": { "title": "Forget previously seen rows", "type": "boolean", "description": "Clear the saved list for this monitor before the run, so everything counts as new again.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed: the actor reads invitationhomes.com directly at a polite pace (three requests at a time). It switches to the Apify datacenter proxy by itself only if the site keeps refusing the connection.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }