API ReferenceΒΆ

This section provides detailed API documentation for the varvis-connector package.

API Reference:

  • Client
    • VarvisClient
  • Models
    • GenomicPosition
    • VariantSignificance
    • HpoTerm
    • ThresholdSettings
    • BaseHeaderItem
    • CnvHeaderItem
    • SnvAnnotationHeaderItem
    • SnvAnnotationData
    • CnvTargetResults
    • CnvAnnotations
    • CnvRelativesDataItem
    • PendingCnvDataItem
    • PendingCnvData
    • QCCaseMetricResultGroupingKey
    • QCCaseMetricResultDataItem
    • QCCaseMetricResultItem
    • QCCaseMetricResults
    • QCCaseMetricTypeDimension
    • QCCaseMetricType
    • QCCaseMetricThresholdRangeBound
    • QCCaseMetricThresholdRangeCategory
    • QCCaseMetricEnrichmentKitDisabledAnnotationField
    • QCCaseMetricEnrichmentKit
    • QCCaseMetricThresholdRanges
    • QCCaseMetricsData
    • CoverageData
    • AnalysisApproval
    • AnalysisItem
    • FindByInputFileNameAnalysisItem
    • PersonPersonalInformation
    • PersonHpoTermDiseaseModifier
    • PersonHpoTerm
    • PersonDisease
    • PersonClinicalInformation
    • PersonData
    • PersonUpdateData
    • PersonReportItem
    • CaseReportAnnotationSource
    • CaseReportAnalysis
    • CaseReportPersonItem
    • CaseReportDisease
    • CaseReportGene
    • CaseReportCnvConclusion
    • CaseReportSnvConclusion
    • CaseReportConclusion
    • CaseReportAppliedFilter
    • CaseReportVirtualPanelItem
    • CaseReportMethodsItem
    • CaseReport
    • VirtualPanelSummary
    • VarvisGene
    • VirtualPanelData
    • VirtualPanelUpdateData
    • ApiFileLink
    • AnalysisFileDownloadLinks
  • Errors
    • VarvisError

The main components of the API are:

  • Client - The main client class for interacting with the Varvis API

  • Models - Data models used by the client

  • Errors - Custom error classes

varvis-connector

Navigation

  • Introduction
    • Features
    • Currently covered Varvis API endpoints
    • License
  • Installation
    • Requirements
    • Installation
    • Configuration / environment variables
    • Verifying Installation
  • Usage Guide
    • Command-Line Interface (CLI)
      • Basic Usage
      • Global Options
      • Available Commands
      • Details on available commands
      • Command output options
      • Examples
      • Real-World Applications
    • Python API
      • Basic Usage
      • Client Initialization Options
      • Authentication
      • VarvisClient API
  • API Reference
    • Client
    • Models
    • Errors
  • Development
    • Development workflow
    • Initial setup
    • Linting, formatting, type checks (local)
    • Commit preparation
    • Testing
    • Test coverage
    • Preparing a Pull Request
    • Dependency management
    • Security: dependency audit
    • Building the package
    • Building the documentation
    • GitHub Actions workflows (CI, audits, builds and releases)
    • Triggering a package release (tag-based)
    • Varvis API quirks
  • Changelog
    • 0.2.0 - 2026-04-27

Related Topics

  • Documentation overview
    • Previous: Python API
    • Next: Client
©2026, Labor Berlin. | Powered by Sphinx 9.1.0 & Alabaster 1.0.0 | Page source