{ "openapi": "3.0.1", "info": { "title": "Federal Register Rule & Notice Monitor", "description": "Monitor Federal Register rules, proposed rules, and notices with agency/type/CFR filters and structured fields including comment deadlines. FederalRegister.gov is not the official legal edition; verify against govinfo.gov.", "version": "0.1", "x-build-id": "lXCw1aPN9Y5D77qtC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sovereign_workspace~federal-register-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sovereign_workspace-federal-register-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/sovereign_workspace~federal-register-monitor/runs": { "post": { "operationId": "runs-sync-sovereign_workspace-federal-register-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/sovereign_workspace~federal-register-monitor/run-sync": { "post": { "operationId": "run-sync-sovereign_workspace-federal-register-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": { "profile": { "title": "Operator profile", "enum": [ "standard", "smoke" ], "type": "string", "description": "Named config preset applied at start. Any field you set explicitly below overrides the preset." }, "agencies": { "title": "Agencies (slugs)", "type": "array", "description": "FederalRegister.gov agency slugs, e.g. food-and-drug-administration, environmental-protection-agency. The slug is the last part of the agency's URL on federalregister.gov/agencies. Leave empty for all agencies.", "items": { "type": "string" } }, "document_types": { "title": "Document types", "type": "array", "description": "Only these document types. Leave empty for all four.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "enumTitles": [ "Rule", "Proposed rule", "Notice", "Presidential document" ] } }, "cfr_title": { "title": "CFR title", "minimum": 1, "maximum": 50, "type": "integer", "description": "Only documents affecting this CFR title (e.g. 21 for Food and Drugs)." }, "cfr_part": { "title": "CFR part", "type": "string", "description": "Only documents affecting this part of the CFR title above (e.g. 314). Needs CFR title." }, "term": { "title": "Keywords", "type": "string", "description": "Full-text search terms, e.g. tobacco or \"medical device\". Leave empty for everything that matches the other filters." }, "since_days": { "title": "Window (days back)", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days back to search by publication date (1-365).", "default": 7 }, "comment_open_only": { "title": "Open comment periods only", "type": "boolean", "description": "Only documents whose comment period closes today or later.", "default": false }, "only_new": { "title": "Only documents not seen before", "type": "boolean", "description": "Skip documents this same watch (same agencies, types, CFR, keywords) already returned in an earlier run, so overlapping scheduled windows never bill twice. Turn off to get every match in the window.", "default": true }, "limit": { "title": "Max documents", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of documents to return per run.", "default": 100 } } }, "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 } } } } } } } } } }