{ "openapi": "3.0.1", "info": { "title": "Federal Register Monitor", "description": "Monitor and search the US Federal Register for rules, proposed rules, notices, and presidential documents. Track comment deadlines, filter by agency, keyword, significance, and more.\nFind and monitor regulatory documents published by US federal agencies.", "version": "0.0", "x-build-id": "WISfEq5LMHHDc8VOD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/teodor_banea~federal-register-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-teodor_banea-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/teodor_banea~federal-register-monitor/runs": { "post": { "operationId": "runs-sync-teodor_banea-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/teodor_banea~federal-register-monitor/run-sync": { "post": { "operationId": "run-sync-teodor_banea-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": { "searchTerm": { "title": "Search term", "maxLength": 500, "type": "string", "description": "Enter a keyword or phrase to search for in document titles and full text." }, "documentTypes": { "title": "Document types", "type": "array", "description": "Select which types of Federal Register documents to include.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "enumTitles": [ "Final Rule", "Proposed Rule", "Notice", "Presidential Document" ] }, "default": [] }, "agencies": { "title": "Agencies", "type": "array", "description": "Filter by agency slug. Find slugs at federalregister.gov/agencies (use the URL path, e.g. 'environmental-protection-agency'). Leave empty for all agencies.", "items": { "type": "string" }, "default": [] }, "dateFrom": { "title": "Published after", "type": "string", "description": "Only include documents published on or after this date." }, "dateTo": { "title": "Published before", "type": "string", "description": "Only include documents published on or before this date." }, "significant": { "title": "Only significant rules", "type": "boolean", "description": "Only include economically significant rules (per Executive Order 12866).", "default": false }, "docketId": { "title": "Docket ID", "type": "string", "description": "Filter by a specific docket ID." }, "regulationIdNumber": { "title": "Regulation ID Number (RIN)", "type": "string", "description": "Filter by a specific Regulation ID Number." }, "monitorMode": { "title": "Enable monitor mode", "type": "boolean", "description": "Automatically set the date range based on 'Look back days'. Ideal for scheduled runs.", "default": false }, "monitorSinceDays": { "title": "Look back days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Number of days to look back from today. Only used when monitor mode is enabled and 'Published after' is not set.", "default": 1 }, "maxResults": { "title": "Maximum results", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Limit the number of results. Set to 0 for unlimited.", "default": 50 }, "onlyOpenComments": { "title": "Only open comment periods", "type": "boolean", "description": "Only return documents that currently have an open public comment period.", "default": false }, "commentDeadlineWithinDays": { "title": "Comment deadline within", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only return documents with comment deadlines closing within this many days. Automatically filters for open comment periods." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to use. Not required for the Federal Register API.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }