Clinvar Database API 参考

# ClinVar API 和数据访问参考 ## 概述 ClinVar 提供多种程序化数据访问方法： - **E-utilities** - NCBI 用于搜索和检索数据的 REST API - **Entrez Direct** - 用于 UNIX 环境的命令行工具 - **FTP 下载** - XML、VCF 和制表符分隔格式的批量数据文件 - **提交 API** - 用于提交变异解释的 REST API ## E-utilities API ### 基础 URL https://eutils.ncbi.nlm.nih.gov/entrez/eutils/ ### 支持的操作 #### 1. esearch - 搜索记录 使用与 Web 界面相同的查询语法搜索 ClinVar。 **端点:** https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi **参数:** - `db=clinvar` - 数据库名称 (必填) - `term=` - 搜索查询 (必填) - `retmax=` - 返回的最大记录数 (默认: 20) - `retmode=json` - 返回格式 (json 或 xml) - `usehistory=y` - 为大数据集在服务器上存储结果 **查询示例:** bash # 搜索 BRCA1 致病性变异 curl "https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi?db=clinvar&term=BRCA1[gene]+AND+pathogenic[CLNSIG]&retmode=json&retmax=100" **常用搜索字段:** - `[gene]` - 基因符号 - `[CLNSIG]` - 临床意义 (致病性, 良性等) - `[disorder]` - 疾病/状况名称 - `[variant name]` - HGVS 表达式或变异标识符 - `[chr]` - 染色体编号 - `[Assembly]` - GRCh37 或 GRCh38 #### 2. esummary - 检索记录摘要 获取特定 ClinVar 记录的摘要信息。 **端点:** https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esummary.fcgi **参数:** - `db=clinvar` - 数据库名称 (必填) - `id=` - 以逗号分隔的 ClinVar UID 列表 - `retmode=json` - 返回格式 (json 或 xml) - `version=2.0` - API 版本 (推荐用于 JSON) **示例:** bash # 获取特定变异的摘要 curl "https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esummary.fcgi?db=clinvar&id=12345&retmode=json&version=2.0" **esummary 输出包括:** - 登录号 (RCV/VCV) - 临床意义 - 审查状态 - 基因符号 - 变异类型 - 基因组位置 (GRCh37 和 GRCh38) - 相关疾病 - 等位基因来源 (种系/体细胞) #### 3. efetch - 检索完整记录 下载完整的 XML 记录以进行详细分析。 **端点:** https://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi **参数:** - `db=clinvar` - 数据库名称 (必填) - `id=` - C