api-ninjas-com Stars API

openapi: 3.2.0
info:
  title: Ninjas Stars API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Stars
  description: The Stars API provides key statistics for thousands of stars discovered in the known universe.
paths:
  /v1/stars:
    get:
      summary: Get a list of stars
      description: Get a list of stars matching specified parameters. Returns at most 30 results. To access more than 30 results, use the offset parameter to offset results in multiple API calls.
      parameters:
      - name: name
        in: query
        description: The name of the star.
        required: false
        schema:
          type: string
      - name: constellation
        in: query
        description: The constellation that the star belongs to.
        required: false
        schema:
          type: string
      - name: min_apparent_magnitude
        in: query
        description: Minimum apparent magnitude brightness of the star.
        required: false
        schema:
          type: number
      - name: max_apparent_magnitude
        in: query
        description: Maximum apparent magnitude brightness of the star.
        required: false
        schema:
          type: number
      - name: min_absolute_magnitude
        in: query
        description: Minimum absolute magnitude brightness of the star.
        required: false
        schema:
          type: number
      - name: max_absolute_magnitude
        in: query
        description: Maximum absolute magnitude brightness of the star.
        required: false
        schema:
          type: number
      - name: min_distance_light_year
        in: query
        description: Minimum distance the star is from Earth in light years.
        required: false
        schema:
          type: number
      - name: max_distance_light_year
        in: query
        description: Maximum distance the star is from Earth in light years.
        required: false
        schema:
          type: number
      - name: offset
        in: query
        description: Number of results to offset for pagination.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: A list of stars
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Star'
        '400':
          $ref: '#/components/responses/StarsOpenapi_BadRequest'
        '401':
          $ref: '#/components/responses/StarsOpenapi_Unauthorized'
        '500':
          $ref: '#/components/responses/StarsOpenapi_InternalServerError'
      security:
      - ApiKeyAuth: []
      tags:
      - Stars
      operationId: getV1Stars
      x-operation-id-source: derived
components:
  schemas:
    Star:
      type: object
      properties:
        name:
          type: string
          description: The name of the star.
        constellation:
          type: string
          description: The constellation that the star belongs to.
        right_ascension:
          type: string
          description: The right ascension of the star.
        declination:
          type: string
          description: The declination of the star.
        apparent_magnitude:
          type: string
          description: The apparent magnitude brightness of the star.
        absolute_magnitude:
          type: string
          description: The absolute magnitude brightness of the star.
        distance_light_year:
          type: string
          description: The distance the star is from Earth in light years.
        spectral_class:
          type: string
          description: The spectral class of the star.
  responses:
    StarsOpenapi_InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    StarsOpenapi_Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    StarsOpenapi_BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api