{ "openapi": "3.0.1", "info": { "title": "Federal Register Documents Scraper by Birds Nest Data", "description": "Export Federal Register rules, proposed rules, notices and comment deadlines as JSON or CSV. Filter by agency and date. Uses the public Federal Register API, no key needed.", "version": "0.1", "x-build-id": "1h8J1VvtyctmIHtAg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/birds-nest-data~federal-register-documents/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-birds-nest-data-federal-register-documents", "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/birds-nest-data~federal-register-documents/runs": { "post": { "operationId": "runs-sync-birds-nest-data-federal-register-documents", "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/birds-nest-data~federal-register-documents/run-sync": { "post": { "operationId": "run-sync-birds-nest-data-federal-register-documents", "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": { "searchTerm": { "title": "Keyword", "type": "string", "description": "Full-text keyword or phrase. Leave empty to get the newest documents.", "default": "" }, "commentsClosingWithinDays": { "title": "Comments closing within (days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "Only documents whose public comment period closes between today and today + N days (U.S. Eastern date). Leave empty to turn off." }, "documentType": { "title": "Document type", "enum": [ "ALL", "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "type": "string", "description": "Limit to one document type, or keep All.", "default": "ALL" }, "agency": { "title": "Agency", "enum": [ "ALL", "agriculture-department", "centers-for-disease-control-and-prevention", "centers-for-medicare-medicaid-services", "coast-guard", "commerce-department", "defense-department", "drug-enforcement-administration", "education-department", "energy-department", "environmental-protection-agency", "executive-office-of-the-president", "federal-aviation-administration", "federal-communications-commission", "federal-emergency-management-agency", "federal-energy-regulatory-commission", "federal-motor-carrier-safety-administration", "federal-reserve-system", "food-and-drug-administration", "foreign-assets-control-office", "foreign-trade-zones-board", "health-and-human-services-department", "homeland-security-department", "housing-and-urban-development-department", "interior-department", "internal-revenue-service", "international-trade-administration", "international-trade-commission", "justice-department", "labor-department", "national-institutes-of-health", "national-oceanic-and-atmospheric-administration", "national-park-service", "nuclear-regulatory-commission", "postal-regulatory-commission", "securities-and-exchange-commission", "small-business-administration", "state-department", "transportation-department", "treasury-department", "veterans-affairs-department" ], "type": "string", "description": "Pick one of the 40 agencies that publish most often, or keep All agencies.", "default": "ALL" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of documents to return (1 to 10,000). Each returned document is one billable result.", "default": 50 }, "publishedFrom": { "title": "Published on or after", "type": "string", "description": "Earliest publication date (YYYY-MM-DD). Leave empty for no lower bound." }, "publishedTo": { "title": "Published on or before", "type": "string", "description": "Latest publication date (YYYY-MM-DD). Leave empty for no upper bound." }, "agencySlug": { "title": "Other agency (slug)", "type": "string", "description": "For an agency not in the list: its slug from the federalregister.gov agency URL, e.g. bureau-of-industry-and-security. Overrides the Agency dropdown." } } }, "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 } } } } } } } } } }