{ "openapi": "3.0.1", "info": { "title": "Regulations.gov Crawler - Rules, Dockets, Public Comments", "description": "Query the official regulations.gov v4 API for federal rules, proposed rules, notices, dockets, and public comments. Filter by agency, document type, docket, date range, and keywords. Requires a free API key.", "version": "1.0", "x-build-id": "C3EqIyR30iGRPSUIa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~regulations-gov-crawler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-regulations-gov-crawler", "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/jungle_synthesizer~regulations-gov-crawler/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-regulations-gov-crawler", "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/jungle_synthesizer~regulations-gov-crawler/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-regulations-gov-crawler", "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": [ "sp_intended_usage", "sp_improvement_suggestions" ], "properties": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "Please describe how you plan to use the data extracted by this crawler." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact Email", "minLength": 1, "type": "string", "description": "Provide your email address so we can get in touch with you." }, "apiKey": { "title": "Regulations.gov API Key", "type": "string", "description": "Your free api.data.gov key. Sign up at https://open.gsa.gov/api/regulationsgov/ (takes ~1 minute). Optional but strongly recommended -- free tier is 1000 requests/hour. Without your own key the actor may hit rate limits quickly." }, "dataType": { "title": "Data Type", "enum": [ "documents", "dockets", "comments" ], "type": "string", "description": "Which regulations.gov endpoint to query. Documents = rules and notices. Dockets = the folders grouping related documents. Comments = public submissions on documents.", "default": "documents" }, "searchTerm": { "title": "Search Term", "type": "string", "description": "Full-text search across titles and abstracts. E.g., 'tariff', 'artificial intelligence', 'climate'. Leave empty for no keyword filter." }, "documentType": { "title": "Document Type (documents only)", "enum": [ "", "Rule", "Proposed Rule", "Notice", "Supporting & Related Material", "Other" ], "type": "string", "description": "Filter documents by type. Ignored for dockets and comments." }, "docketType": { "title": "Docket Type (dockets only)", "enum": [ "", "Rulemaking", "Nonrulemaking" ], "type": "string", "description": "Filter dockets by type. Ignored for documents and comments." }, "agencyId": { "title": "Agency", "type": "string", "description": "Agency acronym (e.g., EPA, FAA, SEC, DOT, FDA, FCC, NRC). Leave empty for all agencies." }, "docketId": { "title": "Docket ID (documents & comments only)", "type": "string", "description": "Filter to a specific docket (e.g., 'EPA-HQ-OAR-2023-0234'). Returns all documents or comments within that docket. Ignored when data type is dockets." }, "postedDateFrom": { "title": "Posted On Or After", "type": "string", "description": "Return records posted on or after this date (YYYY-MM-DD)." }, "postedDateTo": { "title": "Posted On Or Before", "type": "string", "description": "Return records posted on or before this date (YYYY-MM-DD)." }, "sortBy": { "title": "Sort By", "enum": [ "-lastModifiedDate", "lastModifiedDate", "-postedDate", "postedDate", "title" ], "type": "string", "description": "How to sort results.", "default": "-lastModifiedDate" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum records to return. The regulations.gov API caps results at 5,000 per query (20 pages x 250 records). For more, narrow filters and run multiple invocations.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies. Regulations.gov is a government API and does not require proxies." } } }, "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 } } } } } } } } } }