{ "openapi": "3.0.1", "info": { "title": "Federal Register Scraper: Rules, Notices & Executive Orders", "description": "Pull US Federal Register documents for one or many search terms: final and proposed rules, notices and executive orders with agencies, effective dates, comment deadlines, dockets, RINs, CFR parts, full text and PDF links. No proxy. $0.80 per 1,000 documents.", "version": "0.2", "x-build-id": "0Gp3eHt2uJP1cmDj4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidyharvest~federal-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidyharvest-federal-register-scraper", "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/tidyharvest~federal-register-scraper/runs": { "post": { "operationId": "runs-sync-tidyharvest-federal-register-scraper", "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/tidyharvest~federal-register-scraper/run-sync": { "post": { "operationId": "run-sync-tidyharvest-federal-register-scraper", "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": { "mode": { "title": "Mode", "enum": [ "search", "publicInspection" ], "type": "string", "description": "`search` = published documents matching the filters below. `publicInspection` = documents on public inspection right now, i.e. the ones being published in the next business day(s); only the agency, document type and query filters apply.", "default": "search" }, "query": { "title": "Search terms", "type": "string", "description": "Full-text search, same syntax as the FederalRegister.gov search box (e.g. `artificial intelligence`, `\"per- and polyfluoroalkyl\"`, `tariff | duty`). Empty = all documents matching the other filters." }, "queries": { "title": "Several search terms", "type": "array", "description": "Run several full-text searches in one go, each with the filters below (e.g. `artificial intelligence`, `PFAS`, `tariff`). Every row says which term found it; a document found by two terms is returned once.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max documents per search term", "minimum": 1, "type": "integer", "description": "Cap for each search term when you give several. Empty = no per-term cap (only Max documents applies)." }, "agencies": { "title": "Agencies", "type": "array", "description": "Agency names, abbreviations or slugs as listed on federalregister.gov/agencies (e.g. `Environmental Protection Agency`, `EPA`, `food-and-drug-administration`, `SEC`). Matches any.", "items": { "type": "string" } }, "documentTypes": { "title": "Document types", "type": "array", "description": "Which kinds of documents to return. Empty = all types.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "enumTitles": [ "Final rules", "Proposed rules", "Notices", "Presidential documents" ] }, "default": [ "RULE" ] }, "presidentialDocumentTypes": { "title": "Presidential document types", "type": "array", "description": "Narrow presidential documents, e.g. executive orders only. Selecting any adds Presidential documents to the document types.", "items": { "type": "string", "enum": [ "executive_order", "proclamation", "memorandum", "determination", "notice", "presidential_order", "administrative_order", "other" ], "enumTitles": [ "Executive orders", "Proclamations", "Memoranda", "Determinations", "Notices", "Presidential orders", "Administrative orders", "Other" ] } }, "dateFrom": { "title": "Published from", "type": "string", "description": "Publication date on or after (YYYY-MM-DD). Empty = the last 30 days, unless you set a To date, search terms, a docket, a RIN, a CFR part or open-comments-only (then all dates)." }, "dateTo": { "title": "Published to", "type": "string", "description": "Publication date on or before (YYYY-MM-DD). Empty = no upper limit." }, "effectiveFrom": { "title": "Effective on or after", "type": "string", "description": "Only rules whose effective date is on or after this date (YYYY-MM-DD). Handy for upcoming compliance deadlines." }, "significantOnly": { "title": "Significant documents only", "type": "boolean", "description": "Only documents deemed significant under Executive Order 12866 (major economic or policy impact).", "default": false }, "commentsOpenOnly": { "title": "Open for comment only", "type": "boolean", "description": "Only documents whose public comment period closes today or later. Pair with Proposed rules for a list of rulemakings you can still comment on.", "default": false }, "docketId": { "title": "Docket ID", "type": "string", "description": "Agency docket number, e.g. `EPA-HQ-OAR-2021-0317` or `USCG-2026-1270`." }, "regulationIdNumber": { "title": "Regulation Identifier Number (RIN)", "type": "string", "description": "Unified Agenda RIN, e.g. `2060-AV16`." }, "cfr": { "title": "CFR title / part", "type": "string", "description": "Documents affecting a Code of Federal Regulations title or part, e.g. `40 CFR 60` or `21 CFR 101` or just `12`." }, "documentNumbers": { "title": "Document numbers", "type": "array", "description": "Fetch these exact documents by FR document number (e.g. `2026-20902`). When set, all search filters are ignored. Numbers not found are skipped (and not charged).", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Order of results. Empty = relevance when you set search terms, otherwise newest first." }, "includeFullText": { "title": "Include full text", "type": "boolean", "description": "Adds `fullText` (plain text of the whole document, up to 200,000 characters). One extra request per document, so runs are slower; capped at 1,000 documents per run.", "default": false }, "maxItems": { "title": "Max documents", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on results for the run (also caps your cost). The API serves at most 10,000 results per search; split by date range for more.", "default": 50 } } }, "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 } } } } } } } } } }