{ "openapi": "3.0.1", "info": { "title": "Clinicaltrials Gov Scraper", "description": "Scrape ClinicalTrials.gov studies by condition, sponsor, status, or NCT ID. Retrieve comprehensive protocol details, trial sites, and contacts, and easily export your data to CSV, JSON, or Excel.", "version": "0.0", "x-build-id": "gfM1L1sf0YuHZloJJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~clinicaltrials-gov-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-clinicaltrials-gov-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/kawsar~clinicaltrials-gov-scraper/runs": { "post": { "operationId": "runs-sync-kawsar-clinicaltrials-gov-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/kawsar~clinicaltrials-gov-scraper/run-sync": { "post": { "operationId": "run-sync-kawsar-clinicaltrials-gov-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "details" ], "type": "string", "description": "search lists studies that match the filters. details loads one full study record per NCT ID.", "default": "search" }, "condition": { "title": "Condition", "type": "string", "description": "Condition or disease query sent as query.cond. Used in search mode. Example: diabetes.", "default": "diabetes" }, "intervention": { "title": "Intervention", "type": "string", "description": "Drug, device, or other intervention sent as query.intr. Leave blank to skip this filter." }, "sponsor": { "title": "Sponsor", "type": "string", "description": "Lead sponsor or collaborator name sent as query.spons. Leave blank to skip this filter." }, "status": { "title": "Overall status", "type": "array", "description": "Overall status values sent as filter.overallStatus. One value per line. Common values: RECRUITING, NOT_YET_RECRUITING, ACTIVE_NOT_RECRUITING, ENROLLING_BY_INVITATION, COMPLETED, SUSPENDED, TERMINATED, WITHDRAWN. Leave empty to skip the status filter.", "default": [ "RECRUITING" ], "items": { "type": "string" } }, "nctIds": { "title": "NCT IDs", "type": "array", "description": "NCT IDs to load in details mode, one per line. Example: NCT03162237. Ignored in search mode.", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum study rows to save this run. Values above 1000 are clamped to 1000.", "default": 100 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Studies requested per search page. The public API allows at most 1000. The run stops early once maxItems is reached.", "default": 100 }, "timeoutSecs": { "title": "Timeout seconds", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Soft limit for the whole run, in seconds. The actor stops fetching when this time is reached and keeps rows already saved.", "default": 300 }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 1, "maximum": 120, "type": "integer", "description": "Timeout for a single HTTP request, in seconds.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy for requests. Leave Apify Proxy off. The public studies API does not require a proxy, and a proxy must not be used to get around source limits.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }