{ "openapi": "3.0.1", "info": { "title": "US Healthcare Exclusions Scraper (HHS-OIG LEIE Screening)", "description": "Screen the HHS-OIG List of Excluded Individuals and Entities (LEIE): US healthcare providers and businesses barred from federal health programs. Filter by name, state, NPI, specialty, exclusion type and date. Clean fields with exclusion reason and dates. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "MtAgI1w0Rx6A01AtY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~hhs-oig-exclusions-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-hhs-oig-exclusions-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/scrapers_lat~hhs-oig-exclusions-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-hhs-oig-exclusions-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/scrapers_lat~hhs-oig-exclusions-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-hhs-oig-exclusions-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": { "names": { "title": "Names to screen", "type": "array", "description": "Optional. Person or business names to match (case-insensitive substring across last, first, middle and business name). List several to screen many parties in one run. Leave empty to browse by state or other filters.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Optional. Two-letter US state codes to include (e.g. CA, TX, FL).", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Optional. City names to include (substring match).", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional. ZIP codes or ZIP prefixes to include.", "items": { "type": "string" } }, "npis": { "title": "NPI numbers", "type": "array", "description": "Optional. National Provider Identifier (NPI) numbers to match exactly.", "items": { "type": "string" } }, "specialties": { "title": "Specialties", "type": "array", "description": "Optional. Provider specialty text to include (substring match, e.g. NURSING, PHARMACY, PHYSICIAN).", "items": { "type": "string" } }, "exclusionTypes": { "title": "Exclusion types", "type": "array", "description": "Optional. Filter by exclusion authority. Use a code (e.g. 1128a1, 1128b4) or words from the reason (e.g. 'license', 'fraud', 'controlled substance').", "items": { "type": "string" } }, "entityType": { "title": "Entity type", "enum": [ "all", "individual", "business" ], "type": "string", "description": "Return individuals, businesses, or both.", "default": "all" }, "excludedSince": { "title": "Excluded since (YYYY-MM-DD)", "type": "string", "description": "Optional. Only include parties excluded on or after this date." }, "excludedUntil": { "title": "Excluded until (YYYY-MM-DD)", "type": "string", "description": "Optional. Only include parties excluded on or before this date." }, "onlyCurrentlyExcluded": { "title": "Only currently excluded", "type": "boolean", "description": "When on, drop parties that have since been reinstated. Turn off to include historical (reinstated) exclusions.", "default": true }, "maxRecords": { "title": "Max Records To Scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of exclusion records to return." } } }, "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 } } } } } } } } } }