bf6b2d5aeaf8111cfd9782b265893c6f14072939 lrnassar Mon Apr 29 13:40:03 2019 -0700 Fixing some word flow/coding conventions on API help page ref#18869 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index b52332a..4b93b8b 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -34,112 +34,126 @@

What is the access URL ?

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:

Endpoint functions to return data

-Use the url: https://api-test.gi.ucsc.edu/ is access +The 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'

Parameters to endpoint functions

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

Required and optional parameters

- - + +
Endpoint functionRequiredOptional
/list/publicHubs(none)(none)
/list/ucscGenomes(none)(none)
/list/hubGenomeshubUrl(none)
/list/tracksgenome or (hubUrl and genome)trackLeavesOnly=1
/list/chromosomesgenome or (hubUrl and genome)track
/getData/sequence(genome or (hubUrl and genome)) and chromstart and end
/getData/track(genome or (hubUrl and genome)) and trackchrom, (start and end), maxItemsOutput, jsonOutputArrays
/getData/sequence(genome or (hubUrl and genome)) and chromstart and +end
/getData/track(genome or (hubUrl and genome)) and trackchrom, +(start and end), maxItemsOutput, jsonOutputArrays

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. +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.

Supported track types, at this time (April 2019), for getData functions