faf3198f3682f6d9a999bc62908520fa2455ce0d hiram Fri Jul 5 13:21:26 2024 -0700 list/genarkGenomes is no out public yet refs #34045 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index 168ea69..4cf0417 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -103,31 +103,33 @@
The URL https://api.genome.ucsc.edu/ is used to access the endpoint functions. For example:
curl -L 'https://api.genome.ucsc.edu/list/ucscGenomes'
https://api.genome.ucsc.edu/getData/sequence?genome=hg38;chrom=chrM
Endpoint function | Required | Optional |
---|---|---|
/list/publicHubs | (none) | (none) |
/list/ucscGenomes | (none) | (none) |
/list/hubGenomes | hubUrl | (none) |
/list/files | genome | format=text, maxItemsOutput |
/list/tracks | genome or (hubUrl and genome) | trackLeavesOnly=1 |
/list/chromosomes | genome or (hubUrl and genome) | track |
/list/schema | (genome or (hubUrl and genome)) and track | (none) |
/getData/sequence | (genome or (hubUrl and genome)) and chrom | start, end, revComp=1 |
/getData/track | (genome or (hubUrl and genome)) and track | chrom, (start and end), maxItemsOutput, jsonOutputArrays |
/search | search and genome | categories=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.
In order to access the API from a mirror installation or one of the UCSC official mirrors, the complete URL with the cgi-bin should be used:
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.