d7b4748a91dc6442607af5c9a3c0c9a96282dd53
hiram
Wed Apr 3 14:13:00 2019 -0700
add link to trackDb definition document help refs #18869
diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html
index 3e43bf4..65231a9 100755
--- src/hg/htdocs/goldenPath/help/api.html
+++ src/hg/htdocs/goldenPath/help/api.html
@@ -7,35 +7,30 @@
JSON API data interface
Contents
-
-
-Additional resources
-
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 ?
The gateway html page to the interface is available at
@@ -50,54 +45,54 @@
This access url: https://api-test.gi.ucsc.edu/ is used to access
the endpoint functions. For example:
wget -O- 'https://api-test.gi.ucsc.edu/list/publicHubs'
What type of data can be accessed ?
The following data sets can be accessed at this time:
- Listing of available public hubs
- Listing of available UCSC browser genome assemblies
- List genomes from a specified assembly or track hub
-- List available data tracks from a specified hub or UCSC browser genome assembly
+- List available data tracks from a specified hub or UCSC browser genome assembly (see also: track definition help)
- List of chromosomes contained in an assembly hub or UCSC browser genome assembly.
- List of chromosomes contained in a specific track of an assembly or track hub or UCSC 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
Use the url: https://api-test.gi.ucsc.edu/ is access
the endpoint functions. For example:
wget -O- 'https://api-test.gi.ucsc.edu/list/publicHubs'
- /list/publicHubs - list public hubs
- /list/ucscGenomes - list UCSC database genomes
- /list/hubGenomes - list genomes from specified hub
-- /list/tracks - list data tracks available in specified hub or database genome
+- /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
Parameters to endpoint functions
- hubUrl=<url> - specify track hub or assembly hub URL
- genome=<name> - specify genome assemby in track or assembly hub (only used with hubUrl)
- db=<ucscDb> - specify database (aka genome assembly) in UCSC genome browser (either hubUrl or db specified, not both)
- track=<trackName> - specify data track in hub or UCSC database genome assembly
@@ -143,34 +138,36 @@
the parameter db=<name> is required.
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.
Supported track types, at this time (April 2019), for getData functions
Example data access
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