{ "openapi": "3.0.1", "info": { "title": "Vitals Scraper", "description": "Automate your search for medical providers with our Vitals.com data aggregator. Get ratings, reviews, specialties, and contact information without manual effort. Perfect for researchers, medical professionals, and patients who need reliable, fast information.", "version": "1.0", "x-build-id": "NA5UL3yOEvyMCU5Gp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~vitals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-vitals-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/parseforge~vitals-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-vitals-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/parseforge~vitals-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-vitals-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": { "startUrl": { "title": "Start URL", "type": "string", "description": "Direct URL to scrape from Vitals.com. Example: https://www.vitals.com/search?sortby=bestmatch&overall_range=any&profile_type=all&gender=all&latLng=40.7396,-74.0007&city_state=New+York,+NY" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 100. Paid users: Optional, max 1,000,000" }, "sortby": { "title": "Sort By", "enum": [ "bestmatch", "distance", "ratings" ], "type": "string", "description": "How to sort the results. 'distance' requires latLng to be provided." }, "overallRange": { "title": "Overall Rating Range", "enum": [ "any", "1", "2", "3", "4", "5" ], "type": "string", "description": "Filter by overall rating range" }, "profileType": { "title": "Profile Type", "enum": [ "all", "physician", "hospital", "practice" ], "type": "string", "description": "Filter by profile type" }, "gender": { "title": "Gender", "enum": [ "all", "male", "female", "non-binary" ], "type": "string", "description": "Filter by gender" }, "cityState": { "title": "City, State", "type": "string", "description": "Location in format: City, State. Example: New York, NY" }, "latLng": { "title": "Latitude, Longitude", "type": "string", "description": "Coordinates in format: latitude,longitude. Example: 40.7396,-74.0007. REQUIRED when using search filters (without startUrl). The API requires this parameter for location-based searches." }, "acceptsNewPatients": { "title": "Accepts New Patients", "type": "boolean", "description": "Filter by whether provider accepts new patients" }, "virtualVisit": { "title": "Virtual Visit", "type": "boolean", "description": "Filter by whether provider offers virtual visits" }, "acceptsMedicare": { "title": "Accepts Medicare", "type": "boolean", "description": "Filter by whether provider accepts Medicare" }, "acceptsMedicaid": { "title": "Accepts Medicaid", "type": "boolean", "description": "Filter by whether provider accepts Medicaid" }, "yearsOfExperienceMin": { "title": "Years of Experience (Min)", "minimum": 0, "maximum": 40, "type": "integer", "description": "Minimum years of experience" }, "yearsOfExperienceMax": { "title": "Years of Experience (Max)", "minimum": 0, "maximum": 40, "type": "integer", "description": "Maximum years of experience" }, "query": { "title": "Search Query", "type": "string", "description": "Additional search query filter" } } }, "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 } } } } } } } } } }