{ "openapi": "3.0.1", "info": { "title": "CA San Francisco Building Violations (NOV)", "description": "San Francisco building Notices of Violation (public open data, 517k records): the code violation line items behind each notice - category, inspector finding, flagged conditions, parcel block+lot, address, district. Filter by status/category/block+lot/date or aggregate the register.", "version": "0.0", "x-build-id": "zTecpUgiUnL3QUFjt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~ca-sf-violations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-ca-sf-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/j0401~ca-sf-violations/runs": { "post": { "operationId": "runs-sync-j0401-ca-sf-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/j0401~ca-sf-violations/run-sync": { "post": { "operationId": "run-sync-j0401-ca-sf-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": { "mode": { "title": "Mode", "enum": [ "rows", "aggregate" ], "type": "string", "description": "rows = violation items matching your filters (default). aggregate = one count row per group (see groupBy).", "default": "rows" }, "status": { "title": "Status", "enum": [ "", "active", "not active" ], "type": "string", "description": "Notice status. active = still open; not active = resolved/closed (~94% of the register). Blank = any.", "default": "" }, "category": { "title": "Violation category", "type": "string", "description": "Code category (fuzzy): building section, fire section, interior surfaces section, plumbing and electrical section, smoke detection section, sanitation section, security requirements section, lead section. Blank = any.", "default": "" }, "complaintNumber": { "title": "Complaint number", "type": "string", "description": "Exact DBI complaint number (a notice carries several item rows).", "default": "" }, "block": { "title": "Block", "type": "string", "description": "Assessor block (parcel key). Combine with lot to pull one parcel's notices, or to join against the SF building-permit register.", "default": "" }, "lot": { "title": "Lot", "type": "string", "description": "Assessor lot (parcel key).", "default": "" }, "address": { "title": "Address", "type": "string", "description": "Street number or street name, e.g. 'Mission' or '1200'.", "default": "" }, "streetName": { "title": "Street name", "type": "string", "description": "Street name only, e.g. 'Burnett'.", "default": "" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Analysis neighborhood substring, e.g. 'Mission', 'Sunset', 'Twin Peaks'.", "default": "" }, "supervisorDistrict": { "title": "Supervisor district", "type": "string", "description": "SF supervisor district number (1-11).", "default": "" }, "zipcode": { "title": "ZIP code", "type": "string", "description": "ZIP code.", "default": "" }, "filedFrom": { "title": "Filed on or after", "type": "string", "description": "Only notices filed on/after this date (YYYY-MM-DD). Use with filedTo for a window.", "default": "" }, "filedTo": { "title": "Filed before", "type": "string", "description": "Only notices filed before this date (YYYY-MM-DD).", "default": "" }, "workWithoutPermit": { "title": "Work without permit only", "type": "boolean", "description": "When on, returns only items flagged as work performed without a permit.", "default": false }, "unsafeBuilding": { "title": "Unsafe building only", "type": "boolean", "description": "When on, returns only items flagged as an unsafe building condition.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "status", "category", "neighborhood", "supervisorDistrict", "zipcode", "receivingDivision", "assignedDivision" ], "type": "string", "description": "Which dimension to aggregate over. category -> what kind of violation; neighborhood / district -> where; receivingDivision -> which DBI unit handled it.", "default": "status" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed (0 = up to ~10k per run; each record is metered individually, so there is no per-run charge cap). An aggregate has at most a few hundred groups.", "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 } } }, "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 } } } } } } } } } }