{ "openapi": "3.0.1", "info": { "title": "US Crime Incidents - 8 agencies, one offence taxonomy", "description": "Police incident data from 8 US agencies (~16.3M records) normalised into one schema, with NIBRS crime-against buckets and explicit provenance for every classification.", "version": "0.1", "x-build-id": "Xk8XcpSYjwVAQc0jU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/formal_sadness_xvx~us-crime-incidents/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-formal_sadness_xvx-us-crime-incidents", "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-crime-incidents/runs": { "post": { "operationId": "runs-sync-formal_sadness_xvx-us-crime-incidents", "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-crime-incidents/run-sync": { "post": { "operationId": "run-sync-formal_sadness_xvx-us-crime-incidents", "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": "Agencies", "type": "array", "description": "Which agencies to fetch. Defaults to all 8.", "items": { "type": "string", "enum": [ "chicago", "austin", "seattle", "dallas", "san_francisco", "montgomery_md", "nyc", "king_county" ], "enumTitles": [ "Chicago, IL (~8.6M) - block address + coords", "Austin, TX (~2.7M) - census block group ONLY, no coords", "Seattle, WA (~1.6M) - NIBRS, block address + coords", "Dallas, TX (~1.5M) - NIBRS, street address, NO coords", "San Francisco, CA (~1.1M) - coords only, NO address", "Montgomery County, MD (~502k) - full street address + coords", "New York City, NY (~280k) - borough/precinct only, has severity", "King County, WA (~158k) - NIBRS, block address, NO coords" ] } }, "occurredAfter": { "title": "Occurred on or after", "type": "string", "description": "Only incidents that occurred on or after this date (YYYY-MM-DD)." }, "occurredBefore": { "title": "Occurred on or before", "type": "string", "description": "Only incidents that occurred on or before this date (YYYY-MM-DD)." }, "crimeAgainst": { "title": "Crime against", "type": "array", "description": "NIBRS crime-against axis. Four sources publish this directly; for the rest it is derived from offence text and flagged as such in crime_against_source.", "items": { "type": "string", "enum": [ "PERSON", "PROPERTY", "SOCIETY", "OTHER", "UNKNOWN" ], "enumTitles": [ "PERSON - assault, homicide, robbery, sex offences", "PROPERTY - theft, burglary, arson, fraud, vandalism", "SOCIETY - drugs, weapons, public order, traffic", "OTHER - non-crime events (missing person, found property)", "UNKNOWN - could not be classified" ] } }, "publishedClassificationOnly": { "title": "Published classifications only", "type": "boolean", "description": "Restrict to records where the agency itself states the crime-against bucket, excluding our derived inferences. Use this when publishing statistics. Limits results to Seattle, Dallas, King County and Montgomery County.", "default": false }, "severity": { "title": "Severity", "type": "array", "description": "Only New York City publishes felony/misdemeanor/violation directly. NIBRS sources report Group A/B instead. Most records are UNKNOWN.", "items": { "type": "string", "enum": [ "FELONY", "MISDEMEANOR", "VIOLATION", "GROUP_A", "GROUP_B", "OTHER", "UNKNOWN" ] } }, "arrestsOnly": { "title": "Arrests only", "type": "boolean", "description": "Only Chicago publishes an arrest flag; this excludes every other source.", "default": false }, "requireCoordinates": { "title": "Require lat/lon", "type": "boolean", "description": "Excludes Austin, Dallas and King County, which publish no coordinates.", "default": false }, "requireAddress": { "title": "Require a street address", "type": "boolean", "description": "Excludes Austin, San Francisco and NYC, which publish no address. Note most sources blur to block level by design.", "default": false }, "search": { "title": "Keyword search", "type": "string", "description": "Case-insensitive substring match across the record's text fields." }, "maxResultsPerSource": { "title": "Max results per agency", "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 } } } } } } } } } }