{ "openapi": "3.0.1", "info": { "title": "US Federal Register Scraper", "description": "Scrape US Federal Register documents, daily-published rules, proposed rules, notices, executive orders, and presidential documents. Search by term, filter by date / agency / type, fetch by document number. HTTP-only via the public federalregister.gov API.", "version": "1.0", "x-build-id": "PSgeUATfPh2SSBIRS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~federal-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~federal-register-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~federal-register-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byDocumentNumbers", "byAgency" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchTerm": { "title": "Search term", "type": "string", "description": "Free-text search term (mode=search). Searches across title, abstract, and body.", "default": "climate" }, "documentNumbers": { "title": "Document numbers (mode=byDocumentNumbers)", "type": "array", "description": "Federal Register document numbers (e.g. `2024-08901`).", "default": [], "items": { "type": "string" } }, "documentTypes": { "title": "Document types", "type": "array", "description": "Filter by document type. Leave empty for all.", "items": { "type": "string", "enum": [ "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "enumTitles": [ "Final rule", "Proposed rule", "Notice", "Presidential document" ] }, "default": [] }, "agencies": { "title": "Agency slugs", "type": "array", "description": "Filter by agency slug (e.g. `environmental-protection-agency`, `treasury-department`). See https://www.federalregister.gov/agencies for the full list.", "default": [], "items": { "type": "string" } }, "agencySlug": { "title": "Agency slug (mode=byAgency)", "type": "string", "description": "Single agency slug for mode=byAgency. Validated against /api/v1/agencies/. Examples: `environmental-protection-agency`, `treasury-department`, `food-and-drug-administration`." }, "publicationDateGte": { "title": "Publication date from (YYYY-MM-DD)", "type": "string", "description": "Drop documents published before this date." }, "publicationDateLte": { "title": "Publication date to (YYYY-MM-DD)", "type": "string", "description": "Drop documents published after this date." }, "presidentialDocumentTypes": { "title": "Presidential document types", "type": "array", "description": "Optional: filter presidential documents to specific subtypes (e.g. `executive_order`, `proclamation`).", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Order of returned documents.", "default": "newest" }, "fetchFullText": { "title": "Fetch full text body", "type": "boolean", "description": "When true, the actor performs a second request per document to fetch the full body HTML (`body_html_url`) and emits it as `bodyText` (HTML stripped to plain text).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on emitted records.", "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 } } }, "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 } } } } } } } } } }