{ "openapi": "3.0.1", "info": { "title": "US Federal Register Documents", "description": "Federal Register document scraper for US rule and notice research. Export document metadata, source summaries, dates, citations and links as JSON.", "version": "1.0", "x-build-id": "GiqqNNktTTxH5Ln0h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/grit-77~us-federal-register-documents/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-grit-77-us-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/grit-77~us-federal-register-documents/runs": { "post": { "operationId": "runs-sync-grit-77-us-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/grit-77~us-federal-register-documents/run-sync": { "post": { "operationId": "run-sync-grit-77-us-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": { "keyword": { "title": "Keyword or search expression", "type": "string", "description": "Full-text search expression, for example climate or \"clean water\". Leave empty to search without a keyword.", "default": "" }, "agencies": { "title": "Agencies", "type": "array", "description": "Official slugs, full names, abbreviations or numeric ID strings. Examples: environmental-protection-agency, EPA, 145. Multiple agencies match any listed agency. Leave empty for all agencies.", "default": [], "items": { "type": "string" } }, "documentType": { "title": "Document type", "enum": [ "all", "RULE", "PRORULE", "NOTICE", "PRESDOCU" ], "type": "string", "description": "Choose the type of published document.", "default": "all" }, "dateFrom": { "title": "Publication date from", "type": "string", "description": "Inclusive start date in YYYY-MM-DD format. Empty means no start date.", "default": "" }, "dateTo": { "title": "Publication date to", "type": "string", "description": "Inclusive end date in YYYY-MM-DD format. Empty means no end date.", "default": "" }, "order": { "title": "Sort order", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Order of results from the official API. Relevance is most useful with a keyword.", "default": "newest" }, "includeDetails": { "title": "Include document details", "type": "boolean", "description": "Fetch individual document metadata for citations, docket IDs, effective dates, comment deadlines and text links. Does not download document bodies or PDFs.", "default": true }, "maxItems": { "title": "Maximum result rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on document and error rows combined, between 1 and 10,000. Narrow the date range to split larger searches.", "default": 100 }, "concurrency": { "title": "Concurrent detail requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum detail requests in flight; searches are paginated sequentially.", "default": 5 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries after transport failures or HTTP 408, 429, 500, 502, 503 and 504, using bounded backoff and Retry-After.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "Timeout for each source network operation.", "default": 30 } } }, "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 } } } } } } } } } }