Solcast API — Live Data

naftiko: 1.0.0-alpha2
info:
  label: Solcast API — Live Data
  description: 'Solcast API — Live Data. 5 operations. Lead operation: Get Live Advanced PV Power. Self-contained Naftiko
    capability covering one Solcast business surface.'
  tags:
  - Solcast
  - Live Data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SOLCAST_API_KEY: SOLCAST_API_KEY
capability:
  consumes:
  - type: http
    namespace: solcast-live-data
    baseUri: https://api.solcast.com.au
    description: Solcast API — Live Data business capability. Self-contained, no shared references.
    resources:
    - name: data-live-advanced_pv_power
      path: /data/live/advanced_pv_power
      operations:
      - name: getliveadvancedpvpower
        method: GET
        description: Get Live Advanced PV Power
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resource_id
          in: query
          type: string
          description: Unique resource identifier for a registered Solcast PV power site.
          required: true
        - name: output_parameters
          in: query
          type: string
          description: Comma-separated list of output parameters.
        - name: period
          in: query
          type: string
          description: Time period between data points in ISO 8601 duration format.
        - name: format
          in: query
          type: string
          description: Response format.
    - name: data-live-radiation_and_weather
      path: /data/live/radiation_and_weather
      operations:
      - name: getliveradiationandweather
        method: GET
        description: Get Live Radiation and Weather
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: latitude
          in: query
          type: number
          description: Latitude in decimal degrees, between -90 and 90 (north positive).
          required: true
        - name: longitude
          in: query
          type: number
          description: Longitude in decimal degrees, between -180 and 180 (east positive).
          required: true
        - name: output_parameters
          in: query
          type: string
          description: Comma-separated list of output parameters to return (e.g., ghi,dni,dhi,air_temp, wind_speed_10m,cloud_opacity,clearsky_ghi).
          required: true
        - name: period
          in: query
          type: string
          description: Time period between data points in ISO 8601 duration format (e.g., PT5M for 5 minutes, PT30M for 30
            minutes, PT60M for 60 minutes).
        - name: format
          in: query
          type: string
          description: Response format. Defaults to json.
    - name: data-live-rooftop_pv_power
      path: /data/live/rooftop_pv_power
      operations:
      - name: getliverooftoppvpower
        method: GET
        description: Get Live Rooftop PV Power
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: latitude
          in: query
          type: number
          description: Latitude in decimal degrees, between -90 and 90 (north positive).
          required: true
        - name: longitude
          in: query
          type: number
          description: Longitude in decimal degrees, between -180 and 180 (east positive).
          required: true
        - name: capacity
          in: query
          type: number
          description: System capacity in kilowatts.
        - name: tilt
          in: query
          type: number
          description: Panel tilt angle in degrees from horizontal (0 = flat, 90 = vertical).
        - name: azimuth
          in: query
          type: number
          description: Panel azimuth in degrees (0/360 = north, 90 = east, 180 = south, 270 = west).
        - name: output_parameters
          in: query
          type: string
          description: Comma-separated list of output parameters (e.g., pv_power_rooftop,pv_estimate).
        - name: period
          in: query
          type: string
          description: Time period between data points in ISO 8601 duration format.
        - name: format
          in: query
          type: string
          description: Response format.
    - name: data-live-soiling-hsu
      path: /data/live/soiling/hsu
      operations:
      - name: getlivesoilinghsu
        method: GET
        description: Get Live Soiling (HSU Model)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: latitude
          in: query
          type: number
          description: Latitude in decimal degrees, between -90 and 90 (north positive).
          required: true
        - name: longitude
          in: query
          type: number
          description: Longitude in decimal degrees, between -180 and 180 (east positive).
          required: true
        - name: depo_veloc_pm10
          in: query
          type: number
          description: Deposition velocity for PM10 particles (m/s).
        - name: initial_soiling
          in: query
          type: number
          description: Initial soiling fraction (0.0 = clean, 1.0 = fully soiled).
        - name: format
          in: query
          type: string
          description: Response format.
    - name: data-live-soiling-kimber
      path: /data/live/soiling/kimber
      operations:
      - name: getlivesoilingkimber
        method: GET
        description: Get Live Soiling (Kimber Model)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: latitude
          in: query
          type: number
          description: Latitude in decimal degrees, between -90 and 90 (north positive).
          required: true
        - name: longitude
          in: query
          type: number
          description: Longitude in decimal degrees, between -180 and 180 (east positive).
          required: true
        - name: depo_veloc_pm10
          in: query
          type: number
          description: Deposition velocity for PM10 particles (m/s).
        - name: initial_soiling
          in: query
          type: number
          description: Initial soiling fraction (0.0 = clean, 1.0 = fully soiled).
        - name: format
          in: query
          type: string
          description: Response format.
    authentication:
      type: bearer
      token: '{{env.SOLCAST_API_KEY}}'
  exposes:
  - type: rest
    namespace: solcast-live-data-rest
    port: 8080
    description: REST adapter for Solcast API — Live Data. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/data/live/advanced-pv-power
      name: data-live-advanced-pv-power
      description: REST surface for data-live-advanced_pv_power.
      operations:
      - method: GET
        name: getliveadvancedpvpower
        description: Get Live Advanced PV Power
        call: solcast-live-data.getliveadvancedpvpower
        with:
          resource_id: rest.resource_id
          output_parameters: rest.output_parameters
          period: rest.period
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/live/radiation-and-weather
      name: data-live-radiation-and-weather
      description: REST surface for data-live-radiation_and_weather.
      operations:
      - method: GET
        name: getliveradiationandweather
        description: Get Live Radiation and Weather
        call: solcast-live-data.getliveradiationandweather
        with:
          latitude: rest.latitude
          longitude: rest.longitude
          output_parameters: rest.output_parameters
          period: rest.period
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/live/rooftop-pv-power
      name: data-live-rooftop-pv-power
      description: REST surface for data-live-rooftop_pv_power.
      operations:
      - method: GET
        name: getliverooftoppvpower
        description: Get Live Rooftop PV Power
        call: solcast-live-data.getliverooftoppvpower
        with:
          latitude: rest.latitude
          longitude: rest.longitude
          capacity: rest.capacity
          tilt: rest.tilt
          azimuth: rest.azimuth
          output_parameters: rest.output_parameters
          period: rest.period
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/live/soiling/hsu
      name: data-live-soiling-hsu
      description: REST surface for data-live-soiling-hsu.
      operations:
      - method: GET
        name: getlivesoilinghsu
        description: Get Live Soiling (HSU Model)
        call: solcast-live-data.getlivesoilinghsu
        with:
          latitude: rest.latitude
          longitude: rest.longitude
          depo_veloc_pm10: rest.depo_veloc_pm10
          initial_soiling: rest.initial_soiling
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/live/soiling/kimber
      name: data-live-soiling-kimber
      description: REST surface for data-live-soiling-kimber.
      operations:
      - method: GET
        name: getlivesoilingkimber
        description: Get Live Soiling (Kimber Model)
        call: solcast-live-data.getlivesoilingkimber
        with:
          latitude: rest.latitude
          longitude: rest.longitude
          depo_veloc_pm10: rest.depo_veloc_pm10
          initial_soiling: rest.initial_soiling
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: solcast-live-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for Solcast API — Live Data. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-live-advanced-pv-power
      description: Get Live Advanced PV Power
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: solcast-live-data.getliveadvancedpvpower
      with:
        resource_id: tools.resource_id
        output_parameters: tools.output_parameters
        period: tools.period
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: get-live-radiation-and-weather
      description: Get Live Radiation and Weather
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: solcast-live-data.getliveradiationandweather
      with:
        latitude: tools.latitude
        longitude: tools.longitude
        output_parameters: tools.output_parameters
        period: tools.period
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: get-live-rooftop-pv-power
      description: Get Live Rooftop PV Power
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: solcast-live-data.getliverooftoppvpower
      with:
        latitude: tools.latitude
        longitude: tools.longitude
        capacity: tools.capacity
        tilt: tools.tilt
        azimuth: tools.azimuth
        output_parameters: tools.output_parameters
        period: tools.period
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: get-live-soiling-hsu-model
      description: Get Live Soiling (HSU Model)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: solcast-live-data.getlivesoilinghsu
      with:
        latitude: tools.latitude
        longitude: tools.longitude
        depo_veloc_pm10: tools.depo_veloc_pm10
        initial_soiling: tools.initial_soiling
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: get-live-soiling-kimber-model
      description: Get Live Soiling (Kimber Model)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: solcast-live-data.getlivesoilingkimber
      with:
        latitude: tools.latitude
        longitude: tools.longitude
        depo_veloc_pm10: tools.depo_veloc_pm10
        initial_soiling: tools.initial_soiling
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.