{ "openapi": "3.0.1", "info": { "title": "Regulation Change Monitor", "description": "Watch the US Federal Register for rules, proposed rules and notices affecting your business. Returns the agency, the action, the CFR parts touched, when comments close and how many days are left, with new documents and moved deadlines flagged each run.", "version": "0.1", "x-build-id": "M1U7IrQxYYCeLs4eP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~regulation-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-regulation-change-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/arched_friend~regulation-change-monitor/runs": { "post": { "operationId": "runs-sync-arched_friend-regulation-change-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/arched_friend~regulation-change-monitor/run-sync": { "post": { "operationId": "run-sync-arched_friend-regulation-change-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", "required": [ "terms" ], "properties": { "terms": { "title": "Subjects to watch", "type": "array", "description": "What you need to hear about, one per line, for example data privacy or food labeling. Multi-word entries are kept together as a phrase.", "items": { "type": "string" } }, "agencySlugs": { "title": "Agencies", "type": "array", "description": "Optional. Agency slugs as federalregister.gov spells them, one per line, for example food-and-drug-administration or environmental-protection-agency.", "items": { "type": "string" } }, "documentTypes": { "title": "Document types", "type": "array", "description": "Proposed rules are where you can still influence the outcome. Rules are final. Leave empty for everything.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "enumTitles": [ "Final rules", "Proposed rules", "Notices", "Presidential documents" ] }, "default": [] }, "lastDays": { "title": "Published in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to search. Keep this short for a scheduled run.", "default": 30 }, "commentsOpenOnly": { "title": "Only where comments are still open", "type": "boolean", "description": "Keep only documents you can still file a comment on. Documents with no comment period at all are dropped by this.", "default": false }, "significantOnly": { "title": "Only significant regulatory actions", "type": "boolean", "description": "Keep only documents the Federal Register explicitly flagged as significant. Most documents carry no flag either way, so this is a narrow filter.", "default": false }, "agencyExcludes": { "title": "Exclude agencies", "type": "array", "description": "Drop documents from agencies whose name contains any of these, one per line.", "items": { "type": "string" } }, "titleExcludes": { "title": "Exclude wording", "type": "array", "description": "Drop documents whose title or abstract contains any of these, one per line.", "items": { "type": "string" } }, "onlyChanged": { "title": "Only new documents and moved deadlines", "type": "boolean", "description": "Return nothing on a quiet run. Turn this on for a scheduled search so you only hear about new documents and comment deadlines that shifted.", "default": false }, "maxResults": { "title": "Maximum documents to return", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most documents to pull in one run, newest first.", "default": 200 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 300, "type": "integer", "description": "How long to wait for a single page of results before giving up on it.", "default": 45 }, "timeBudgetSecs": { "title": "Time budget (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "How long the run may spend paging before it returns what it has. Keeps a scheduled run predictable.", "default": 180 } } }, "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 } } } } } } } } } }