openapi: 3.0.3
info:
  title: Rainbow.AI Nowcast Radar API
  description: The Rainbow.AI Nowcast API delivers hyperlocal precipitation forecasts with minute-by-minute predictions for the next 4 hours at 1 km spatial resolution. It returns precipitation type and intensity for any global coordinate, updated every 10 minutes. Authentication is via API key in header or query parameter.
  version: '1.0'
  termsOfService: https://developer.rainbow.ai/terms-of-service
  contact:
    url: https://developer.rainbow.ai/
  x-tags:
  - Weather
  - Nowcast
  - Precipitation
  - Forecasting
servers:
- url: https://api.rainbow.ai/v1
  description: Rainbow.AI Production API
security:
- ApiKeyHeader: []
- ApiKeyQuery: []
tags:
- name: Radar
  description: Real-time radar data operations
paths:
  /weather/radar:
    get:
      operationId: getRadarData
      summary: Get Radar Data
      description: Returns real-time and historical radar data for a specific location, providing precipitation intensity and type information from radar observations.
      tags:
      - Radar
      parameters:
      - name: lat
        in: query
        required: true
        description: Latitude of the location (-90 to 90)
        schema:
          type: number
          format: float
          minimum: -90
          maximum: 90
          example: 40.7128
      - name: lon
        in: query
        required: true
        description: Longitude of the location (-180 to 180)
        schema:
          type: number
          format: float
          minimum: -180
          maximum: 180
          example: -74.006
      responses:
        '200':
          description: Successful radar data response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadarResponse'
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests - rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    RadarPoint:
      type: object
      description: A single radar observation data point
      properties:
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp for this radar observation
        reflectivity:
          type: number
          format: float
          description: Radar reflectivity in dBZ
        precipitation_type:
          type: string
          description: Detected precipitation type
          enum:
          - none
          - rain
          - snow
          - mixed
    Location:
      type: object
      description: Geographic location coordinates
      properties:
        lat:
          type: number
          format: float
          description: Latitude (-90 to 90)
        lon:
          type: number
          format: float
          description: Longitude (-180 to 180)
    RadarResponse:
      type: object
      description: Real-time radar data for a location
      properties:
        location:
          $ref: '#/components/schemas/Location'
        radar_data:
          type: array
          description: Array of radar observations
          items:
            $ref: '#/components/schemas/RadarPoint'
        updated_at:
          type: string
          format: date-time
          description: Timestamp of the last radar update
    ErrorResponse:
      type: object
      description: Error response object
      properties:
        error:
          type: string
          description: Error type identifier
        message:
          type: string
          description: Human-readable error message
        status:
          type: integer
          description: HTTP status code
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: Ocp-Apim-Subscription-Key
      description: API key passed in the Ocp-Apim-Subscription-Key header
    ApiKeyQuery:
      type: apiKey
      in: query
      name: token
      description: API key passed as a token query parameter