wwt_api_client: Pythonic access to WorldWide Telescope web services

AAS WorldWide Telescope is a free and powerful visualization engine developed by the American Astronomical Society that can display astronomical and planetary data. This engine is powered by a large (multi-terabyte) collection of astronomical survey data stored in the cloud. The wwt_api_client package allows you to invoke the web APIs that constitute the WWT backend API.

Narrative Documentation

• Installation
  • Try without installing
  • Installing wwt_api_client with conda (recommended)
  • Installing wwt_api_client with pip
  • Installing the developer version

Python API Reference

• wwt_api_client Package
• wwt_api_client.communities Module
• wwt_api_client.constellations Package
• wwt_api_client.constellations.data Module
• wwt_api_client.constellations.handles Module
• wwt_api_client.constellations.images Module
• wwt_api_client.constellations.scenes Module
• wwt_api_client.enums Module

Web Endpoint API Reference

Constellations API endpoints:

• GET /handle/:handle
• PATCH /handle/:handle
• POST /handle/:handle/image
• GET /handle/:handle/imageinfo
• GET /handle/:handle/permissions
• POST /handle/:handle/scene
• GET /handle/:handle/sceneinfo
• GET /handle/:handle/stats
• GET /handle/:handle/timeline
• GET /image/:id
• PATCH /image/:id
• GET /image/:id/img.wtml
• GET /image/:id/permissions
• GET /images/builtin-backgrounds
• POST /images/find-by-legacy-url
• GET /scene/:id
• PATCH /scene/:id
• POST /scene/:id/impressions
• POST /scene/:id/likes
• DELETE /scene/:id/likes
• GET /scene/:id/permissions
• GET /scene/:id/place.wtml
• GET /scenes/home-timeline
• POST /session/init

Legacy WWT APIs:

• WWTWeb/Login.aspx
• WWTWeb/ShowImage.aspx
• WWTWeb/TileImage.aspx

Legacy Communities APIs:

• The Communities service is deprecated and unsupported. See the wwt_api_client.communities module for best-effort implementations of these APIs.

Getting help

If you run into any issues when using wwt_api_client, please open an issue on its GitHub repository.

Acknowledgments

wwt_api_client is part of the AAS WorldWide Telescope system, a .NET Foundation project managed by the non-profit American Astronomical Society (AAS). Work on WWT has been supported by the AAS, the US National Science Foundation (grants 1550701, 1642446, and 2004840), the Gordon and Betty Moore Foundation, and Microsoft.