{ "openapi": "3.0.1", "info": { "title": "Federal Register Documents Watch", "description": "Scheduled monitor for new or updated Federal Register rules, proposed rules, and notices using the official federalregister.gov API (no API key). Filter by document type, agency slug, search term, CFR title/part, and keywords. Ideal for compliance and regulatory affairs teams.", "version": "0.1", "x-build-id": "wdWbB1B5TLlTWjr8P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/socosupply~federal-register-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-socosupply-federal-register-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/socosupply~federal-register-watch/runs": { "post": { "operationId": "runs-sync-socosupply-federal-register-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/socosupply~federal-register-watch/run-sync": { "post": { "operationId": "run-sync-socosupply-federal-register-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": { "documentTypes": { "title": "Document types", "type": "array", "description": "Federal Register document types to include. Empty = all types in the publication window.", "items": { "type": "string" } }, "agencySlugs": { "title": "Agency slugs", "type": "array", "description": "Agency URL slugs from federalregister.gov (e.g. environmental-protection-agency, food-and-drug-administration). Empty = any agency.", "items": { "type": "string" } }, "searchTerm": { "title": "Full-text search term", "type": "string", "description": "Official Federal Register API term search. Leave empty to rely on type/agency/CFR filters only." }, "cfrTitle": { "title": "CFR title", "type": "integer", "description": "Filter to documents affecting this Code of Federal Regulations title (0 = any).", "default": 0 }, "cfrPart": { "title": "CFR part", "type": "integer", "description": "Filter to documents affecting this CFR part (requires cfrTitle when set; 0 = any part).", "default": 0 }, "keywords": { "title": "Title/abstract keywords", "type": "array", "description": "Additional client-side filter: document title or abstract must contain any of these (case-insensitive).", "items": { "type": "string" } }, "publishedWithinDays": { "title": "Published within (days)", "type": "integer", "description": "Only query documents published within this many days (UTC).", "default": 14 }, "maxResults": { "title": "Max results", "type": "integer", "description": "Stop after pushing this many documents (0 = unlimited).", "default": 0 }, "emitAll": { "title": "Emit all matching documents", "type": "boolean", "description": "If true, push every document matching filters (changeType new, updated, or unchanged). If false, only new or updated since the last run. Prefill enables a sample on first run.", "default": false } } }, "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 } } } } } } } } } }