Astronomy API Bodies API

Celestial body information and positions

OpenAPI Specification

astronomy-api-bodies-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Astronomy Bodies 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: Bodies
  description: Celestial body information and positions
paths:
  /bodies:
    get:
      tags:
      - Bodies
      summary: List supported celestial bodies
      security:
      - basicAuth: []
      responses:
        '200':
          description: List of celestial bodies
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /bodies/positions:
    get:
      tags:
      - Bodies
      summary: Get positions of all bodies for an observer
      security:
      - basicAuth: []
      parameters:
      - name: latitude
        in: query
        required: true
        schema:
          type: number
          format: float
      - name: longitude
        in: query
        required: true
        schema:
          type: number
          format: float
      - name: elevation
        in: query
        schema:
          type: number
          format: float
      - name: from_date
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to_date
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: time
        in: query
        required: true
        schema:
          type: string
          examples:
          - '12:00:00'
      - name: output
        in: query
        schema:
          type: string
          enum:
          - rows
          - table
      responses:
        '200':
          description: Body positions
  /bodies/positions/{body}:
    get:
      tags:
      - Bodies
      summary: Get positions of a single body for an observer
      security:
      - basicAuth: []
      parameters:
      - name: body
        in: path
        required: true
        schema:
          type: string
          examples:
          - sun
          - moon
          - mars
      - name: latitude
        in: query
        required: true
        schema:
          type: number
          format: float
      - name: longitude
        in: query
        required: true
        schema:
          type: number
          format: float
      - name: elevation
        in: query
        schema:
          type: number
          format: float
      - name: from_date
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to_date
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: time
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Position data for the body
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)`.

        '