Welcome to Helioviewer API V2’s documentation!

The Helioviewer Project maintains a set of Public APIs with the goal of improving access to solar and heliospheric datasets to scientists, educators, developers, and the general public. This site contains descriptions of each API endpoint and examples of usage.

Browse APIs by category using the sidebar, or consult the Appendix for more about the available datasources and working with coordinates.

• API Groups
  • JPEG 2000
    • getJP2Image
      • Example: binary (JPEG2000 image data)
      • Example: string (JPIP link to JP2 Image)
      • Example: JP2 Image (JSON)
    • getJP2Header
      • Example: string (XML)
    • getJPX
      • Example: binary (JPX movie data)
      • Example: string (JPIP link to JPX movie)
      • Example: JPIP JPX Movie (JSON)
      • Example: HTTP JPX Movie (JSON)
    • getJPXClosestToMidPoint
      • Example: binary (JPX movie data)
      • Example: string (JPIP link to JPX movie)
      • Example: JPIP JPX Movie (JSON)
      • Example: HTTP JPX Movie (JSON)
    • getStatus
      • Example: string (JSON)
    • downloadImage
  • Movies
    • queueMovie
      • Example: Queued Movie (JSON)
    • reQueueMovie
      • Example: Queued Movie (JSON)
    • getMovieStatus
      • Example: Movie Status (JSON)
      • Example: Movie Status Verbose (JSON)
    • downloadMovie
      • Example: binary (movie data)
    • playMovie
      • Example: string (HTML)
  • Screenshots
    • takeScreenshot
      • Example: Take Screenshot (JSON)
      • Example: binary (PNG image data)
    • downloadScreenshot
      • Example: binary (PNG image data)
  • Solar Features And Events
    • Events
  • YouTube
    • checkYouTubeAuth
      • Example: string (Boolean)
    • getYouTubeAuth
      • Example: string (HTTP Header redirect)
    • uploadMovieToYouTube
      • Example: YouTube Upload Status
    • getUserVideos
      • Example: string (JSON)
  • Official Clients
    • getClosestImage
      • Example: Get Closest Image (JSON)
    • getDataSources
      • Example: Get Data Sources Verbose (JSON)
    • getTile
      • Example: binary (PNG image data)
    • shortenURL
      • Example: Shortened URL (JSON)
  • Web Site
    • getNewsFeed
      • Example: string (RSS XML)
• Appendix
  • Data Sources
    • SDO
    • SOHO
    • STEREO_A
    • STEREO_B
    • TRACE
    • Yohkoh
    • Hinode
    • MLSO
    • PROBA2
    • SUVI
  • Coordinates
  • Heliovewer Event Format
    • External Links
    • Views
    • Contributing Data to Helioviewer