d7823be63582aafb32001891aafe2573bd550b91
hiram
Fri Mar 22 15:31:47 2019 -0700
help text for API interface refs #18869
diff --git src/hg/htdocs/inc/dataApi.html src/hg/htdocs/inc/dataApi.html
new file mode 100644
index 0000000..09864fb
--- /dev/null
+++ src/hg/htdocs/inc/dataApi.html
@@ -0,0 +1,42 @@
+
JSON data API interface to U.C. Santa Cruz genome browser data
+Data access URL: https://hgwdev-api.ucsc.edu/
+Endpoint functions:
+
+- /list/...
+
+- /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/chromosomes - list chromosomes from specified data track in specified hub or database genome
+
+- /getData/...
+
+- /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
+- db=<ucscDb> - specify database (aka genome assembly) in UCSC genome browser
+- track=<trackName> - specify data track in hub or UCSC database genome assembly
+- chrom=<chrN> - specify chromosome name for sequence or track data
+- start=<123> - specify start coordinate (0 relative) for data from track or sequence retrieval
+- end=<456> - specify end coordinate (1 relative) for data from track or sequence retrieval
+- (see also: UCSC browser coordinate counting systems)
+- maxItemsOutput=1000 - limit number of items to output, default: 1,000, maximum limit: 1,000,000
+
+
+Supported track types, at this time (April 2019), for getData functions:
+
+- bed
+- bigBed
+- bigGenePred
+- bigNarrowPeak
+- bigWig
+- broadPeak
+- narrowPeak
+- wig
+