{ "openapi": "3.0.1", "info": { "title": "Fmcsa Carrier Signal Feed", "version": "0.1", "x-build-id": "AhhMbHueNA5X6c5Jh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalserver~fmcsa-carrier-signal-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalserver-fmcsa-carrier-signal-feed", "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/signalserver~fmcsa-carrier-signal-feed/runs": { "post": { "operationId": "runs-sync-signalserver-fmcsa-carrier-signal-feed", "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/signalserver~fmcsa-carrier-signal-feed/run-sync": { "post": { "operationId": "run-sync-signalserver-fmcsa-carrier-signal-feed", "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": { "registeredSinceDays": { "title": "Registered in the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "0 = no recency filter. Set 7-30 for the new-authority feed, which is the high-intent window.", "default": 30 }, "states": { "title": "States", "type": "array", "description": "Two-letter state codes, e.g. TX, GA, FL. Empty = all states.", "items": { "type": "string" } }, "minPowerUnits": { "title": "Min power units", "minimum": 0, "type": "integer", "description": "1 filters out registrations with no trucks. Raise for fleets only.", "default": 1 }, "maxPowerUnits": { "title": "Max power units", "minimum": 0, "type": "integer", "description": "Cap fleet size (e.g. 20 for owner-operators and micro fleets)." }, "requireEmail": { "title": "Only carriers with an email on file", "type": "boolean", "description": "FMCSA publishes a contact email for most carriers.", "default": true }, "carrierOperation": { "title": "Carrier operation", "type": "string", "description": "A = interstate, B = intrastate HM, C = intrastate non-HM. Empty = all." }, "includeAuthority": { "title": "Join operating authority", "type": "boolean", "description": "Adds docket number, common/contract authority status and the cargo classes the carrier is authorised for.", "default": true }, "includeInsurance": { "title": "Join insurance filings", "type": "boolean", "description": "Adds insurer, coverage and cancellation date (the renewal window).", "default": true }, "orderBy": { "title": "Order by", "type": "string", "description": "add_date DESC for newest registrations; dot_number ASC for established carriers.", "default": "add_date DESC" }, "maxResults": { "title": "Max carriers", "minimum": 1, "maximum": 50000, "type": "integer", "description": "How many carriers to return. Start small to check the filters, then scale.", "default": 500 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Not required. Only raises FMCSA rate limits on very large pulls." } } }, "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 } } } } } } } } } }