Astronomy API Studio API

openapi: 3.1.0
info:
  title: Astronomy Bodies Studio API
  version: '2.0'
  description: 'AstronomyAPI is a web API for retrieving astronomical information

    including celestial body positions, moon phase imagery, star charts,

    astronomical events, and deep space object search for any geographic

    location and date/time combination.

    '
  contact:
    name: AstronomyAPI
    url: https://astronomyapi.com
servers:
- url: https://api.astronomyapi.com/api/v2
  description: Astronomy API v2
tags:
- name: Studio
  description: Generated imagery (moon phase and star charts)
paths:
  /studio/moon-phase:
    post:
      tags:
      - Studio
      summary: Generate a moon phase image
      security:
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                format:
                  type: string
                  enum:
                  - png
                  - svg
                style:
                  type: object
                observer:
                  type: object
                  properties:
                    latitude:
                      type: number
                    longitude:
                      type: number
                    date:
                      type: string
                      format: date
                view:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - portrait-simple
                      - landscape-simple
                    orientation:
                      type: string
                      enum:
                      - north-up
                      - south-up
      responses:
        '200':
          description: Image URL returned in payload
  /studio/star-chart:
    post:
      tags:
      - Studio
      summary: Generate a star chart image
      security:
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                style:
                  type: string
                  enum:
                  - default
                  - inverted
                  - navy
                  - red
                observer:
                  type: object
                  properties:
                    latitude:
                      type: number
                    longitude:
                      type: number
                    date:
                      type: string
                      format: date
                view:
                  type: object
                  description: View type (area or constellation)
      responses:
        '200':
          description: Star chart image URL
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic auth: username is the Application ID and password is the

        Application Secret. The client typically sends

        `Authorization: Basic base64(applicationId:applicationSecret)`.

        '