{ "openapi": "3.0.1", "info": { "title": "eCFR scraper - search federal regulations, get section text", "description": "eCFR scraper on the official API: search the Electronic Code of Federal Regulations by keyword, CFR title, part or section; one row per hit - hierarchy, heading, citation, version dates, score, snippet, link - optionally the section's full text as plain text. Public domain. $5 per 1,000 rows.", "version": "0.1", "x-build-id": "wiL7LmdLxqlXKfm7V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/retrainmap~ecfr-regulations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-retrainmap-ecfr-regulations", "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/retrainmap~ecfr-regulations/runs": { "post": { "operationId": "runs-sync-retrainmap-ecfr-regulations", "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/retrainmap~ecfr-regulations/run-sync": { "post": { "operationId": "run-sync-retrainmap-ecfr-regulations", "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": { "query": { "title": "Search text", "type": "string", "description": "Optional full-text query (eCFR search syntax; phrases in double quotes). Empty = every section in the given title/part, in CFR order." }, "title": { "title": "CFR title number", "minimum": 1, "maximum": 50, "type": "integer", "description": "Optional CFR title 1-50 (e.g. 20 = Employees' Benefits, 29 = Labor, 34 = Education). Required when part or section is given." }, "part": { "title": "Part", "type": "string", "description": "Optional part number within the title, e.g. 680." }, "section": { "title": "Section", "type": "string", "description": "Optional section number, e.g. 680.410 (the part is taken from it when part is empty)." }, "current_only": { "title": "Current regulations only", "type": "boolean", "description": "On (default): search the eCFR as of the title's up-to-date date, so only sections in force today are returned. Off: search the whole index, which also returns superseded and removed section versions (ends_on set, current=false) that have no current full text.", "default": true }, "fetch_full_text": { "title": "Fetch full section text", "type": "boolean", "description": "When on, the current full text of every section hit (up to max_records) is fetched from the versioner API and written to full_text as plain text, trimmed to 20,000 characters. One extra request per section, so 100 sections take about 2 minutes at the default interval.", "default": false }, "max_records": { "title": "Maximum records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many hits have been written. The search API refuses to page past 10,000 results.", "default": 100 }, "request_interval_ms": { "title": "Minimum interval between requests (ms)", "minimum": 250, "maximum": 10000, "type": "integer", "description": "Politeness delay towards ecfr.gov. Each search request returns up to 100 hits; each full-text request returns one section. The floor is 250 ms.", "default": 1000 }, "contact_email": { "title": "Contact e-mail (From: header)", "type": "string", "description": "Sent in the standard From: request header so the data owner can reach the operator (RFC 9110 s10.1.2).", "default": "info@steelyardclinical.com" } } }, "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 } } } } } } } } } }