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 @@
Error return examples

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:

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'
 

@@ -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 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 @@ -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

    1. list public hubs - api.genome.ucsc.edu/list/publicHubs
    2. list UCSC database genomes - api.genome.ucsc.edu/list/ucscGenomes
    3. list genomes from specified hub - api.genome.ucsc.edu/list/hubGenomes?hubUrl=http://genome-test.gi.ucsc.edu/~hiram/hubs/Plants/hub.txt
    4. 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
    5. list tracks from UCSC database genome - api.genome.ucsc.edu/list/tracks?genome=ce11
    6. list chromosomes from UCSC database genome -