{ "openapi": "3.0.1", "info": { "title": "AppFolio Rental Listings Scraper: Rent, Beds, Map & Apply Link", "description": "Scrape current rental vacancies from any AppFolio property manager portal: rent, beds, baths, square feet, address with map coordinates, availability, pet policy, photo and apply link. Add the manager's website to get their office phone. Filters included. No login. Pay per vacancy.", "version": "0.1", "x-build-id": "B45w38PNxqZe2JDoq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~appfolio-rental-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-appfolio-rental-listings-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/themineworks~appfolio-rental-listings-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-appfolio-rental-listings-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/themineworks~appfolio-rental-listings-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-appfolio-rental-listings-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "AppFolio portals or manager websites", "type": "array", "description": "Required. One per line. A property manager's AppFolio subdomain (acme), its host (acme.appfolio.com), any link on it (the listings page or one listing), or the manager's own website page that shows their AppFolio listings (the actor finds the portal on it and adds the office name, phone and email published there). Up to 1,000 per run.", "items": { "type": "string" } }, "maxListings": { "title": "Vacancies per portal", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Most vacancies to return from each portal. A portal lists all its vacancies on one page, so this only trims the result; it does not make the run faster.", "default": 100 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only vacancies with at least this many bedrooms. A studio counts as 0. Vacancies that do not state bedrooms are left out when this is set." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only vacancies with at least this many bathrooms. Half baths count, so 1.5 passes a minimum of 1." }, "minRent": { "title": "Minimum monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Only vacancies asking at least this much a month. Vacancies with no rent shown are left out when a rent filter is set." }, "maxRent": { "title": "Maximum monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Only vacancies asking at most this much a month." }, "cities": { "title": "Cities", "type": "array", "description": "Only vacancies in these cities, one per line. Add the state to be exact: Oakland, CA. Leave empty for every city the portal covers.", "items": { "type": "string" } }, "allowUnblockerFallback": { "title": "Retry refused portals through an unblocking proxy", "type": "boolean", "description": "Portals are read over a fast connection first. If a portal refuses it three times, try once more through Apify's unblocking proxy. Included in the price. Turn off to report such portals as blocked instead.", "default": true } } }, "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 } } } } } } } } } }