{ "openapi": "3.0.1", "info": { "title": "FMCSA SAFER Risk Event Monitor", "description": "Watch a book of USDOT numbers and emit typed FMCSA risk events (insurance, OOS, safety rating, SMS BASIC alerts, authority, MCS-150 stale) from official public SAFER / census / Motus open data. Scheduled poll — not real-time. Pay only for unique delivered risk events.", "version": "0.1", "x-build-id": "n8PH9rklAsbqDt77J" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plym-actor-factory~fmcsa-safer-risk-event-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plym-actor-factory-fmcsa-safer-risk-event-monitor", "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/plym-actor-factory~fmcsa-safer-risk-event-monitor/runs": { "post": { "operationId": "runs-sync-plym-actor-factory-fmcsa-safer-risk-event-monitor", "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/plym-actor-factory~fmcsa-safer-risk-event-monitor/run-sync": { "post": { "operationId": "run-sync-plym-actor-factory-fmcsa-safer-risk-event-monitor", "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", "required": [ "usdotNumbers" ], "properties": { "usdotNumbers": { "title": "USDOT numbers (watchlist / book)", "type": "array", "description": "USDOT numbers to monitor (digits only after normalize). Invalid entries are skipped with no charge.", "default": [ "44110", "294837" ], "items": { "type": "string" } }, "signalGroups": { "title": "Signal groups", "type": "array", "description": "Which risk signal groups to evaluate: insurance, oos, safety_rating, sms, authority, mcs150. Default: all.", "default": [ "insurance", "oos", "safety_rating", "sms", "authority", "mcs150" ], "items": { "type": "string" } }, "mcs150StaleMonths": { "title": "MCS-150 stale threshold (months)", "minimum": 6, "maximum": 60, "type": "integer", "description": "Emit MCS150_STALE when the official MCS-150 form date is older than this many months (FMCSA biennial filing is typically 24).", "default": 24 }, "smsAlertPercentile": { "title": "SMS BASIC alert percentile", "minimum": 50, "maximum": 100, "type": "integer", "description": "When QCMobile webKey is set, emit SMS_BASIC_ALERT when a BASIC percentile is at or above this value (or when the API marks alert).", "default": 65 }, "maxRunSeconds": { "title": "Max run seconds", "minimum": 5, "maximum": 300, "type": "integer", "description": "Wall-clock budget for this scheduled poll.", "default": 55 }, "maxEvents": { "title": "Max delivered risk events", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many unique risk events are delivered (does not include RUN_STATUS).", "default": 500 }, "resumeFromCheckpoint": { "title": "Resume from stored checkpoint", "type": "boolean", "description": "If true, resume carrier snapshots, Motus high-water, and seen event_uids from the default Key-Value Store.", "default": true }, "sourceMode": { "title": "Source mode", "enum": [ "fixture", "live" ], "type": "string", "description": "fixture = local/CI / Apify Store daily auto-test default (no network; emits RUN_STATUS only unless emitFixtureDemoEvents=true). live = official FMCSA SAFER / census SODA / Motus open data (+ optional QCMobile).", "default": "fixture" }, "emitFixtureDemoEvents": { "title": "Emit fixture demo risk events", "type": "boolean", "description": "When sourceMode=fixture, if true push fabricated risk events from local fixtures (unit/local demos only). Default false so Store daily auto-tests never emit fake risk events or charge risk-event-delivered. Production: leave false and use sourceMode=live.", "default": false }, "fmcsaQcMobileWebKey": { "title": "FMCSA QCMobile webKey (optional)", "type": "string", "description": "Optional free QCMobile developer webKey for SMS BASIC / structured OOS enrichment. Not required for census, SAFER, or Motus open-data signals. Never logged. Get a key at mobile.fmcsa.dot.gov QCDevsite." }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "minimum": 0, "type": "number", "description": "Optional soft budget hint for delivered risk events. Platform ACTOR_MAX_TOTAL_CHARGE_USD also applies when set." }, "requestPaceMs": { "title": "Request pace (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Minimum delay between outbound official HTTP requests (fair-use pacing).", "default": 400 } } }, "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 } } } } } } } } } }