{ "openapi": "3.0.1", "info": { "title": "NYC Property Valuation - Assessment & 5-Year Value Trail", "description": "New York City property assessment records (public open data, 11.7M rows, 2023-2027): every parcel's owner and address, its value through five assessment stages, and the year-over-year movement in market and assessed value.", "version": "0.0", "x-build-id": "An5vILv2PhHCSiwqZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~nyc-property-valuation/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-nyc-property-valuation", "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/j0401~nyc-property-valuation/runs": { "post": { "operationId": "runs-sync-j0401-nyc-property-valuation", "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/j0401~nyc-property-valuation/run-sync": { "post": { "operationId": "run-sync-j0401-nyc-property-valuation", "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": "Mode", "enum": [ "rows", "parcel", "trend", "aggregate" ], "type": "string", "description": "rows = parcels matching your filters. parcel = one parcel's full 5-year value trail with the year-over-year movement. trend = per-roll-year totals for a scope. aggregate = server-side count by one dimension.", "default": "rows" }, "year": { "title": "Roll year", "type": "string", "description": "Assessment roll year. The source currently carries 2023-2027 (the rolls publish ahead of the year they cover). Defaults to the newest roll available." }, "period": { "title": "Assessment period", "enum": [ "3", "1" ], "type": "string", "description": "3 = the finalized roll (default). 1 = the earlier period, where the current-base and final value groups are still zero.", "default": "3" }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum records to return, up to one page of 20000. Default 50; 0 is treated as the default rather than as all records. A larger request is served one page and the run logs that it was capped.", "default": 50 }, "boro": { "title": "Borough", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "NYC borough code: 1 Manhattan, 2 Bronx, 3 Brooklyn, 4 Queens, 5 Staten Island." }, "parid": { "title": "Parcel id (PARID)", "type": "string", "description": "The parcel's PARID, exact match (use it with mode=parcel to follow one property across years)." }, "ownerName": { "title": "Owner name", "type": "string", "description": "Partial owner-name match. '%' and '_' are not allowed." }, "address": { "title": "Street name", "type": "string", "description": "Partial street-name match." }, "zipCode": { "title": "ZIP code", "type": "string", "description": "ZIP prefix match. Digits and dashes only." }, "bldgClass": { "title": "Building class", "type": "string", "description": "Partial building-class match (A1, A5, B1, R4 and so on)." }, "zoning": { "title": "Zoning", "type": "string", "description": "Partial zoning-district match." }, "rollSection": { "title": "Roll section", "type": "string", "description": "Exact roll section code." }, "block": { "title": "Block", "minimum": 0, "type": "integer", "description": "Exact tax block number." }, "lot": { "title": "Lot", "minimum": 0, "type": "integer", "description": "Exact tax lot number." }, "minMarketValue": { "title": "Min market value", "minimum": 0, "type": "number", "description": "Lower bound on the current market total." }, "maxMarketValue": { "title": "Max market value", "minimum": 0, "type": "number", "description": "Upper bound on the current market total." }, "minTaxableValue": { "title": "Min taxable value", "minimum": 0, "type": "number", "description": "Lower bound on the current taxable total." }, "maxTaxableValue": { "title": "Max taxable value", "minimum": 0, "type": "number", "description": "Upper bound on the current taxable total." }, "groupBy": { "title": "Group by (aggregate mode)", "enum": [ "boro", "bldgClass", "zipCode", "taxClass", "rollSection", "year" ], "type": "string", "description": "Dimension for the server-side count. Use only with mode=aggregate - supplying it in another mode is rejected rather than ignored." } } }, "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 } } } } } } } } } }