{ "openapi": "3.0.1", "info": { "title": "Property Characteristics API - Owner, Risk, Home Prices", "description": "Resolve any US address to a persistent property id, then read the full land and structure profile: land use, lot size, living area, beds, baths, construction, roof and foundation, owner occupancy, roof age and climate risk, plus listing, sales, rent and home price trends.", "version": "0.1", "x-build-id": "2IbuM5jjQfYy63Ghe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~property-characteristics-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-property-characteristics-api", "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/nabeelbaghoor~property-characteristics-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-property-characteristics-api", "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/nabeelbaghoor~property-characteristics-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-property-characteristics-api", "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": { "mode": { "title": "What to read", "enum": [ "property", "characteristics", "climateRisk", "roofAge", "listingTrends", "marketTrends", "rentalTrends", "homePriceIndex", "homePriceForecast" ], "type": "string", "description": "The first four options describe a property and read the list below. The last five describe a market and read a geography instead. Each dataset is licensed separately, so a run checks up front whether your credentials may call the one you picked.", "default": "characteristics" }, "properties": { "title": "Addresses or property ids", "type": "array", "description": "Property modes. One per line, either a full street address such as \"3001 Hackberry Rd, Irving, TX 75063\" or a numeric property id from an earlier run. An address is resolved to an id first, and that resolving step is not charged.", "items": { "type": "string" } }, "geographyType": { "title": "Market area type", "enum": [ "zip_code", "county_fips_code", "cbsa_code", "state", "state_id" ], "type": "string", "description": "Market modes. Which level of geography the values below are at.", "default": "county_fips_code" }, "geographyValues": { "title": "Market areas", "type": "array", "description": "Market modes. One value per line, matching the area type above, for example 06037 for Los Angeles County. A single run can cover many areas at once.", "items": { "type": "string" } }, "fromMonth": { "title": "From month", "type": "string", "description": "Market modes, optional. The first month of the range, written as YYYY-MM. A range needs both ends: leave both empty for the latest available reading." }, "toMonth": { "title": "To month", "type": "string", "description": "Market modes, optional. The last month of the range, written as YYYY-MM. A range needs both ends: leave both empty for the latest available reading." }, "useTestEnvironment": { "title": "Use the provider's test environment", "type": "boolean", "description": "Sends the run to the provider's UAT host instead of production. Use this while you are validating an integration, with the UAT credentials the provider issued you.", "default": false }, "maxResults": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "The most rows this run will save and charge for. A market run over a long date range returns one row per area per month, so allow room for those.", "default": 500 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "How fast to call the provider. Lower this if your agreement rate limits the run.", "default": 60 }, "clientId": { "title": "Client id", "type": "string", "description": "Your own client id for the property intelligence provider. This actor is bring your own key: it signs in with your credentials only, and never uses anyone else's." }, "clientSecret": { "title": "Client secret", "type": "string", "description": "Your own client secret for the property intelligence provider. Exchanged for a short lived access token at the start of every run and stored as a secret." } } }, "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 } } }, "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 } } } } } } } } } }