{ "openapi": "3.0.1", "info": { "title": "Cook County Assessment Appeals - Values & Board Decisions", "description": "Cook County assessment records keyed on one parcel id (public open data, 59.8M rows): a parcel's value as mailed, certified and Board-revised; every appeal case with type, status and reasons; and Board of Review decisions showing the Assessor's value against the Board's and the outcome.", "version": "0.0", "x-build-id": "9i43wBuESXI9Dxdvs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~cook-assessment-appeals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-cook-assessment-appeals", "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~cook-assessment-appeals/runs": { "post": { "operationId": "runs-sync-j0401-cook-assessment-appeals", "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~cook-assessment-appeals/run-sync": { "post": { "operationId": "run-sync-j0401-cook-assessment-appeals", "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" ], "type": "string", "description": "rows = records matching your filters (default). aggregate = one count row per group (see groupBy). profile = one parcel's values, appeals and Board decisions together (requires pin).", "default": "rows" }, "corpus": { "title": "Corpus", "enum": [ "values", "appeals", "decisions" ], "type": "string", "description": "values = assessed values at three stages (28 roll years, 1999-2026). appeals = appeal cases with type, status and reasons (14 years - 2005-2020 are missing while the County repopulates, see the README). decisions = Board of Review decisions with the Assessor's vs the Board's value and the outcome (16 years, 2010-2025).", "default": "values" }, "pin": { "title": "PIN", "type": "string", "description": "Exact 14-digit parcel index number, e.g. '08142130040000'. Required for profile mode. Blank = any.", "default": "" }, "year": { "title": "Tax year", "type": "string", "description": "Roll year. Blank = the newest roll of the chosen corpus. The three corpora carry different spans, so a year one corpus has may not exist in another.", "default": "" }, "township": { "title": "Township code", "type": "string", "description": "Exact township code, e.g. '16'. Blank = any.", "default": "" }, "class": { "title": "Property class", "type": "string", "description": "Exact property class code, e.g. '203' (values and appeals corpora only). Blank = any.", "default": "" }, "result": { "title": "Board decision result", "enum": [ "", "Decrease", "No Change", "Increase" ], "type": "string", "description": "The Board of Review's outcome (decisions corpus only): Decrease (~3.19M), No Change (~3.73M), Increase (~5.1k). Blank = any. Aggregate counts for this dimension cover the newest year's roll unless a year is passed.", "default": "" }, "majorClass": { "title": "Major class", "enum": [ "", "Residential", "Commercial and Industrial", "Multi Family", "Vacant", "Industrial Incentive and Industrial Brownfield", "Commercial/Industrial Incentive", "Multi Family Incentive", "Not For Profit", "Exempt and Railroad", "Commercial Incentive" ], "type": "string", "description": "The property's major class (decisions corpus only), matched exactly - 'Multi Family' and 'Multi Family Incentive' are separate classes. Blank = any. Aggregate counts for this dimension cover the newest year's roll unless a year is passed.", "default": "" }, "status": { "title": "Appeal status", "enum": [ "", "closed", "open", "closed pending c of e", "pending" ], "type": "string", "description": "Appeal case status (appeals corpus only). Blank = any.", "default": "" }, "appealType": { "title": "Appeal type", "enum": [ "", "residential", "condo/coop", "commercial", "land", "incentive", "omitted assessment", "c of e - valuations", "c of e - incentive", "c of e - omitted" ], "type": "string", "description": "The kind of appeal filed (appeals corpus only). Blank = any.", "default": "" }, "change": { "title": "Value changed", "enum": [ "", "change", "no change" ], "type": "string", "description": "Whether the appeal moved the value, as recorded on the case (appeals corpus only). Blank = any. Aggregate counts for this dimension cover the newest year's roll unless a year is passed.", "default": "" }, "hearingType": { "title": "Hearing type", "enum": [ "", "Current year appeal", "Current year appeal & prior year(s) certificate of error" ], "type": "string", "description": "Whether the case covers this year alone (2,624,512) or also prior years (21,887) - appeals corpus only. Blank = any.", "default": "" }, "agent": { "title": "Agent name", "type": "string", "description": "The representative who filed the appeal - attorney or tax firm (appeals corpus only). Blank = any.", "default": "" }, "appellant": { "title": "Appellant", "type": "string", "description": "The party who appealed to the Board of Review (decisions corpus only). Blank = any.", "default": "" }, "groupBy": { "title": "Aggregate by", "enum": [ "taxYear", "class", "townshipName", "appealType", "status", "change", "hearingType", "result", "majorClass", "appealTypeDescription" ], "type": "string", "description": "Which dimension to aggregate over. Not every dimension exists in every corpus - an incompatible combination is reported as an error rather than returning an unfiltered result. Only 'taxYear' spans every year of its corpus; any other dimension is counted on the newest year's roll unless you pass an explicit year.", "default": "taxYear" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed in rows mode (0 = up to ~10k per run; each record is metered individually, so there is no per-run charge cap). Aggregate mode returns every group.", "default": 50 } } }, "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 } } } } } } } } } }