{ "openapi": "3.0.1", "info": { "title": "NYC Property Tax Abatements - BBL & Program Detail", "description": "New York City property tax abatement detail (3.25M rows): BBL, condo, tax year, program (J51, 421G, ICAP, SOLAR, CONDO, COOP, MCI), application status, abated amounts and all 101 published columns. Filter by BBL, borough, year or program; aggregate counts and dollar sums; join PLUTO.", "version": "0.0", "x-build-id": "X6jL9rhuM6yJK5Jg4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~nyc-property-abatements/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-nyc-property-abatements", "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-abatements/runs": { "post": { "operationId": "runs-sync-j0401-nyc-property-abatements", "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-abatements/run-sync": { "post": { "operationId": "run-sync-j0401-nyc-property-abatements", "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", "aggregate", "profile", "history" ], "type": "string", "description": "rows = abatement detail records (default). aggregate = one row per group with a count and/or dollar sum. profile = rows plus the PLUTO owner profile. history = one BBL's abatements across every published snapshot, newest extract first - a year-by-year abatement curve (bbl is required). Each record appears once per snapshot it was published in, and every row is metered.", "default": "" }, "bbl": { "title": "BBL", "type": "string", "description": "10-digit Borough-Block-Lot, e.g. \"4004200001\"." }, "borough": { "title": "Borough", "type": "string", "description": "Borough name or code: Manhattan/1, Bronx/2, Brooklyn/3, Queens/4, Staten Island/5." }, "block": { "title": "Block", "type": "string", "description": "Tax block within the borough, e.g. \"835\" (zero padding is not required)." }, "lot": { "title": "Lot", "type": "string", "description": "Tax lot within the block, e.g. \"17\"." }, "taxYear": { "title": "Tax year", "type": "string", "description": "Four-digit tax year, e.g. \"2026\" (the source covers 2021-2027)." }, "program": { "title": "Abatement program", "type": "string", "description": "Program code, e.g. J51, 421G, ICAP, SOLAR, CONDO, COOP, MCI, CERP, BBP, GCCA, ICIP, CONED, GRNRF. 421G and ICIP exist only in older snapshots (the newest snapshot has 11 programs) - add extractDate or includeHistory to reach them." }, "applicationStatus": { "title": "Application status", "type": "string", "description": "Source application status code, e.g. \"A\" (approved), \"R\", \"D\". Blank status is common and is not an error." }, "period": { "title": "Filing period", "type": "string", "description": "Filing period code, e.g. \"2Q\"." }, "condoId": { "title": "Condo number", "type": "string", "description": "Condo billing number, e.g. \"101858\"." }, "tenant": { "title": "Tenant name", "type": "string", "description": "Tenant-name prefix where the source records one (commercial/lease records only)." }, "minAbatement": { "title": "Minimum abatement (USD)", "minimum": 0, "type": "number", "description": "Only rows whose applied abatement amount is at least this many dollars." }, "groupBy": { "title": "Aggregate by", "enum": [ "", "taxYear", "program", "programSubcode", "applicationStatus", "period", "borough", "condoId" ], "type": "string", "description": "Dimension for mode=aggregate (blank = taxYear). Every group is returned.", "default": "" }, "metric": { "title": "Aggregate metric", "enum": [ "", "count", "abatementAmount", "eligibleAbatement", "installCost" ], "type": "string", "description": "What to aggregate (blank = count). abatementAmount sums the applied abatement in USD; eligibleAbatement and installCost sum their source columns.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap on records pushed in rows/profile mode (0 = default 50; up to 5,000 per run). Each record is metered individually, so there is no per-run charge cap.", "default": 50 }, "extractDate": { "title": "Snapshot date", "type": "string", "description": "Read one historical snapshot by its extract date (YYYY-MM-DD), e.g. \"2026-02-20\". Leave blank for the newest snapshot." }, "includeHistory": { "title": "Include every historical snapshot", "type": "boolean", "description": "When true, read all 23 published snapshots (3.25M rows). Each tax record then appears once per snapshot, so record counts and dollar sums multiply - only use it to compare snapshots. Cannot be combined with extractDate.", "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 } } } } } } } } } }