{ "openapi": "3.0.1", "info": { "title": "ClinVar Variant Finder", "description": "Search NCBI ClinVar through the official E-utilities API and return one flat row per variant for clinical interpretation and panel annotation.", "version": "0.1", "x-build-id": "64emuFiVwziFls9It" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shayuyuyuyu~clinvar-variant-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shayuyuyuyu-clinvar-variant-finder", "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/shayuyuyuyu~clinvar-variant-finder/runs": { "post": { "operationId": "runs-sync-shayuyuyuyu-clinvar-variant-finder", "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/shayuyuyuyu~clinvar-variant-finder/run-sync": { "post": { "operationId": "run-sync-shayuyuyuyu-clinvar-variant-finder", "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": { "query": { "title": "Search query", "type": "string", "description": "Free-text ClinVar search for a gene, disease, phenotype, or an Entrez expression. Required unless you set gene symbols, rsIDs, HGVS expressions, or ClinVar variation IDs. When you combine this with those lists, each mode is searched and the variants are merged." }, "geneSymbols": { "title": "Gene symbols", "type": "array", "description": "HGNC gene symbols, for example BRCA1 or TP53. Each symbol is searched in the ClinVar gene field and combined with OR.", "items": { "type": "string" }, "default": [] }, "rsids": { "title": "rsIDs", "type": "array", "description": "dbSNP rsIDs, for example rs80357906. A leading rs is optional.", "items": { "type": "string" }, "default": [] }, "hgvs": { "title": "HGVS expressions", "type": "array", "description": "HGVS notations searched against ClinVar variant names, for example NM_007294.4:c.181T>G.", "items": { "type": "string" }, "default": [] }, "clinvarIds": { "title": "ClinVar variation IDs", "type": "array", "description": "ClinVar variation IDs (digits) or VCV accessions, for example 17661 or VCV000017661.", "items": { "type": "string" }, "default": [] }, "clinicalSignificance": { "title": "Clinical significance", "uniqueItems": true, "type": "array", "description": "Optional filter added to every search. Pathogenic, Likely pathogenic, Uncertain significance (VUS), Likely benign, and Benign use ClinVar property terms. Conflicting classifications uses the review-status term for records whose submitters disagree. Leave empty to keep every significance.", "items": { "type": "string", "enum": [ "Pathogenic", "Likely pathogenic", "Uncertain significance", "Likely benign", "Benign", "Conflicting classifications of pathogenicity" ], "enumTitles": [ "Pathogenic", "Likely pathogenic", "Uncertain significance (VUS)", "Likely benign", "Benign", "Conflicting classifications of pathogenicity" ] }, "default": [] }, "maxResults": { "title": "Maximum variants", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of variants to save after duplicates are removed. NCBI chooses the order, usually the most recently indexed matches.", "default": 50 }, "ncbiApiKey": { "title": "NCBI API key", "type": "string", "description": "Optional NCBI E-utilities API key. Without a key the Actor stays near 3 requests per second. With a key it uses about 10 requests per second. The key is sent only to NCBI and is never written to the dataset or the logs. Create one in your NCBI account 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 }, "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 } } } } } } } } } }