e398bb02616f4bf19a03fc686f936fc36e50125a lrnassar Mon May 13 15:58:19 2019 -0700 Changing some examples for API #18869 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index 0ab8603..ff661df 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -55,31 +55,31 @@
  • 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.genome.ucsc.edu/ is used to access the endpoint functions. For example:

    -    wget -O- 'https://api.genome.ucsc.edu/list/publicHubs'
    +    curl -L 'https://api.genome.ucsc.edu/list/ucscGenomes'
     

    @@ -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.genome.ucsc.edu/getData/sequence?genome=ce11;chrom=chrM
    +https://api.genome.ucsc.edu/getData/sequence?genome=hg38;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