openapi: 3.0.3
info:
  title: Revolutio Hazard Combined Hazard API
  description: The Revolutio Hazard API (formerly CHECKWIND.API) provides site-specific structural engineering hazard parameters for wind, snow, ice, and seismic analysis. Trusted by over 750 companies across construction, fabrication, power distribution, signage, structural engineering, and telecommunications, the API returns location-based load parameters according to international standards including AS/NZS 1170.2, AS 4055, ASCE 7, and others across 40+ countries in Oceania, Asia, the Middle East, North America, South America, and Europe.
  version: 4.0.0
  contact:
    url: https://www.revolutio.com.au/
    email: support@revolutio.com.au
  license:
    name: Commercial
    url: https://www.revolutio.com.au/software/hazardapi/
servers:
- url: https://api.revolutio.com.au
  description: Production
security:
- HazardApiKey: []
tags:
- name: Combined Hazard
  description: Multi-hazard combined analysis returning all available parameters for a site
paths:
  /asnzs1170/combined:
    get:
      operationId: getCombinedHazardGet
      summary: Get Combined Hazard Analysis
      description: Returns all available hazard parameters (wind, snow, ice, seismic) for a given site in a single request. Recommended for comprehensive site assessments.
      tags:
      - Combined Hazard
      parameters:
      - name: apiKey
        in: query
        required: true
        schema:
          type: string
      - name: latitude
        in: query
        required: true
        schema:
          type: number
      - name: longitude
        in: query
        required: true
        schema:
          type: number
      - name: h
        in: query
        required: false
        schema:
          type: number
      - name: units
        in: query
        required: false
        schema:
          type: string
          enum:
          - metric
          - imperial
      - name: advancedDetection
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: googleApiKey
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Combined multi-hazard analysis results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CombinedHazardResult'
        '400':
          description: Invalid parameters
        '401':
          description: Unauthorized
        '429':
          description: Rate limit exceeded
    post:
      operationId: getCombinedHazardPost
      summary: Post Combined Hazard Analysis
      description: Returns all hazard parameters for a site via POST.
      tags:
      - Combined Hazard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteCoordinates'
      responses:
        '200':
          description: Combined multi-hazard analysis results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CombinedHazardResult'
        '400':
          description: Invalid parameters
        '401':
          description: Unauthorized
components:
  schemas:
    SiteCoordinates:
      type: object
      required:
      - latitude
      - longitude
      properties:
        latitude:
          type: number
          format: double
          description: Site latitude in decimal degrees
          example: -33.8688
        longitude:
          type: number
          format: double
          description: Site longitude in decimal degrees
          example: 151.2093
        h:
          type: number
          format: double
          description: Structure height above ground in metres (optional; omit for faster response)
          example: 15.0
        units:
          type: string
          enum:
          - metric
          - imperial
          default: metric
          description: Output units (metric or imperial)
        advancedDetection:
          type: boolean
          default: true
          description: Use machine learning terrain/exposure detection algorithm
        googleApiKey:
          type: string
          description: Optional Google API key for elevation/geocoding data source
    SeismicResult:
      type: object
      properties:
        hazardClass:
          type: string
          description: Seismic hazard class
        siteClass:
          type: string
          description: Site subsoil class
        kp:
          type: number
          format: double
          description: Probability factor
        standard:
          type: string
          description: Applied design standard
    SnowIceResult:
      type: object
      properties:
        snowRegion:
          type: string
          description: Snow region classification
        snowElevationClass:
          type: string
          description: Snow elevation class
        snowGroundLoad:
          type: number
          format: double
          description: Snow ground load in kPa
        iceRegion:
          type: string
          description: Ice region classification
        standard:
          type: string
          description: Applied design standard
    CombinedHazardResult:
      type: object
      properties:
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        country:
          type: string
        wind:
          $ref: '#/components/schemas/WindAnalysisResult'
        snow:
          $ref: '#/components/schemas/SnowIceResult'
        ice:
          $ref: '#/components/schemas/SnowIceResult'
        seismic:
          $ref: '#/components/schemas/SeismicResult'
        creditsUsed:
          type: integer
          description: Number of API credits consumed by this request
    WindAnalysisResult:
      type: object
      properties:
        region:
          type: string
          description: Wind region classification
          example: A0
        class:
          type: string
          description: Site wind class
          example: N1
        criticalDirection:
          type: string
          description: Critical wind direction
          example: N
        terrainCategory:
          type: object
          description: Directional terrain category results
          additionalProperties:
            type: string
        topographicClass:
          type: object
          description: Directional topographic classification
          additionalProperties:
            type: string
        shieldingClass:
          type: object
          description: Directional shielding classification
          additionalProperties:
            type: string
        windSpeed:
          type: number
          format: double
          description: Design wind speed in m/s (or mph if imperial)
        standard:
          type: string
          description: Applied design standard
          example: AS/NZS 1170.2-2021
  securitySchemes:
    HazardApiKey:
      type: apiKey
      in: query
      name: apiKey
      description: Revolutio Hazard API subscription key. For POST requests pass in request header.