{ "openapi": "3.0.1", "info": { "title": "Federal Audit Clearinghouse API", "description": "Filter and export official FAC single-audit submissions, auditees, auditors, federal awards, findings, and corrective-action records.", "version": "0.1", "x-build-id": "SDhIv5UBXvGb9yBba" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~federal-audit-clearinghouse-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-federal-audit-clearinghouse-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/automation-lab~federal-audit-clearinghouse-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-federal-audit-clearinghouse-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/automation-lab~federal-audit-clearinghouse-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-federal-audit-clearinghouse-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", "properties": { "recordTypes": { "title": "Record types", "minItems": 1, "uniqueItems": true, "type": "array", "description": "FAC record collections to export. The maximum item count applies across all selected types in this order.", "items": { "type": "string", "enum": [ "audits", "federalAwards", "findings", "findingDetails", "correctiveActions", "secondaryAuditors" ], "enumTitles": [ "Audit submissions and primary parties", "Federal awards", "Audit findings", "Finding text", "Corrective action plans", "Secondary auditors" ] }, "default": [ "audits" ] }, "reportIds": { "title": "FAC report IDs", "maxItems": 100, "type": "array", "description": "Optional exact FAC report IDs, such as 2023-01-GSAFAC-0000000854.", "items": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-GSAFAC-[0-9]{10}$" } }, "auditYears": { "title": "Audit years", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Optional audit years. Leave empty to include every year in the current GSA FAC dataset (2016 onward).", "items": { "type": "integer", "minimum": 2016, "maximum": 2027 } }, "states": { "title": "Auditee states", "maxItems": 100, "type": "array", "description": "Two-letter US state or territory codes. For related records, the Actor first resolves matching submissions.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" } }, "entityTypes": { "title": "Entity types", "uniqueItems": true, "type": "array", "description": "Optional auditee organization types.", "items": { "type": "string", "enum": [ "state", "local", "tribal", "higher-ed", "non-profit", "unknown" ], "enumTitles": [ "State government", "Local government", "Tribal organization", "Higher education", "Non-profit", "Unknown" ] } }, "auditeeUeis": { "title": "Auditee UEIs", "maxItems": 100, "type": "array", "description": "Optional exact 12-character Unique Entity Identifiers.", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{12}$" } }, "auditeeName": { "title": "Auditee name contains", "minLength": 2, "maxLength": 100, "type": "string", "description": "Case-insensitive organization-name text filter. For related records, matching report IDs are resolved first." }, "acceptedFrom": { "title": "Accepted on or after", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Only records accepted by FAC on or after this date." }, "acceptedTo": { "title": "Accepted on or before", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Only records accepted by FAC on or before this date." }, "minTotalAmountExpended": { "title": "Minimum federal amount expended", "minimum": 0, "type": "number", "description": "Minimum total federal expenditures on an audit submission, in USD. Related records are joined through matching report IDs." }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum total dataset records to save across all selected record types.", "default": 100 }, "apiKey": { "title": "Data.gov API key (optional)", "type": "string", "description": "Optional free Data.gov API key for a private request quota. If the shared key is rate limited, the Actor automatically uses FAC's anonymous search and report workbooks." } } }, "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 } } } } } } } } } }