Skip to content

OpenAPI Generated Python package for interfacing with the Broad Institute GTEx API

Notifications You must be signed in to change notification settings

ccmbioinfo/gtex-openapi

Repository files navigation

gtex-openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Generator version: 7.13.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import gtex_openapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gtex_openapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import gtex_openapi
from gtex_openapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gtex_openapi.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with gtex_openapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gtex_openapi.AdminEndpointsApi(api_client)
    page = 0 # int | The 0-based numeric ID of the page to retrieve (optional) (default to 0)
    items_per_page = 250 # int |  (optional) (default to 250)

    try:
        # Get Maintenance Message
        api_response = api_instance.get_maintenance_message_api_v2_admin_maintenance_message_get(page=page, items_per_page=items_per_page)
        print("The response of AdminEndpointsApi->get_maintenance_message_api_v2_admin_maintenance_message_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminEndpointsApi->get_maintenance_message_api_v2_admin_maintenance_message_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdminEndpointsApi get_maintenance_message_api_v2_admin_maintenance_message_get GET /api/v2/admin/maintenanceMessage Get Maintenance Message
AdminEndpointsApi get_news_item_api_v2_admin_news_item_get GET /api/v2/admin/newsItem Get News Item
BiobankDataEndpointsApi download_api_v2_biobank_download_get GET /api/v2/biobank/download Download
BiobankDataEndpointsApi get_sample_api_v2_biobank_sample_get GET /api/v2/biobank/sample Get Sample
DatasetsEndpointsApi get_annotation_api_v2_dataset_annotation_get GET /api/v2/dataset/annotation Get Annotation
DatasetsEndpointsApi get_collapsed_gene_model_exon_api_v2_dataset_collapsed_gene_model_exon_get GET /api/v2/dataset/collapsedGeneModelExon Get Collapsed Gene Model Exon
DatasetsEndpointsApi get_downloads_page_data_api_v2_dataset_open_access_files_metadata_get GET /api/v2/dataset/openAccessFilesMetadata Get Downloads Page Data
DatasetsEndpointsApi get_file_list_api_v2_dataset_file_list_get GET /api/v2/dataset/fileList Get File List
DatasetsEndpointsApi get_full_get_collapsed_gene_model_exon_api_v2_dataset_full_collapsed_gene_model_exon_get GET /api/v2/dataset/fullCollapsedGeneModelExon Get Full Get Collapsed Gene Model Exon
DatasetsEndpointsApi get_functional_annotation_api_v2_dataset_functional_annotation_get GET /api/v2/dataset/functionalAnnotation Get Functional Annotation
DatasetsEndpointsApi get_linkage_disequilibrium_by_variant_data_api_v2_dataset_ld_by_variant_get GET /api/v2/dataset/ldByVariant Get Linkage Disequilibrium By Variant Data
DatasetsEndpointsApi get_linkage_disequilibrium_data_api_v2_dataset_ld_get GET /api/v2/dataset/ld Get Linkage Disequilibrium Data
DatasetsEndpointsApi get_sample_api_v2_dataset_sample_get GET /api/v2/dataset/sample Get Sample
DatasetsEndpointsApi get_subject_api_v2_dataset_subject_get GET /api/v2/dataset/subject Get Subject
DatasetsEndpointsApi get_tissue_site_detail_api_v2_dataset_tissue_site_detail_get GET /api/v2/dataset/tissueSiteDetail Get Tissue Site Detail
DatasetsEndpointsApi get_variant_api_v2_dataset_variant_get GET /api/v2/dataset/variant Get Variant
DatasetsEndpointsApi get_variant_by_location_api_v2_dataset_variant_by_location_get GET /api/v2/dataset/variantByLocation Get Variant By Location
DynamicAssociationEndpointsApi bulk_calculate_expression_quantitative_trait_loci_api_v2_association_dyneqtl_post POST /api/v2/association/dyneqtl Bulk Calculate Expression Quantitative Trait Loci
DynamicAssociationEndpointsApi calculate_expression_quantitative_trait_loci_api_v2_association_dyneqtl_get GET /api/v2/association/dyneqtl Calculate Expression Quantitative Trait Loci
DynamicAssociationEndpointsApi calculate_ieqtls_api_v2_association_dynieqtl_get GET /api/v2/association/dynieqtl Calculate Ieqtls
DynamicAssociationEndpointsApi calculate_isqtls_api_v2_association_dynisqtl_get GET /api/v2/association/dynisqtl Calculate Isqtls
DynamicAssociationEndpointsApi calculate_splicing_quantitative_trait_loci_api_v2_association_dynsqtl_get GET /api/v2/association/dynsqtl Calculate Splicing Quantitative Trait Loci
ExpressionDataEndpointsApi get_clustered_median_exon_expression_api_v2_expression_clustered_median_exon_expression_get GET /api/v2/expression/clusteredMedianExonExpression Get Clustered Median Exon Expression
ExpressionDataEndpointsApi get_clustered_median_gene_expression_api_v2_expression_clustered_median_gene_expression_get GET /api/v2/expression/clusteredMedianGeneExpression Get Clustered Median Gene Expression
ExpressionDataEndpointsApi get_clustered_median_junction_expression_api_v2_expression_clustered_median_junction_expression_get GET /api/v2/expression/clusteredMedianJunctionExpression Get Clustered Median Junction Expression
ExpressionDataEndpointsApi get_clustered_median_transcript_expression_api_v2_expression_clustered_median_transcript_expression_get GET /api/v2/expression/clusteredMedianTranscriptExpression Get Clustered Median Transcript Expression
ExpressionDataEndpointsApi get_expression_pca_api_v2_expression_expression_pca_get GET /api/v2/expression/expressionPca Get Expression Pca
ExpressionDataEndpointsApi get_gene_expression_api_v2_expression_gene_expression_get GET /api/v2/expression/geneExpression Get Gene Expression
ExpressionDataEndpointsApi get_median_exon_expression_api_v2_expression_median_exon_expression_get GET /api/v2/expression/medianExonExpression Get Median Exon Expression
ExpressionDataEndpointsApi get_median_gene_expression_api_v2_expression_median_gene_expression_get GET /api/v2/expression/medianGeneExpression Get Median Gene Expression
ExpressionDataEndpointsApi get_median_junction_expression_api_v2_expression_median_junction_expression_get GET /api/v2/expression/medianJunctionExpression Get Median Junction Expression
ExpressionDataEndpointsApi get_median_transcript_expression_api_v2_expression_median_transcript_expression_get GET /api/v2/expression/medianTranscriptExpression Get Median Transcript Expression
ExpressionDataEndpointsApi get_single_nucleus_gex_api_v2_expression_single_nucleus_gene_expression_get GET /api/v2/expression/singleNucleusGeneExpression Get Single Nucleus Gex
ExpressionDataEndpointsApi get_single_nucleus_gex_summary_api_v2_expression_single_nucleus_gene_expression_summary_get GET /api/v2/expression/singleNucleusGeneExpressionSummary Get Single Nucleus Gex Summary
ExpressionDataEndpointsApi get_top_expressed_genes_api_v2_expression_top_expressed_gene_get GET /api/v2/expression/topExpressedGene Get Top Expressed Genes
GTExPortalAPIInfoApi get_service_info_api_v2_get GET /api/v2/ Get Service Info
HistologyEndpointsApi get_image_api_v2_histology_image_get GET /api/v2/histology/image Get Image
MetadataEndpointsApi get_dataset_info_api_v2_metadata_dataset_get GET /api/v2/metadata/dataset Get Dataset Info
ReferenceGenomeEndpointsApi get_exons_api_v2_reference_exon_get GET /api/v2/reference/exon Get Exons
ReferenceGenomeEndpointsApi get_gene_search_api_v2_reference_gene_search_get GET /api/v2/reference/geneSearch Get Gene Search
ReferenceGenomeEndpointsApi get_genes_api_v2_reference_gene_get GET /api/v2/reference/gene Get Genes
ReferenceGenomeEndpointsApi get_genomic_features_api_v2_reference_features_feature_id_get GET /api/v2/reference/features/{featureId} Get Genomic Features
ReferenceGenomeEndpointsApi get_gwas_catalog_by_location_api_v2_reference_gwas_catalog_by_location_get GET /api/v2/reference/gwasCatalogByLocation Get Gwas Catalog By Location
ReferenceGenomeEndpointsApi get_neighbor_gene_api_v2_reference_neighbor_gene_get GET /api/v2/reference/neighborGene Get Neighbor Gene
ReferenceGenomeEndpointsApi get_transcripts_api_v2_reference_transcript_get GET /api/v2/reference/transcript Get Transcripts
StaticAssociationEndpointsApi get_eqtl_genes_api_v2_association_egene_get GET /api/v2/association/egene Get Eqtl Genes
StaticAssociationEndpointsApi get_fine_mapping_api_v2_association_fine_mapping_get GET /api/v2/association/fineMapping Get Fine Mapping
StaticAssociationEndpointsApi get_independent_eqtl_api_v2_association_independent_eqtl_get GET /api/v2/association/independentEqtl Get Independent Eqtl
StaticAssociationEndpointsApi get_multi_tissue_eqtls_api_v2_association_metasoft_get GET /api/v2/association/metasoft Get Multi Tissue Eqtls
StaticAssociationEndpointsApi get_significant_single_tissue_eqtls_api_v2_association_single_tissue_eqtl_get GET /api/v2/association/singleTissueEqtl Get Significant Single Tissue Eqtls
StaticAssociationEndpointsApi get_significant_single_tissue_eqtls_by_location_api_v2_association_single_tissue_eqtl_by_location_get GET /api/v2/association/singleTissueEqtlByLocation Get Significant Single Tissue Eqtls By Location
StaticAssociationEndpointsApi get_significant_single_tissue_ieqtls_api_v2_association_single_tissue_i_eqtl_get GET /api/v2/association/singleTissueIEqtl Get Significant Single Tissue Ieqtls
StaticAssociationEndpointsApi get_significant_single_tissue_isqtls_api_v2_association_single_tissue_i_sqtl_get GET /api/v2/association/singleTissueISqtl Get Significant Single Tissue Isqtls
StaticAssociationEndpointsApi get_significant_single_tissue_sqtls_api_v2_association_single_tissue_sqtl_get GET /api/v2/association/singleTissueSqtl Get Significant Single Tissue Sqtls
StaticAssociationEndpointsApi get_sqtl_genes_api_v2_association_sgene_get GET /api/v2/association/sgene Get Sqtl Genes

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

About

OpenAPI Generated Python package for interfacing with the Broad Institute GTEx API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published