daab58830afaaff9af3cd658fc0c544b2f151e7f
hiram
Tue May 7 10:55:03 2019 -0700
update to api.genome.ucsc.edu reference refs #18869
diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html
index 2f7f451..5111363 100755
--- src/hg/htdocs/goldenPath/help/api.html
+++ src/hg/htdocs/goldenPath/help/api.html
@@ -21,65 +21,65 @@
What is JSON data ?
JSON data is a data transfer syntax from a data provider to a data consumer.
See also: JSON Introduction
What is the access URL ?
-This access url: https://api-test.gi.ucsc.edu/ is used to access
+This access url: https://api.genome.ucsc.edu/ is used to access
the endpoint functions. For example:
- wget -O- 'https://api-test.gi.ucsc.edu/list/publicHubs'
+ wget -O- 'https://api.genome.ucsc.edu/list/publicHubs'
What type of data can be accessed ?
The following data sets can be accessed at this time:
- List of available public hubs
- List of available UCSC Genome Browser genome assemblies
- List genomes from a specified assembly or track hub
- List available data tracks from a specified hub or UCSC Genome Browser genome assembly
(see also: track definition help)
- List of chromosomes contained in an assembly hub or UCSC Genome Browser genome assembly
- List of chromosomes contained in a specific track of an assembly or track hub, or UCSC Genome
Browser genome assembly
- Return DNA sequence from an assembly hub 2bit file, or UCSC Genome Browser assembly
- Return track data from a specified assembly or track hub, or UCSC Genome Browser assembly
Endpoint functions to return data
-The url https://api-test.gi.ucsc.edu/ is used to access
+The url https://api.genome.ucsc.edu/ is used to access
the endpoint functions. For example:
- wget -O- 'https://api-test.gi.ucsc.edu/list/publicHubs'
+ wget -O- 'https://api.genome.ucsc.edu/list/publicHubs'
- /list/publicHubs - list public hubs
- /list/ucscGenomes - list UCSC Genome Browser database genomes
- /list/hubGenomes - list genomes from specified hub
- /list/tracks - list data tracks available in specified hub or database genome
(see also: track definition help)
- /list/chromosomes - list chromosomes from a data track in specified hub or database
genome
- /getData/sequence - return sequence from specified hub or database genome
- /getData/track - return data from specified track in hub or database genome
@@ -103,31 +103,31 @@
href='http://genome.ucsc.edu/blog/the-ucsc-genome-browser-coordinate-counting-systems/'
target=_blank>UCSC browser coordinate counting systems
maxItemsOutput=1000 - limit number of items to output, default: 1,000, maximum limit:
1,000,000 (use -1 to get maximum output)
trackLeavesOnly=1 - on /list/tracks function, only show tracks, do not show
composite container information
jsonOutputArrays=1 - on /getData/track function, JSON format is array type
for each item of data, instead of the default object type
The parameters are added to the endpoint URL beginning with a
question mark ?, and multiple parameters are separated with
the semi-colon ;. For example:
-https://api-test.gi.ucsc.edu/getData/sequence?genome=ce11;chrom=chrM
+https://api.genome.ucsc.edu/getData/sequence?genome=ce11;chrom=chrM
Required and optional parameters
Endpoint function | Required | Optional |
/list/publicHubs | (none) | (none) |
/list/ucscGenomes | (none) | (none) |
/list/hubGenomes | hubUrl | (none) |
/list/tracks | genome or (hubUrl and genome) | trackLeavesOnly=1 |
/list/chromosomes | genome or (hubUrl and genome) | track |
/getData/sequence | (genome or (hubUrl and genome)) and chrom | start and
@@ -164,30 +164,37 @@
-->
bigNarrowPeak
bigWig
genePred
narrowPeak
psl
rmsk - repeat masker
wig
(Work is under way to support additional track types)
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
- list public hubs -
api.genome.ucsc.edu/list/publicHubs
- list UCSC database genomes -
api.genome.ucsc.edu/list/ucscGenomes
- list genomes from specified hub -
api.genome.ucsc.edu/list/hubGenomes?hubUrl=http://genome-test.gi.ucsc.edu/~hiram/hubs/Plants/hub.txt
- list tracks from specified hub and genome -
api.genome.ucsc.edu/list/tracks?hubUrl=http://genome-test.gi.ucsc.edu/~hiram/hubs/Plants/hub.txt;genome=_araTha1
- list tracks from UCSC database genome -
api.genome.ucsc.edu/list/tracks?genome=ce11
- list chromosomes from UCSC database genome -
|
---|