{ "openapi": "3.0.1", "info": { "title": "NSOPW Offender Search Scraper", "description": "Search U.S. public sex offender records by name, ZIP, or geographic radius from the National Sex Offender Public Website for background checks, public records research, and offender registry access.", "version": "0.1", "x-build-id": "TwxwBA02nnh1XisJ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dromb~nsopw-offender-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dromb-nsopw-offender-search", "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/dromb~nsopw-offender-search/runs": { "post": { "operationId": "runs-sync-dromb-nsopw-offender-search", "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/dromb~nsopw-offender-search/run-sync": { "post": { "operationId": "run-sync-dromb-nsopw-offender-search", "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": { "operation": { "title": "Operation", "enum": [ "probe", "search_filters", "search", "item" ], "type": "string", "description": "Operation to perform: probe, search_filters, search, or item.", "default": "search" }, "firstName": { "title": "First Name", "type": "string", "description": "First name for name search. Requires lastName." }, "lastName": { "title": "Last Name", "type": "string", "description": "Last name for name search. Requires firstName." }, "city": { "title": "City", "type": "string", "description": "Optional city filter for name search." }, "county": { "title": "County", "type": "string", "description": "Optional county filter for name search." }, "zip": { "title": "ZIP Codes", "type": "array", "description": "ZIP code filter (up to 5 values).", "items": { "type": "string" } }, "jurisdictions": { "title": "Jurisdictions", "type": "array", "description": "Jurisdiction codes, e.g. AL, NY, CHEROKEE.", "items": { "type": "string" } }, "latitude": { "title": "Latitude", "type": "number", "description": "Latitude for geographic search (-90 to 90)." }, "longitude": { "title": "Longitude", "type": "number", "description": "Longitude for geographic search (-180 to 180)." }, "distance": { "title": "Distance (miles)", "type": "integer", "description": "Radius in miles for geographic search: 1, 2, or 3." }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum offenders to return (1-500).", "default": 50 }, "includeQueryJurisdictions": { "title": "Include Query Jurisdictions", "type": "boolean", "description": "Include full query.jurisdictions list in response.", "default": false }, "includeJurisdictionStatus": { "title": "Include Jurisdiction Status", "type": "boolean", "description": "Include jurisdiction_status rows in response.", "default": false }, "jurisdictionStatusNonZeroOnly": { "title": "Jurisdiction Status Non-Zero Only", "type": "boolean", "description": "When jurisdiction_status is included, keep only rows with records > 0.", "default": true }, "refresh": { "title": "Refresh Filters", "type": "boolean", "description": "Force refresh of cached filter metadata for search_filters operation.", "default": false }, "offenderUri": { "title": "Offender URI", "type": "string", "description": "Exact offender URL returned by search (for item operation)." }, "offenderId": { "title": "Offender ID", "type": "string", "description": "Offender ID extracted from offender_uri (for item operation)." }, "proxy": { "title": "Proxy Configuration", "enum": [ "direct", "apify", "custom", "auto" ], "type": "string", "description": "Proxy configuration: 'direct', 'apify', 'custom', or 'auto'.", "default": "auto" }, "customProxyUrl": { "title": "Custom Proxy URL", "type": "string", "description": "URL for custom proxy if 'custom' is selected." }, "proxyCountry": { "title": "Proxy Country", "type": "string", "description": "Country for the proxy (e.g., 'US').", "default": "US" } } }, "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 } } } } } } } } } }