{ "openapi": "3.0.1", "info": { "title": "Openfda Food Enforcement", "version": "0.0", "x-build-id": "vdG9Kwje4SlenWqI0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/worthwhile_loblolly~openfda-food-enforcement/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-worthwhile_loblolly-openfda-food-enforcement", "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/worthwhile_loblolly~openfda-food-enforcement/runs": { "post": { "operationId": "runs-sync-worthwhile_loblolly-openfda-food-enforcement", "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/worthwhile_loblolly~openfda-food-enforcement/run-sync": { "post": { "operationId": "run-sync-worthwhile_loblolly-openfda-food-enforcement", "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": { "search": { "title": "Custom Lucene search", "type": "string", "description": "Optional raw openFDA Lucene query. If set, it is combined with the structured filters below using AND. Example: reason_for_recall:allergen" }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text keyword searched across product_description, reason_for_recall, and recalling_firm (OR). Example: peanut OR listeria" }, "classification": { "title": "Classification", "enum": [ "", "Class I", "Class II", "Class III" ], "type": "string", "description": "FDA health-hazard class filter.", "default": "" }, "status": { "title": "Status", "enum": [ "", "Ongoing", "Terminated", "Completed" ], "type": "string", "description": "Recall status filter.", "default": "" }, "recallingFirm": { "title": "Recalling firm", "type": "string", "description": "Filter by recalling company name (phrase match)." }, "state": { "title": "State", "type": "string", "description": "US state code of the recalling firm, e.g. CA, NY, TX." }, "country": { "title": "Country", "type": "string", "description": "Country of the recalling firm, e.g. United States." }, "dateField": { "title": "Date field", "enum": [ "report_date", "recall_initiation_date", "center_classification_date", "termination_date" ], "type": "string", "description": "Which date field the range applies to.", "default": "report_date" }, "dateFrom": { "title": "Date from (YYYYMMDD)", "type": "string", "description": "Inclusive start date as YYYYMMDD, e.g. 20240101. Leave empty for no lower bound." }, "dateTo": { "title": "Date to (YYYYMMDD)", "type": "string", "description": "Inclusive end date as YYYYMMDD, e.g. 20261231. Leave empty for no upper bound." }, "limit": { "title": "Max records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of recall records to return (1–5000). openFDA allows max 1000 per request; this Actor pages automatically.", "default": 100 }, "skip": { "title": "Skip", "minimum": 0, "maximum": 25000, "type": "integer", "description": "Number of matching records to skip before collecting (pagination offset). openFDA max skip is 25000.", "default": 0 }, "sort": { "title": "Sort", "type": "string", "description": "Sort field and direction, e.g. report_date:desc or recall_initiation_date:asc.", "default": "report_date:desc" }, "apiKey": { "title": "openFDA API key (optional)", "type": "string", "description": "Optional free openFDA API key. Without a key: ~40 req/min. With a key: ~240 req/min. Get one at https://open.fda.gov/apis/authentication/" }, "includeRawOpenfda": { "title": "Include raw openfda object", "type": "boolean", "description": "If true, keep the nested openfda object on each output row (usually empty for food enforcement).", "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 } } } } } } } } } }