{ "openapi": "3.0.1", "info": { "title": "US Doctors Api", "description": "The Doctors.com and healthgrades API lets you search and connect with doctors across the United States. Get access to a complete doctor directory with specialties, locations, insurance, and avail ability. Each doctor profile includes detailed information plus patient reviews and ratings.", "version": "1.0", "x-build-id": "cVqzzcBc4yhQ8I49d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fingolfin~doctor-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fingolfin-doctor-com-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/fingolfin~doctor-com-scraper/runs": { "post": { "operationId": "runs-sync-fingolfin-doctor-com-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/fingolfin~doctor-com-scraper/run-sync": { "post": { "operationId": "run-sync-fingolfin-doctor-com-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", "required": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "search_specialities", "search_locations", "search_insurances", "get_all_languages", "search_doctors", "get_doctor_details", "get_doctor_reviews" ], "type": "string", "description": "Select the scraping action to perform" }, "query": { "title": "Search Query", "type": "string", "description": "Search query string. REQUIRED for search_locations. OPTIONAL for search_specialities and search_insurances (returns all if empty)." }, "location_id": { "title": "Location ID", "type": "string", "description": "REQUIRED for search_doctors. Location ID from search_locations results." }, "location_name": { "title": "Location Name", "type": "string", "description": "REQUIRED for search_doctors. Location name (e.g., 'New York, NY')." }, "speciality": { "title": "Speciality", "type": "string", "description": "OPTIONAL for search_doctors. Medical speciality to filter by." }, "language_spoken": { "title": "Language Spoken", "type": "string", "description": "OPTIONAL for search_doctors. Filter by language spoken." }, "rating": { "title": "Minimum Rating", "enum": [ "", "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "OPTIONAL for search_doctors. Minimum rating filter." }, "board_certified": { "title": "Board Certified", "enum": [ "", "0", "1" ], "type": "string", "description": "OPTIONAL for search_doctors. Filter by board certification." }, "online_scheduling": { "title": "Online Scheduling", "enum": [ "", "0", "1" ], "type": "string", "description": "OPTIONAL for search_doctors. Filter by online scheduling availability." }, "verified": { "title": "Verified Profile", "enum": [ "", "0", "1" ], "type": "string", "description": "OPTIONAL for search_doctors. Filter by verified profiles." }, "distance": { "title": "Distance (miles)", "enum": [ "", "5", "10", "25", "50", "100" ], "type": "string", "description": "OPTIONAL for search_doctors. Search radius in miles." }, "proof_points": { "title": "Minimum Proof Points", "type": "string", "description": "OPTIONAL for search_doctors. Minimum profile proof points (0-100)." }, "profile_id": { "title": "Profile ID", "type": "string", "description": "REQUIRED for get_doctor_details. Doctor profile URL path (e.g., '/Dr-John-Smith-MD')." }, "friendly_url": { "title": "Friendly URL", "type": "string", "description": "REQUIRED for get_doctor_reviews. Doctor's friendly URL slug (e.g., 'Dr-John-Smith')." }, "provider_id": { "title": "Provider ID", "type": "string", "description": "REQUIRED for get_doctor_reviews. Doctor's provider ID (from get_doctor_details)." }, "page": { "title": "Page Number", "minimum": 1, "type": "integer", "description": "OPTIONAL. Page number for paginated results (default: 1).", "default": 1 } } }, "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 } } } } } } } } } }