{ "openapi": "3.0.1", "info": { "title": "Federal Register: Comment Deadlines & Effective Dates", "description": "Track Federal Register comment deadlines and effective dates from the public API. Compare saved snapshots for metadata changes and approaching deadlines. Export an iCalendar file with source document and official PDF links for review.", "version": "0.0", "x-build-id": "JaorRRumOjVwMXGaO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/felixgoldwin~federal-register-deadline-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-felixgoldwin-federal-register-deadline-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/felixgoldwin~federal-register-deadline-monitor/runs": { "post": { "operationId": "runs-sync-felixgoldwin-federal-register-deadline-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/felixgoldwin~federal-register-deadline-monitor/run-sync": { "post": { "operationId": "run-sync-felixgoldwin-federal-register-deadline-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", "properties": { "searchTerm": { "title": "Search term", "type": "string", "description": "Optional Federal Register full-text query (up to 200 characters). Empty searches all documents within the other filters.", "default": "" }, "agencySlugs": { "title": "Agency slugs", "type": "array", "description": "Optional agency URL slugs, e.g. environmental-protection-agency. Maximum 20. See federalregister.gov/agencies. A misspelled but well-formed slug can return no results.", "items": { "type": "string" }, "default": [] }, "documentTypes": { "title": "Document types", "type": "array", "description": "One or more of RULE, PRORULE, NOTICE, PRESDOCU. Defaults to final and proposed rules. Notices may also carry comment dates.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ] }, "default": [ "PRORULE", "RULE" ] }, "publicationLookbackDays": { "title": "Publication lookback days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Inclusive publication window ending at publishedTo or asOfDate. Ignored when publishedFrom is supplied. Older documents with future deadlines are outside this window.", "default": 90 }, "publishedFrom": { "title": "Published from", "type": "string", "description": "Optional inclusive YYYY-MM-DD date, on or after 1994-01-01. Overrides lookback. Leave empty to use the rolling window." }, "publishedTo": { "title": "Published through", "type": "string", "description": "Optional inclusive YYYY-MM-DD date; defaults to asOfDate. Must not be later than asOfDate." }, "significantOnly": { "title": "Significant documents only", "type": "boolean", "description": "Apply the API significant-document filter. Unknown significance remains null in output, rather than being treated as false.", "default": false }, "maxItems": { "title": "Maximum delivered records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on unique delivered and billable records. Runtime also respects the Apify spending cap.", "default": 100 }, "maxRequests": { "title": "Maximum HTTP attempts", "minimum": 1, "maximum": 200, "type": "integer", "description": "Total source HTTP attempts, including retries and redirects.", "default": 20 }, "requestIntervalMs": { "title": "Minimum request interval (ms)", "minimum": 500, "maximum": 60000, "type": "integer", "description": "Sequential requests only; minimum 500 ms between attempts.", "default": 1000 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Timeout for each response including its body.", "default": 30 }, "maxRetries": { "title": "Maximum retries per request", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries only transient network failures, 429, 500, 502, 503 and 504; all count toward maxRequests.", "default": 2 }, "deadlineWindowDays": { "title": "Deadline window (days)", "minimum": 1, "maximum": 730, "type": "integer", "description": "Classify dated deadlines into UTC calendar-day buckets. This does not filter records.", "default": 90 }, "asOfDate": { "title": "As-of date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional YYYY-MM-DD reference for date arithmetic and the Federal Register publication window; defaults to UTC today. This does not retrieve historical source state." }, "previousSnapshot": { "title": "Previous snapshot", "type": "object", "description": "Optional JSON object copied from this Actor’s SNAPSHOT output. Max 2 MiB and 5000 records, same filters. Never paste secrets. Each run uses only the snapshot explicitly supplied." } } }, "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 } } } } } } } } } }