sunposition-api/openapi.yaml at main · apiverve/sunposition-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
openapi: 3.0.4
info:
  title: Sun Position
  description: >-
    Sun Position is a simple tool for getting sun position data. It returns data
    such as altitude, azimuth, and distance of the sun from the location
    provided.
  termsOfService: https://apiverve.com/terms/
  contact:
    name: APIVerve Support
    email: hello@apiverve.com
    url: https://apiverve.com/contact
  version: 1.0.0
externalDocs:
  description: Learn more about APIVerve
  url: https://docs.apiverve.com?utm_source=openapi
servers:
  - url: https://api.apiverve.com/
paths:
  /v1/sunposition:
    get:
      summary: Get Sun Position Data
      description: Get sun position data based on the location
      operationId: sunposition
      parameters:
        - name: lat
          in: query
          schema:
            type: number
          required: true
          description: The latitude of the location
          example: 37.7749
        - name: lon
          in: query
          schema:
            type: number
          required: true
          description: The longitude of the location
          example: -122.4194
        - name: date
          in: query
          schema:
            type: string
          required: false
          description: The date to get the sun position data for (MM-dd-yyyy)
          example: 01-16-2026
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: status
                  error:
                    type: string
                    description: error
                  data:
                    type: object
                    description: data
              example:
                status: ok
                error: null
                data:
                  date: 01-22-2026
                  time: '14:30'
                  coordinates:
                    latitude: 37.7749
                    longitude: -122.4194
                  sun:
                    altitude: 0.13571365568367633
                    azimuth: 0.9137156885643708
        '401':
          description: Your request was not authorized, or your API Key was invalid
        '404':
          description: Requested resource was not found
        '500':
          description: A server error has occurred, try again later
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
security:
  - api_key: []