{ "openapi": "3.0.1", "info": { "title": "Clinical Trial Matcher", "description": "Search ClinicalTrials.gov for parsed eligibility lists, age and sex limit checks and open sites. Registry data, not medical advice. Official API.", "version": "0.1", "x-build-id": "fN3Hgvn2lqL1JeMNv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/a.jonzy~clinical-trial-matcher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-a.jonzy-clinical-trial-matcher", "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/a.jonzy~clinical-trial-matcher/runs": { "post": { "operationId": "runs-sync-a.jonzy-clinical-trial-matcher", "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/a.jonzy~clinical-trial-matcher/run-sync": { "post": { "operationId": "run-sync-a.jonzy-clinical-trial-matcher", "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": { "condition": { "title": "Condition or disease", "type": "string", "description": "For example melanoma, type 2 diabetes or Alzheimer's disease. At least one of condition, intervention or search terms is required." }, "intervention": { "title": "Drug, device or procedure", "type": "string", "description": "For example pembrolizumab. Optional." }, "searchTerms": { "title": "Other search terms", "type": "string", "description": "Free text searched across the whole trial record. Optional." }, "country": { "title": "Country", "type": "string", "description": "Only trials with a site in this country, and only that country's sites in the output. Example: United States. US, USA and UK are expanded." }, "state": { "title": "State or region", "type": "string", "description": "Optional. Example: Texas. Two-letter US codes such as TX are expanded." }, "city": { "title": "City", "type": "string", "description": "Optional. Example: Houston." }, "statuses": { "title": "Recruitment status", "type": "array", "description": "Trial statuses to include. Defaults to the three open statuses: RECRUITING, NOT_YET_RECRUITING, ENROLLING_BY_INVITATION. Other values: ACTIVE_NOT_RECRUITING, COMPLETED, TERMINATED, WITHDRAWN, SUSPENDED, UNKNOWN.", "items": { "type": "string" } }, "phases": { "title": "Phases", "type": "array", "description": "Optional. Any of EARLY_PHASE1, PHASE1, PHASE2, PHASE3, PHASE4, NA.", "items": { "type": "string" } }, "studyType": { "title": "Study type", "enum": [ "any", "INTERVENTIONAL", "OBSERVATIONAL" ], "type": "string", "description": "Interventional trials test a treatment; observational studies do not.", "default": "any" }, "hasResultsOnly": { "title": "Only trials with posted results", "type": "boolean", "description": "Keep only trials that have posted results on ClinicalTrials.gov. Combine with a COMPLETED status.", "default": false }, "patientAge": { "title": "Patient age in years", "minimum": 0, "maximum": 120, "type": "number", "description": "When set, trials whose registered age limits exclude this age are dropped and not billed. Trials with no limit are kept. Use a rough age; do not enter identifying patient data." }, "patientSex": { "title": "Patient sex", "enum": [ "ALL", "FEMALE", "MALE" ], "type": "string", "description": "When set to male or female, trials limited to the other sex are dropped and not billed. This is the registered participant sex, not gender identity.", "default": "ALL" }, "healthyVolunteer": { "title": "Patient is a healthy volunteer", "type": "boolean", "description": "Drops trials that do not accept healthy volunteers. Only applied when patient age or sex is also set.", "default": false }, "onlyWithOpenSite": { "title": "Only trials with an open site in the chosen place", "type": "boolean", "description": "Drop trials with no recruiting or not-yet-recruiting site matching country, state and city.", "default": false }, "includeEligibilityText": { "title": "Include original eligibility text", "type": "boolean", "description": "Adds the registered eligibility criteria text next to the parsed lists.", "default": false }, "includeContacts": { "title": "Include central contacts", "type": "boolean", "description": "Adds the central contact name, phone and email the sponsor registered for enquiries.", "default": false }, "maxItems": { "title": "Maximum trials", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Safety cap on trials returned and billed in one run.", "default": 100 } } }, "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 } } } } } } } } } }