{ "openapi": "3.0.1", "info": { "title": "Federal Register Scraper: Rules, Notices & Orders", "description": "Scrape the Federal Register: final rules, proposed rules, notices, executive orders and the public inspection desk, filtered by keyword, agency, document type and date. Get docket IDs, comment deadlines, PDFs and optional full text. Export CSV, Excel, JSON, XML. No login or API key.", "version": "0.1", "x-build-id": "A8jUevGti9zzXqaAb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/recordsdata~federal-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-recordsdata-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/recordsdata~federal-register-scraper/runs": { "post": { "operationId": "runs-sync-recordsdata-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/recordsdata~federal-register-scraper/run-sync": { "post": { "operationId": "run-sync-recordsdata-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search in the Federal Register, one search per term (for example artificial intelligence, tariff, drone). Leave empty to browse by agency, document type or date only.", "default": [ "artificial intelligence" ], "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of Federal Register documents to return across all searches. Free users are limited to 10 documents (preview). Paid users can request up to 1,000,000.", "default": 10 }, "documentTypes": { "title": "Document types", "type": "array", "description": "Limit results to these Federal Register document types: Final Rules, Proposed Rules, Notices or Presidential Documents (executive orders). Empty means all types.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "enumTitles": [ "Final Rules", "Proposed Rules", "Notices", "Presidential Documents" ] }, "default": [] }, "agencySlugs": { "title": "Agencies (slugs)", "type": "array", "description": "Limit results to specific agencies by slug, for example environmental-protection-agency, securities-and-exchange-commission or federal-aviation-administration. Full list at federalregister.gov/agencies.", "default": [], "items": { "type": "string" } }, "publishedAfter": { "title": "Published after (YYYY-MM-DD)", "type": "string", "description": "Only documents published on or after this date, format YYYY-MM-DD. Leave empty for no lower bound.", "default": "" }, "publishedBefore": { "title": "Published before (YYYY-MM-DD)", "type": "string", "description": "Only documents published on or before this date, format YYYY-MM-DD. Leave empty for no upper bound.", "default": "" }, "significantOnly": { "title": "Significant documents only", "type": "boolean", "description": "Only documents the Federal Register marks as significant (economically significant or otherwise important rules and notices). The flag is returned in the significant column.", "default": false }, "lookbackDays": { "title": "Look back N days", "minimum": 0, "type": "integer", "description": "A friendlier alternative to Published after: only documents published in the last N days. Ignored when Published after is set. 0 means off.", "default": 0 }, "presidentialTypes": { "title": "Presidential document types", "type": "array", "description": "Only presidential documents of these kinds: executive orders, proclamations, memoranda, determinations, notices, other, presidential orders. Executive orders carry executiveOrderNumber and signingDate. Leave empty for no restriction.", "items": { "type": "string", "enum": [ "executive_order", "proclamation", "memorandum", "determination", "notice", "other", "presidential_order" ], "enumTitles": [ "Executive order", "Proclamation", "Memorandum", "Determination", "Notice", "Other", "Presidential order" ] }, "default": [] }, "cfrTitle": { "title": "CFR title", "minimum": 0, "maximum": 50, "type": "integer", "description": "Only documents that amend or cite this Code of Federal Regulations title (1 to 50), for example 40 for environmental protection. 0 means any.", "default": 0 }, "topics": { "title": "Topics", "type": "array", "description": "Only documents tagged with these Federal Register topic slugs, for example energy, environmental-protection or imports. Unknown slugs return no documents.", "default": [], "items": { "type": "string" } }, "sortOrder": { "title": "Sort", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Order of results: newest first, oldest first or by relevance to the search term.", "default": "newest" }, "includePublicInspection": { "title": "Public inspection desk (today's unpublished docs)", "type": "boolean", "description": "Also fetch documents currently on public inspection: filed with the Office of the Federal Register but not yet formally published. Billed as its own event.", "default": false }, "includeFullText": { "title": "Full document text", "type": "boolean", "description": "Fetch the raw full text of each document (first 20,000 characters). One extra request per document, billed as its own event.", "default": false }, "onlyNew": { "title": "Only new results (monitor mode)", "type": "boolean", "description": "Only new results: skip every record this same search already returned in an earlier run, so scheduled runs return just what is new, and you are not charged for skipped records. Max Items then means N new rows.", "default": false }, "stateKey": { "title": "Monitor name (optional)", "type": "string", "description": "Optional label to keep several independent monitors for the same search. Runs that share the same search filters and the same name share one list of seen documents. Leave empty to use the default monitor.", "default": "" }, "resetSeen": { "title": "Reset seen records", "type": "boolean", "description": "Clear the stored list of already-seen documents for this search and monitor name before the run, so every matching document counts as new again.", "default": 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 }, "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 } } } } } } } } } }