{ "openapi": "3.0.1", "info": { "title": "Fair Housing Listing Checker for Real Estate Ads", "description": "Check real estate listings and rental ads for Fair Housing wording risk in bulk. Flags 'adults only', 'perfect for families', 'no section 8' and more with the quote, protected class, severity, HUD reference and a neutral rewrite. Works on Zillow, Realtor.com or Craigslist scraper data.", "version": "0.1", "x-build-id": "bwNDFAuTn3l93PLYt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ultimatemc~fair-housing-listing-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ultimatemc-fair-housing-listing-checker", "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/ultimatemc~fair-housing-listing-checker/runs": { "post": { "operationId": "runs-sync-ultimatemc-fair-housing-listing-checker", "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/ultimatemc~fair-housing-listing-checker/run-sync": { "post": { "operationId": "run-sync-ultimatemc-fair-housing-listing-checker", "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": { "texts": { "title": "Listing descriptions to check", "type": "array", "description": "Real estate listing descriptions, rental ads or MLS remarks, one per line. The prefill has three examples; replace them with your own.", "items": { "type": "string" } }, "items": { "title": "Listings (advanced, optional)", "type": "array", "description": "One object per listing with your own \"id\" and any of \"title\", \"description\", \"remarks\", \"text\". Example: [{\"id\": \"MLS-123\", \"title\": \"3BR ranch\", \"description\": \"Great for families...\"}]" }, "datasetId": { "title": "Dataset ID (optional)", "type": "string", "description": "Check the output of another Actor, for example a Zillow, Realtor.com, Redfin or Craigslist scraper. Title, description and remarks fields are detected automatically (HTML is stripped)." }, "textFields": { "title": "Dataset fields to check (optional)", "type": "array", "description": "Field names to read from dataset items, e.g. \"description\". Leave empty to use common title/description/remarks fields.", "items": { "type": "string" } }, "minSeverity": { "title": "Minimum severity to report", "enum": [ "low", "medium", "high" ], "type": "string", "description": "'medium' (default) shows explicit preferences and 'ideal buyer' wording. 'low' also shows style notes such as 'master bedroom' that HUD says are not violations but some MLSs ask to avoid.", "default": "medium" }, "onlyFlagged": { "title": "Only save listings with findings", "type": "boolean", "description": "Skip listings with no findings at the chosen severity (you are only charged for saved rows).", "default": false }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after this many listings.", "default": 1000 } } }, "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 } } } } } } } } } }