{ "openapi": "3.0.1", "info": { "title": "US Code Violations - 9 jurisdictions, one case model", "description": "Property, housing and code violations from 9 US jurisdictions (~4.2M records) normalised into one schema with separate case-status and resolution fields.", "version": "0.1", "x-build-id": "Ey1eu4GFQr2pjmJCN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/formal_sadness_xvx~us-code-violations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-formal_sadness_xvx-us-code-violations", "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/formal_sadness_xvx~us-code-violations/runs": { "post": { "operationId": "runs-sync-formal_sadness_xvx-us-code-violations", "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/formal_sadness_xvx~us-code-violations/run-sync": { "post": { "operationId": "run-sync-formal_sadness_xvx-us-code-violations", "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": { "sources": { "title": "Jurisdictions", "type": "array", "description": "Which jurisdictions to fetch. Defaults to all 9.", "items": { "type": "string", "enum": [ "chicago", "montgomery_md", "norfolk", "kcmo", "nyc_bic", "cambridge", "chicago_ordinance", "new_orleans", "mesa" ], "enumTitles": [ "Chicago, IL (~2.0M) - building violations, cleanest status", "Montgomery County, MD (~954k) - status is an INSPECTION outcome", "Norfolk, VA (~45k) - richest status vocabulary", "Kansas City, MO (~175k) - date_found has typos into 2029", "New York City BIC (~18k) - trade waste only, LEGAL dispositions", "Cambridge, MA (~5k) - small, well graded", "Chicago ordinance hearings (~839k) - LEGAL; date typos to year 6111", "New Orleans, LA (~111k) - adjudication / abatement pipeline", "Mesa, AZ (~81k) - code compliance with parcel numbers" ] } }, "violatedAfter": { "title": "Violation on or after", "type": "string", "description": "Only violations recorded on or after this date (YYYY-MM-DD)." }, "violatedBefore": { "title": "Violation on or before", "type": "string", "description": "Strongly recommended. Kansas City's date_found contains typos into 2029 and Chicago ordinance hearings reach year 6111; without an upper bound those rows sort to the top of a newest-first fetch." }, "openOnly": { "title": "Open cases only", "type": "boolean", "description": "Shortcut for caseStatus = [OPEN]. Normalises across six different vocabularies (OPEN / New / In-Violation / Work in Progress / Not Corrected).", "default": false }, "caseStatus": { "title": "Case status", "type": "array", "description": "Filter by normalised case state. Orthogonal to resolution: a case can be CLOSED with any resolution.", "items": { "type": "string", "enum": [ "OPEN", "CLOSED", "UNKNOWN" ], "enumTitles": [ "OPEN - still live", "CLOSED - case ended", "UNKNOWN - source published no status" ] } }, "resolution": { "title": "Resolution", "type": "array", "description": "How the case ended. Orthogonal to case status because jurisdictions describe different processes: Montgomery reports inspection outcomes, NYC BIC reports court dispositions.", "items": { "type": "string", "enum": [ "CORRECTED", "CITED", "DISMISSED", "NO_ACCESS", "OTHER", "NONE" ], "enumTitles": [ "CORRECTED - complied or abated", "CITED - citation, ticket or judgement", "DISMISSED - unfounded, withdrawn, barred", "NO_ACCESS - inspector could not enter", "OTHER - closed for another reason", "NONE - not resolved yet" ] } }, "search": { "title": "Keyword search", "type": "string", "description": "Substring match across description, violation type, address, owner and raw status." }, "requireAddress": { "title": "Require a street address", "type": "boolean", "description": "Drop records with no resolvable street address.", "default": false }, "maxResultsPerSource": { "title": "Max results per jurisdiction", "minimum": 1, "type": "integer", "description": "Caps results from each source. Leave empty for no limit." }, "maxResults": { "title": "Max results total", "minimum": 1, "type": "integer", "description": "Hard cap across all sources. Use this to bound cost." }, "includeRawRecord": { "title": "Include raw source record", "type": "boolean", "description": "Attach the original source record under `raw`, so nothing is lost to normalisation.", "default": false }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "A free Socrata app token raises rate limits above the shared anonymous pool. Only worth setting for large sweeps." } } }, "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 } } } } } } } } } }