{ "openapi": "3.0.1", "info": { "title": "SAM.gov Federal Contractor Entity Scraper", "description": "Scrape federal contractor registrations from SAM.gov API. Search by NAICS code, state, business type, certification and more. Extract UEI, CAGE code, business names, addresses, NAICS codes, small business certifications and exclusion status. Requires free SAM.gov API key.", "version": "0.0", "x-build-id": "Rsjr9sgYFin0rpwWg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~sam-gov-federal-contractor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-sam-gov-federal-contractor-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/haketa~sam-gov-federal-contractor-scraper/runs": { "post": { "operationId": "runs-sync-haketa-sam-gov-federal-contractor-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/haketa~sam-gov-federal-contractor-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-sam-gov-federal-contractor-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": { "apiKey": { "title": "SAM.gov API Key", "type": "string", "description": "Your SAM.gov public API key. Get one for free at https://sam.gov — register an account, go to Profile, and generate an API key. Required." }, "registrationStatus": { "title": "Registration Status", "enum": [ "A", "E", "all" ], "type": "string", "description": "Filter by registration status. 'A' = Active only, 'E' = Expired only, 'all' = both.", "default": "A" }, "naicsCode": { "title": "NAICS Code", "type": "string", "description": "Filter by NAICS industry code. Examples: '541330' (Engineering Services), '541512' (Computer Systems Design), '236220' (Commercial Building Construction), '238210' (Electrical Contractors). Leave empty for all industries." }, "stateCode": { "title": "State Code", "type": "string", "description": "Filter by US state code. Examples: 'TX', 'CA', 'VA', 'NY'. Leave empty for all states." }, "city": { "title": "City", "type": "string", "description": "Filter by city name. Example: 'Houston', 'San Francisco'. Leave empty for all cities." }, "businessType": { "title": "Business Type / Certification", "type": "string", "description": "Filter by business type or certification. Examples: 'Small Business', 'Woman Owned Business', 'Veteran Owned Business', 'HUBZone', '8(a)', 'Service Disabled Veteran Owned Business'. Leave empty for all types." }, "excludeExcluded": { "title": "Exclude Debarred Entities", "type": "boolean", "description": "Exclude entities with active exclusions (debarred/suspended from federal contracting).", "default": true }, "registrationDateFrom": { "title": "Registration Date From", "type": "string", "description": "Only return entities registered on or after this date. Format: MM/DD/YYYY. Example: '01/01/2024'. Leave empty for no date filter." }, "registrationDateTo": { "title": "Registration Date To", "type": "string", "description": "Only return entities registered on or before this date. Format: MM/DD/YYYY. Leave empty for no date filter." }, "maxRecords": { "title": "Max Records", "minimum": 0, "type": "integer", "description": "Maximum records to save. SAM.gov sync API supports up to 10,000 records per query. Set 0 for maximum available.", "default": 200 }, "pageSize": { "title": "Page Size", "minimum": 1, "maximum": 10, "type": "integer", "description": "Records per API page. SAM.gov maximum is 10.", "default": 10 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between API requests in milliseconds. SAM.gov has rate limits — keep above 500ms to avoid throttling.", "default": 600 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings." } } }, "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 } } } } } } } } } }