Welcome to the Starglass API’s documentation!

Contents:

• Authentication
  • Example curl command using API key
• Search API
  • The SearchInput object
  • Search Sorting
  • Examples
• Getting information on HCO plates
  • Plate Response Object
• Plate and Jacket Images
  • Accessing Images
  • Available Images
  • Query Parameters
  • Example Queries
• Accessing Mosaics
  • See all available Mosaics
  • Downloading Mosaics

Overview

In order to enable programmatic access to and exploration of the Harvard Plate Stacks data collecion, we provide an API (accessible at https://api.starglass.cfa.harvard.edu/public). The API has formal automatically generated documentation covering all available end points and their inputs and outputs, but narrative description of how to use the tools is missing there. This page is intended to provide explanations and examples of how to use the API. Note that this page is not automatically updated as the API changes, so it may be out of date. Please refer to the automatically generated documentation page for the most up to date information on the API structure.