{ "openapi": "3.0.1", "info": { "title": "FMCSA Carrier Lookup & Authority Watch", "description": "Look up a US motor carrier by USDOT, MC/MX/FF docket, or name and state, and watch authority, insurance, revocation, and out-of-service changes. Not affiliated with FMCSA.", "version": "0.1", "x-build-id": "rQIjQA4sxlJ9GmWBu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mikee368~fmcsa-carrier-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mikee368-fmcsa-carrier-watch", "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/mikee368~fmcsa-carrier-watch/runs": { "post": { "operationId": "runs-sync-mikee368-fmcsa-carrier-watch", "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/mikee368~fmcsa-carrier-watch/run-sync": { "post": { "operationId": "run-sync-mikee368-fmcsa-carrier-watch", "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": [ "lookup", "newCarriers", "watch" ], "type": "string", "description": "lookup = carriers you name by USDOT, MC/MX/FF docket, or legal/DBA name. newCarriers = carriers added to the FMCSA census on or after Since. watch = authority, insurance, revocation, and out-of-service changes since the last run with the same Watchlist ID.", "default": "lookup" }, "dotNumbers": { "title": "USDOT numbers", "type": "array", "description": "USDOT numbers to look up or watch. Leading zeros are ignored.", "items": { "type": "string" } }, "mcNumbers": { "title": "MC, MX, or FF docket numbers", "type": "array", "description": "Docket numbers such as MC1760297 or MC-1760297. Resolved to a USDOT, then looked up the same way.", "items": { "type": "string" } }, "name": { "title": "Legal or DBA name", "type": "string", "description": "Case-insensitive match against the census legal name and DBA. Use with States to keep the search small." }, "states": { "title": "States", "type": "array", "description": "Two-letter physical states. Used by name search and by new-carrier search. Empty means all states.", "items": { "type": "string" } }, "since": { "title": "Added on or after", "type": "string", "description": "New-carrier mode only. Census add date (YYYY-MM-DD). Empty means the last 30 days." }, "carrierOperation": { "title": "Carrier operation", "enum": [ "", "A", "B", "C" ], "type": "string", "description": "New-carrier filter. A = interstate, B = intrastate hazmat, C = intrastate non-hazmat. Empty means all.", "default": "" }, "minPowerUnits": { "title": "Minimum power units", "minimum": 0, "type": "integer", "description": "New-carrier filter. 0 means no minimum.", "default": 0 }, "entityType": { "title": "Entity type", "enum": [ "", "carrier", "broker", "freightForwarder" ], "type": "string", "description": "New-carrier filter on the census carrier/shipper code. Empty means all.", "default": "" }, "watchlistId": { "title": "Watchlist ID", "type": "string", "description": "Name of the saved watch snapshot. Use different IDs for different lists. The snapshot is one gzipped record in the key-value store fmcsa-watch-state.", "default": "default" }, "alertOn": { "title": "Alert on", "type": "array", "description": "Watch mode only. Which changes to emit: authority, insurance, revocation, oos, name, address, phone.", "default": [ "authority", "insurance", "revocation", "oos", "name", "address", "phone" ], "items": { "type": "string" } }, "includeContacts": { "title": "Include phone, email, and officers", "type": "boolean", "description": "Off by default. When on, census phone, email, and company officer names are added to carrier rows. Watch mode can still alert on phone changes without putting the phone on every carrier row.", "default": false }, "socrataAppToken": { "title": "Socrata app token", "type": "string", "description": "Optional token from data.transportation.gov. Leave empty to use the shared unauthenticated pool, which can be throttled." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum carrier rows or change alerts pushed in this run (1-500).", "default": 25 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }