Mcw

Rat Genome Database REST API

The RGD REST API provides programmatic access to information and annotation stored in the Rat Genome Database

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The RGD REST API provides programmatic access to information and annotation stored in the Rat Genome Database

Endpoints 100

AGR

  • GETGet affected genomic models (rat strains with gene alleles) submitted by RGD to AGR by taxonId/agr/affectedGenomicModels/:taxonId
  • GETGet gene allele records submitted by RGD to AGR by taxonId/agr/alleles/:taxonId
  • GETGet expression annotations submitted by RGD to AGR by taxonId/agr/expression/:taxonId
  • GETGet phenotype annotations submitted by RGD to AGR by taxonId/agr/phenotypes/:taxonId
  • GETGet basic variant records submitted by RGD to AGR by taxonId/agr/variants/:taxonId
  • GETGet gene records submitted by RGD to AGR by taxonId/agr/:taxonId

Annotation

  • POSTReturn a list of genes annotated to an ontology term/annotations/
  • GETReturns a list ontology term accession IDs annotated to an rgd object/annotations/accId/:rgdId
  • GETReturns annotation count for ontology accession ID/annotations/count/:accId/:includeChildren
  • GETReturns annotation count for ontology accession ID and speicies/annotations/count/:accId/:speciesTypeKey/:includeChildren
  • GETReturns annotation count for ontology accession ID and object type/annotations/count/:accId/:speciesTypeKey/:includeChildren/:objectType
  • GETReturns a list of annotations for a reference/annotations/reference/:refRgdId
  • GETReturns a list of annotations by RGD ID/annotations/rgdId/:rgdId
  • GETReturns a list of annotations by RGD ID and ontology prefix/annotations/rgdId/:rgdId/:ontologyPrefix
  • GETReturns a list of annotations by RGD ID and ontology term accession ID/annotations/:accId/:rgdId
  • GETReturns a list annotations for an ontology term or a term and it's children/annotations/:accId/:speciesTypeKey/:includeChildren

Gene

  • GETReturn a list of genes for an affymetrix ID/genes/affyId/:affyId/:speciesTypeKey
  • GETReturn a list of genes for an alias and species/genes/alias/:aliasSymbol/:speciesTypeKey
  • GETReturn a list of gene alleles/genes/allele/:rgdId
  • POSTReturn a list of genes annotated to an ontology term/genes/annotation
  • GETReturn a list of genes annotated to an ontology term/genes/annotation/:accId
  • GETReturn a list of genes annotated to an ontology term/genes/annotation/:accId/:speciesTypeKey
  • GETReturn a list of genes by keyword and species type key/genes/keyword/:keyword/:speciesTypeKey
  • GETReturn a list of all genes with position information for an assembly/genes/map/:mapKey
  • GETReturn a list of genes position and map key/genes/mapped/:chr/:start/:stop/:mapKey
  • POSTReturn a list of gene orthologs/genes/orthologs
  • GETReturn a list of gene orthologs/genes/orthologs/:rgdId
  • GETReturn a list of genes in region/genes/region/:chr/:start/:stop/:mapKey
  • GETReturn a list of all genes for a species in RGD/genes/species/:speciesTypeKey
  • GETReturn a list of genes position and map key/genes/:chr/:start/:stop/:mapKey
  • GETGet a gene record by RGD ID/genes/:rgdId
  • GETGet a gene record by symbol and species type key/genes/:symbol/:speciesTypeKey

Lookup

  • GETReturns a list of gene types avialable in RGD/lookup/geneTypes
  • POSTTranslate RGD IDs to Ensembl Gene IDs/lookup/id/map/EnsemblGene
  • GETTranslate an RGD ID to an Ensembl Gene ID/lookup/id/map/EnsemblGene/:rgdId
  • POSTTranslate RGD IDs to Ensembl Protein IDs/lookup/id/map/EnsemblProtein
  • GETTranslate an RGD ID to an Ensembl Protein ID/lookup/id/map/EnsemblProtein/:rgdId
  • POSTTranslate RGD IDs to Ensembl Transcript IDs/lookup/id/map/EnsemblTranscript
  • GETTranslate an RGD ID to an Ensembl Transcript ID/lookup/id/map/EnsemblTranscript/:rgdId
  • POSTTranslate RGD IDs to GTEx IDs/lookup/id/map/GTEx
  • GETTranslate an RGD ID to an GTEx ID/lookup/id/map/GTEx/:rgdId
  • POSTTranslate RGD IDs to GenBank Nucleotide IDs/lookup/id/map/GenBankNucleotide
  • GETTranslate an RGD ID to a GenBank Nucleotide ID/lookup/id/map/GenBankNucleotide/:rgdId
  • POSTTranslate RGD IDs to GenBank Protein IDs/lookup/id/map/GenBankProtein
  • GETTranslate an RGD ID to a GenBank Protein ID/lookup/id/map/GenBankProtein/:rgdId
  • POSTTranslate RGD IDs to HGNC IDs/lookup/id/map/HGNC
  • GETTranslate an RGD ID to an HGNC ID/lookup/id/map/HGNC/:rgdId
  • POSTTranslate RGD IDs to MGI IDs/lookup/id/map/MGI
  • GETTranslate an RGD ID to an MGI ID/lookup/id/map/MGI/:rgdId
  • POSTTranslate RGD IDs to NCBI Gene IDs/lookup/id/map/NCBIGene
  • GETTranslate an RGD ID to an NCBI Gene ID/lookup/id/map/NCBIGene/:rgdId
  • POSTTranslate RGD IDs to UniProt IDs/lookup/id/map/UniProt
  • GETTranslate an RGD ID to a UniProt ID/lookup/id/map/UniProt/:rgdId
  • GETReturn a list assembly maps for a species/lookup/maps/:speciesTypeKey
  • GETReturn a Map of species type keys available in RGD/lookup/speciesTypeKeys
  • GETReturn a standardUnit for an ontology if it exists/lookup/standardUnit/:accId

Map

  • GETReturn a list of assemblies/maps/:speciesTypeKey

Ontology

  • GETReturns child and parent terms for Accession ID/ontology/ont/:accId
  • GETReturns true or false for terms/ontology/term/:accId1/:accId2
  • GETReturns term for Accession ID/ontology/term/:accId

Pathway

  • GETReturn a list of pathways based on search term/pathways/diagrams/search/:searchString
  • GETReturn a list of pathways based on category provided/pathways/diagramsForCategory/:category

QTL

  • GETReturns a list QTL for given position and assembly map/qtls/mapped/:chr/:start/:stop/:mapKey
  • GETReturns a list QTL for given position and assembly map/qtls/:chr/:start/:stop/:mapKey
  • GETReturn a QTL for provided RGD ID/qtls/:rgdId

Quantitative Phenotype

  • GETReturn a list of quantitative phenotypes values based on a combination of Clinical Measurement, Experimental Condition, Rat Strain, and/or Measurement Method ontology terms. Results will be all records that match all terms submitted. Ontology ids should be submitted as a comma delimited list (ex. RS:0000029,CMO:0000155,CMO:0000139). Species type is an integer value (3=rat, 4=chinchilla). Reference RGD ID for a study works like a filter./phenotype/phenominer/chart/:speciesTypeKey/:refRgdId/:termString
  • GETReturn a list of quantitative phenotypes values based on a combination of Clinical Measurement, Experimental Condition, Rat Strain, and/or Measurement Method ontology terms. Results will be all records that match all terms submitted. Ontology ids should be submitted as a comma delimited list (ex. RS:0000029,CMO:0000155,CMO:0000139). Species type is an integer value (3=rat, 4=chinchilla)/phenotype/phenominer/chart/:speciesTypeKey/:termString

Rat Strain

  • GETReturn all active strains in RGD/strains/all
  • GETReturn all active strains by position/strains/:chr/:start/:stop/:mapKey
  • GETReturn a strain by RGD ID/strains/:rgdId

SSLP

  • GETReturns a list SSLP for given position and assembly map/sslps/mapped/:chr/:start/:stop/:mapKey

Statistics

  • GETCount of active objects by type, for specified species and date/stats/count/activeObject/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of gene types, for specified species and date/stats/count/geneType/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of objects with given status, for specified species and date/stats/count/objectStatus/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of objects with reference sequence(s), by object type, for specified species and date/stats/count/objectWithRefSeq/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of objects with reference, by object type, for specified species and date/stats/count/objectWithReference/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of objects with external database ids, by database id, for specified species, object type and date/stats/count/objectWithXdb/:speciesTypeKey/:objectKey/:dateYYYYMMDD
  • GETCount of protein interactions, for specified species and date/stats/count/proteinInteraction/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of strains, by qtl inheritance type, for specified species and date/stats/count/qtlInheritanceType/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of retired objects by type, for specified species and date/stats/count/retiredObject/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of strain types, for specified species and date/stats/count/strainType/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of withdrawn objects by type, for specified species and date/stats/count/withdrawnObject/:speciesTypeKey/:dateYYYYMMDD
  • GETCount of external database ids, for specied species and date/stats/count/xdb/:speciesTypeKey/:dateYYYYMMDD
  • GETCount difference of active objects, by type, for specified species and date range/stats/diff/activeObject/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of gene types, for specified species and date range/stats/diff/geneType/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of objects with given status, for specified species and date range/stats/diff/objectStatus/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of objects with reference sequence(s), by object type, for specified species and date range/stats/diff/objectWithRefSeq/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of objects with reference, by object type, for specified species and date range/stats/diff/objectWithReference/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of objects with external database ids, by database id, for specified species, object type and date range/stats/diff/objectWithXdb/:speciesTypeKey/:objectKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of protein interactions, for specified species and date range/stats/diff/proteinInteraction/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of strains, by qtl inheritance type, for specified species and date range/stats/diff/qtlInheritanceType/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of retired objects, by type, for specified species and date range/stats/diff/retiredObject/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of strain types, for specified species and date range/stats/diff/strainType/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of withdrawn objects, by type, for specified species and date range/stats/diff/withdrawnObject/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETCount difference of external database ids, for specified species and date range/stats/diff/xdb/:speciesTypeKey/:dateFromYYYYMMDD/:dateToYYYYMMDD
  • GETgetTermStats/stats/term/:accId/:filterAccId

enrichment-web-service

  • POSTReturn a list of genes annotated to the term.Genes are rgdids separated by comma.Species type is an integer value.term is the ontology/enrichment/annotatedGenes
  • POSTReturn a chart of ontology terms annotated to the genes.Genes are rgdids separated by comma.Species type is an integer value.Aspect is the Ontology group/enrichment/data

Chromosome

  • GETReturn a list of chromosomes/maps/chr/:chromosome/:mapKey
  • GETReturn a list of chromosomes/maps/chr/:mapKey

API details

Authentication
None declared in the description
Operations
100 operations on 100 pathsGET 85POST 15
Main resources
Statistics 25Lookup 24Gene 16Annotation 10AGR 6Map 3Ontology 3QTL 3Rat Strain 3Chromosome 2
Response formats
*/*
Description format
OpenAPI 3.0.0, API version 1.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Rat Genome Database REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Rat Genome Database REST API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get affected genomic models (rat strains with gene alleles) submitted by RGD to AGR by taxonId” (GET /agr/affectedGenomicModels/:taxonId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Rat Genome Database REST API?

The RGD REST API provides programmatic access to information and annotation stored in the Rat Genome Database It is listed under Data & analytics and has 100 endpoints.

Who publishes the Rat Genome Database REST API?

It is listed from Mcw's public API description (an OpenAPI document), not published by Mcw on Swastik Codes. Anyone who controls mcw.edu can claim the profile by adding a DNS TXT record.

How do I authenticate with the Rat Genome Database REST API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Rat Genome Database REST API have?

100 operations on 100 paths (85 GET, 15 POST). The largest groups are Statistics, Lookup, Gene, Annotation.

Is forking the Rat Genome Database REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.