1a3c324b528c57e4b6211d872a3b4e666b032259 jnavarr5 Mon Apr 14 16:27:03 2025 -0700 Adding function for listing GenArk genomes, refs #32897 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index 743f10d5733..11e3c49ccc5 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -199,66 +199,62 @@ question mark ?, and multiple parameters are separated with the semi-colon ;. For example:
 https://api.genome.ucsc.edu/getData/sequence?genome=hg38;chrom=chrM
 

Required and optional parameters

-
Endpoint functionRequiredOptional
/list/publicHubs(none)(none)
/list/ucscGenomes(none)(none)
/list/hubGenomeshubUrl(none)
/list/filesgenomeformat=text, maxItemsOutput
/list/tracksgenome or (hubUrl and genome)trackLeavesOnly=1
/list/chromosomesgenome or (hubUrl and genome)track
/list/schema(genome or (hubUrl and genome)) and track(none)
/getData/sequence(genome or (hubUrl and genome)) and chromstart, end, revComp=1
/getData/track(genome or (hubUrl and genome)) and trackchrom, (start and end), maxItemsOutput, jsonOutputArrays
/searchsearch and genomecategories=helpDocs, categories=publicHubs, categories=trackDb

The hubUrl and genome parameters are required together to specify a unique genome in an assembly or track hub. The genome for a track hub will usually be a UCSC database genome. Assembly hubs will have their own unique genome sequences. Specify genome without a hubUrl to refer to a UCSC Genome Browser assembly.

Using the chrom=<name> parameter will limit the request to the single specified chromosome. To limit the request to a specific position, both start=4321 and end=5678 must be given together. Using the revComp=1 parameter returns the reverse complement.

-

The /list/files endpoint only works for UCSC hosted genome assemblies, not for external hosted assembly hubs.

Any extra parameters not allowed in a function will be flagged as an error.

Supported track types for getData functions

@@ -327,36 +323,34 @@

Example data access

Your WEB browser can be configured to interpret JSON data and format in a convenient browsing format. Firefox has this function built in, other browsers have add-ons that can be turned on to format JSON data. With your browser thus configured, the following links can demonstrate the functions of the API interface.

Listing functions

  1. list public hubs - api.genome.ucsc.edu/list/publicHubs
  2. list UCSC database genomes - api.genome.ucsc.edu/list/ucscGenomes
  3. - +
  4. list GenArk assembly hub genomes - +api.genome.ucsc.edu/list/genarkGenomes?maxItemsOutput=5
  5. +
  6. test if genome GCF_028858775.2 exists in the GenArk assembly hub genomes - +api.genome.ucsc.edu/list/genarkGenomes?genome=GCF_028858775.2
  7. list genomes from specified hub - api.genome.ucsc.edu/list/hubGenomes?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt
  8. list tracks from specified hub and genome - api.genome.ucsc.edu/list/tracks?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ
  9. list tracks from UCSC database genome - api.genome.ucsc.edu/list/tracks?genome=hg38
  10. list chromosomes from UCSC database genome - api.genome.ucsc.edu/list/chromosomes?genome=hg38
  11. list chromosomes from specified track in UCSC database genome - api.genome.ucsc.edu/list/chromosomes?genome=hg38;track=gold
  12. list chromosomes from assembly hub genome -