{ "openapi": "3.0.1", "info": { "title": "Property Listing Identity Reconciler", "description": "Assign stable property IDs and lifecycle events to listing feeds you already have the right to use. Does not scrape property portals.", "version": "0.1", "x-build-id": "aHaf53tkCYdcM6gOo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plusonets~property-listing-reconciler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plusonets-property-listing-reconciler", "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/plusonets~property-listing-reconciler/runs": { "post": { "operationId": "runs-sync-plusonets-property-listing-reconciler", "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/plusonets~property-listing-reconciler/run-sync": { "post": { "operationId": "run-sync-plusonets-property-listing-reconciler", "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": { "useSample": { "title": "Use built-in sample", "type": "boolean", "description": "Run the labelled fictional sample (two snapshots with a relisting, a duplicate advertisement, and unit traps). Ignored when you supply a dataset, JSON, CSV, or URL.", "default": true }, "datasetId": { "title": "Apify dataset", "type": "string", "description": "Dataset from a listing run in your Apify account. Read-only. Leave empty to use JSON, CSV, a file URL, or the sample. This Actor does not scrape listing sites." }, "listingsJson": { "title": "Listings JSON", "type": "string", "description": "A JSON array of listings, or an object with a snapshots array. Each snapshot may set snapshotId, observedAt, coverage, and listings." }, "listingsCsv": { "title": "Listings CSV", "type": "string", "description": "CSV text with a header row. Common listing column names are mapped automatically." }, "listingsUrl": { "title": "Listings file URL", "type": "string", "description": "HTTPS or HTTP URL of a JSON or CSV file you are allowed to fetch. Private hosts, localhost, and link-local addresses are refused. HTML pages are not parsed." }, "fieldMapping": { "title": "Field mapping override", "type": "object", "description": "Optional map of canonical fields to your column paths. Example: {\"listingId\": \"mlsNumber\", \"address\": \"siteAddress\", \"unit\": \"apartment\"}. Empty values fall back to automatic mapping.", "default": {} }, "snapshotId": { "title": "Snapshot id", "type": "string", "description": "Id for a flat JSON, CSV, or dataset input. Defaults to the dataset id, or input. Not used when the JSON already contains snapshots." }, "observedAt": { "title": "Observed at", "type": "string", "description": "Observation date for a flat input, YYYY-MM-DD. Defaults to today. An older date does not rewrite a newer saved listing." }, "snapshotCoverage": { "title": "Snapshot coverage", "enum": [ "partial", "complete" ], "type": "string", "description": "Partial means this file is not a full comparable scan. Listings missing from a partial or complete file stay unknown. They are never marked sold.", "default": "partial" }, "sourceLabel": { "title": "Source label", "type": "string", "description": "Label stored with listing ids when a row does not name its own source. Use one label per feed so the same listing id stays stable across runs.", "default": "feed" }, "defaultCountry": { "title": "Default country", "type": "string", "description": "Country assumed when a row does not say. US or GB.", "default": "US" }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that keeps the property registry across runs. Created on first use under limited permissions.", "default": "property-listing-reconciler-state" }, "stateKey": { "title": "Registry key", "type": "string", "description": "Separate books inside the same store, for example a metro or a client.", "default": "default" }, "resetState": { "title": "Reset saved state", "type": "boolean", "description": "Ignore the saved registry for this run and treat every listing as a first observation. The previous registry is kept under the last-good key.", "default": false }, "confirmedLinksJson": { "title": "Confirmed links JSON", "type": "string", "description": "Optional array of {\"listingId\", \"propertyId\"} or {\"listingId\", \"sameAsListingId\"}. A confirmation cannot merge two different units, or a missing unit into a known unit." }, "matchThreshold": { "title": "Auto-match score", "minimum": 70, "maximum": 100, "type": "integer", "description": "Fuzzy score from 70 to 100 required before two listings are treated as the same property. House number must still match, and units must be compatible.", "default": 90 }, "reviewThreshold": { "title": "Manual-review score", "minimum": 50, "maximum": 99, "type": "integer", "description": "Scores from this value up to the auto-match score are delivered for review and are not merged or charged as a reconciliation.", "default": 75 }, "maxListings": { "title": "Maximum listings", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop reading after this many rows per snapshot. A truncated file is treated as partial coverage.", "default": 20000 }, "alertOnlyOnChange": { "title": "Alert only on change", "type": "boolean", "description": "Push lifecycle events and manual reviews only. Unchanged listings are not delivered and are not charged. The registry is still updated.", "default": 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 } } } } } } } } } }