openapi: 3.0.1
info:
  title: Cloud-RF API
  description: 'The Cloud-RF API enables users to model and test radio propagation for any radio, anywhere. Authenticate by passing your API2.0 key in the request header as `key`. Set up a [CloudRF.com](https://cloudrf.com/my-account) account to generate this key. All data is transferred as JSON. For detailed documentation, please visit [docs.cloudrf.com](https://docs.cloudrf.com).'
  termsOfService: 'https://cloudrf.com/terms-and-conditions/'
  contact:
    email: support@cloudrf.com
  version: 3.2
servers:
  - url: 'https://api.cloudrf.com'
    description: Production environment
  - url: 'https://localhost'
    description: Development environment
security:
  - ApiKeyAuth: []
tags:
  - name: Create
    description: This set of endpoints allows the user to create new links, site heatmaps, routes, and networks.
  - name: Analyse
    description: This set of endpoints allows the user to use and derive information from pre-defined networks and layers.
  - name: Manage
    description: This set of endpoints allow the user to enumerate, delete, and export data in open formats.
  - name: Account
    description: This set of endpoints allow you to better make use of your account.
paths:
  /area:
    post:
      operationId: area
      description: |
        This endpoint returns an omni-directional coverage plot (point-to-multipoint) as an image, rendered with a color schema.
        This function assumes the same receiver height at all locations out to fixed radius (up to a 300 km maximum).
        Due to its recursive processing, this is the most resource intensive of all the API calls.
        Speed can be improved significantly by adjusting the resolution "res" parameter upwards so 4 (m) is faster than 2 (m).
        If you have a plan which supports GPU processing you can also specify the GPU `engine` value which is considerably faster than CPU calculations.
        A standard request requires transmitter, receiver, antenna, and output objects; providing model and environment enhances accuracy.
      tags:
        - Create
      summary: Create a point-to-multipoint heatmap
      requestBody:
        description: The request payload providing the site properties.
        content:
          application/json:
            schema:
              type: object
              properties:
                site:
                  description: Site name.
                  type: string
                  default: A1
                  minLength: 1
                  maxLength: 24
                network:
                  description: Network name/group.
                  type: string
                  default: Testing
                  minLength: 1
                  maxLength: 24
                engine:
                  description: |
                    Processing engine to handle the request:
                    * `1` - GPU (requires a GPU enabled subscription plan)
                    * `2` - CPU
                  type: number
                  format: float
                  default: 2
                  enum:
                    - 1
                    - 2
                transmitter:
                  $ref: '#/components/schemas/Transmitter'
                receiver:
                  $ref: '#/components/schemas/Receiver'
                antenna:
                  $ref: '#/components/schemas/Antenna'
                model:
                  $ref: '#/components/schemas/Model'
                environment:
                  $ref: '#/components/schemas/Environment'
                output:
                  $ref: '#/components/schemas/Output'
              required:
                - network
                - transmitter
                - receiver
                - antenna
                - output
            examples:
              example-area:
                value:
                  site: A1
                  network: Testing
                  transmitter:
                    lat: 38.916
                    lon: 1.448
                    alt: 2
                    frq: 868
                    txw: 0.1
                    bwi: 1
                  receiver:
                    lat: 0
                    lon: 0
                    alt: 2
                    rxg: 3
                    rxs: -100
                  antenna:
                    txg: 2.15
                    txl: 1
                    ant: 0
                    azi: 1
                    tlt: 10
                    hbw: 2
                    vbw: 2
                    pol: h
                  output:
                    units: metric
                    col: RAINBOW.dBm
                    out: 2
                    ber: 2
                    mod: 7
                    nf: -100
                    res: 10
                    rad: 5
      responses:
        '200':
          description: 'Success – JSON object returned containing image URLs, color key values, and calculation statistics.'
          content:
            application/json:
              schema:
                type: object
                description: An object containing the results of the /area call.
                properties:
                  kmz:
                    type: string
                    format: uri
                    description: URL to image file.
                    example: "https://api.cloudrf.com/archive/export?sid=YnJETGFWbjZsNDBlNVRQY1phUFFsdz09&fmt=kmz"
                  PNG_WGS84:
                    type: string
                    format: uri
                    description: URL to image file applying the WGS84 standard.
                    example: 'https://api.cloudrf.com/users/40843/0722102238_Testing_A1.4326.png'
                  PNG_Mercator:
                    type: string
                    format: uri
                    description: URL to image file applying the Mercartor projection standard.
                    example: 'https://api.cloudrf.com/users/40843/0722102238_Testing_A1.3857.png'
                  bounds:
                    type: array
                    description: A list of image bounds as WGS84 decimal degrees. Order is clockwise from North,East,South,West.
                    items:
                      type: integer
                      format: float
                      example:
                        - 38.97373
                        - 1.505727
                        - 38.85827
                        - 1.390273
                  id:
                    type: string
                    description: Unique system identifier for the calculation. This is a one-up number from the main log table.
                    example: '3930916'
                  sid:
                    type: string
                    description: Private unique system identifier for the calculation. This is a hash of the one-up number from the main log table intended for public maps etc.
                    example: M2ZSaUZuVlVDRno3TTJDTGVqRGJlUT09
                  area:
                    type: number
                    format: float
                    description: Coverage area measured in kilometers squared (km2).
                    example: 0
                  coverage:
                    type: string
                    description: Site efficiency computed from requested radius versus actual coverage area. A perfect circle out at sea would be 100% efficient.
                    example: 0%
                  key:
                    type: array
                    description: Array of objects describing the RGB color schema as signal level in dB/dBm/dBuV, red, green and blue where red would be rgb(255,0,0).
                    items:
                      type: object
                      properties:
                        l:
                          type: string
                          description: Received signal power in dBm
                          example: '-20dBm'
                        r:
                          description: RED colour intensity. 0 to 255.
                          type: integer
                          example: 255
                        g:
                          description: GREEN colour intensity. 0 to 255.
                          type: integer
                          example: 19
                        b:
                          description: BLUE colour intensity. 0 to 255.
                          type: integer
                          example: 0
                      example:
                        - l: '-20dBm'
                          r: 255
                          g: 19
                          b: 0
                        - l: '-24dBm'
                          r: 255
                          g: 61
                          b: 0
                        - l: '-28dBm'
                          r: 255
                          g: 102
                          b: 0
                        - l: '-32dBm'
                          r: 255
                          g: 144
                          b: 0
                        - l: '-36dBm'
                          r: 255
                          g: 185
                          b: 0
                        - l: '-40dBm'
                          r: 255
                          g: 227
                          b: 0
                        - l: '-44dBm'
                          r: 242
                          g: 255
                          b: 0
                        - l: '-48dBm'
                          r: 200
                          g: 255
                          b: 0
                        - l: '-52dBm'
                          r: 159
                          g: 255
                          b: 0
                        - l: '-56dBm'
                          r: 117
                          g: 255
                          b: 0
                        - l: '-60dBm'
                          r: 76
                          g: 255
                          b: 0
                        - l: '-64dBm'
                          r: 34
                          g: 255
                          b: 0
                        - l: '-68dBm'
                          r: 0
                          g: 255
                          b: 7
                        - l: '-72dBm'
                          r: 0
                          g: 255
                          b: 49
                        - l: '-76dBm'
                          r: 0
                          g: 255
                          b: 90
                        - l: '-80dBm'
                          r: 0
                          g: 255
                          b: 132
                        - l: '-84dBm'
                          r: 0
                          g: 255
                          b: 173
                        - l: '-88dBm'
                          r: 0
                          g: 255
                          b: 215
                        - l: '-92dBm'
                          r: 0
                          g: 254
                          b: 255
                        - l: '-96dBm'
                          r: 0
                          g: 212
                          b: 255
                        - l: '-100dBm'
                          r: 0
                          g: 171
                          b: 255
                        - l: '-104dBm'
                          r: 0
                          g: 129
                          b: 255
                        - l: '-108dBm'
                          r: 0
                          g: 88
                          b: 255
                        - l: '-112dBm'
                          r: 0
                          g: 46
                          b: 255
                  elapsed:
                    description: Time taken for API call (milliseconds).
                    type: number
                    format: int32
                    example: 1572
                  balance:
                    description: API call credit usage. Only applies to public system.
                    type: integer
                    format: int32
                    example: 1
                  calculation_adjusted:
                    type: array
                    description: An array of messages indicating if a calculation was adjusted due to account limitations or restrictions on settings.
                    items:
                      type: string
                      example:
                        - 'Resolution has been reduced from 30m to 54m due to your plan. Your proposed calculation would exceed your plans megapixel limit of 5MP.'
                        - '10m landcover is disabled for calculations with a radius greater than 50KM.'
                        - '10m landcover is disabled for calculations with a resolution of greater than 30m.'
                        - '3D buildings are disabled for calculations with a radius greater than 20KM.'
                        - '3D buildings are disabled for calculations with a resolution greater than 30m.'

  /path:
    post:
      operationId: path
      description: 'This endpoint allows users to analyze a point-to-point path. A path profile is a single link from A to B to a maximum of 300 km. It is much faster than an area calculation. While a basic request requires transmitter, receiver, antenna, and output objects; providing model and environment enhances accuracy.'
      tags:
        - Create
      summary: Point-to-point path profile analysis (Tx to Rx)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                site:
                  description: Site name.
                  type: string
                  default: Link
                  minLength: 1
                  maxLength: 24
                network:
                  description: Network name/group.
                  type: string
                  default: Testing
                  minLength: 1
                  maxLength: 24
                transmitter:
                  $ref: '#/components/schemas/Transmitter'
                antenna:
                  $ref: '#/components/schemas/Antenna'
                receiver:
                  $ref: '#/components/schemas/Receiver'
                model:
                  $ref: '#/components/schemas/Model'
                environment:
                  $ref: '#/components/schemas/Environment'
                output:
                  $ref: '#/components/schemas/Output'
              required:
                - transmitter
                - receiver
                - antenna
                - output
            examples:
              example-path:
                value:
                  site: Link
                  network: Testing
                  transmitter:
                    lat: 38.916
                    lon: 1.448
                    alt: 1
                    frq: 868
                    txw: 0.1
                    bwi: 1
                  antenna:
                    txg: 2.15
                    txl: 1
                    ant: 0
                    azi: 1
                    tlt: 10
                    hbw: 2
                    vbw: 2
                    pol: h
                  receiver:
                    lat: 38.906986
                    lon: 1.421416
                    alt: 0.1
                    rxg: 3
                    rxs: -100
                  model:
                    pm: 1
                    pe: 2
                    cli: 7
                    ked: 1
                    rel: 55
                    ter: 3
                  environment:
                    clm: 1
                    cll: 1
                    mat: 1
                  output:
                    units: metric
                    col: RAINBOW.dBm
                    out: 2
                    ber: 2
                    mod: 7
                    nf: -100
                    res: 10
                    rad: 5
      responses:
        '200':
          description: 'Success – JSON object returned containing detailed link measurements in different units and arrays for plotting of profile, obstructions, path loss, and landcover.'
          content:
            application/json:
              schema:
                type: object
                description: An object containing the results of the /path call.
                properties:
                    Engine:
                        type: string
                        description: Engine version string used to perform the calculation
                        example: Sleipnir 1.6.1
                    kmz:
                        type: string
                        format: uri
                        description: URL to KMZ file.
                        example: 'https://api.cloudrf.com/API/archive/data?path=0728132101_Testing_PPA&uid=40843'
                    Chart image:
                        type: string
                        format: uri
                        description: URL to PNG image file.
                        example: 'https://api.cloudrf.com/API/archive/data?ppa=0728132101_Testing_PPA&uid=40843'
                    elapsed:
                        description: Time taken for API call (milliseconds).
                        type: number
                        format: Int32
                        example: 135
                    calculation_adjusted:
                        type: array
                        description: An array of messages indicating if a calculation was adjusted due to account limitations or restrictions on settings.
                        items:
                          type: string
                        example: []
                    Frequency MHz:
                        description: Center frequency in megahertz.
                        type: number
                        format: float
                        example: 868
                    Propagation model:
                        description: |
                          Propagation model: 
                          * `1` - ITM / Irregular Terrain Model (aka Longley Rice)
                          * `2` - LOS / Line of Sight
                          * `3` - Okumura-Hata
                          * `4` - ITU-R P.529 VHF/UHF
                          * `5` - SUI / Stanford University Interim Microwave
                          * `6` - COST231
                          * `7` - Free space path loss
                          * `8` - Reserved
                          * `9` - Ericsson9999
                          * `10` - Plane earth loss
                          * `11` - Egli
                        type: string
                        example: ITM
                    Earth dielectric constant:
                        description: |
                          ITM model only (Reference https://www.qsl.net/n9zia/conduct.html):
                          * `3` - City/Industrial
                          * `5` - City
                          * `13` - Mountain / Sand
                          * `15` - Average ground / Arable
                          * `25` - Good ground
                          * `80` - Water
                        type: number
                        format: float
                        example: 14
                    Earth conductivity:
                        description: ITM model only. Corresponding conductivity measured in S/m ranging from 0.001 to 5.0. Reference https://www.qsl.net/n9zia/conduct.html
                        type: number
                        format: float
                        example: 0.01
                    Radio climate:
                        description: |
                          ITM model only. ITU climate codes. 
                          * `1` - Equatorial
                          * `2` - Continental Subtropical
                          * `3` - Maritime Subtropical
                          * `4` - Desert
                          * `5` - Continental Temperate
                          * `6` - Maritime Temperate (Land)
                          * `7` - Maritime Temperate (Sea)
                        type: string
                        enum:
                            - Equatorial (Congo)
                            - Continental Subtropical (Sudan)
                            - Maritime Subtropical (West coast of Africa)
                            - Desert (Sahara)
                            - Continental Temperate
                            - Maritime Temperate (Land)
                            - Maritime Temperate (Sea)
                        example: Maritime Temperate (Land)
                    Atmospheric bending constant:
                        description: ITM model only. Number describing atmospheric refractive index.
                        type: number
                        format: Int32
                        example: 301
                    Fraction of situations:
                        description: ITM model only. Reliability value for a given location in percentage.
                        type: number
                        format: Int32
                        example: 90
                    Fraction of time:
                        description: ITM model only. Reliability value for a given time in percentage.
                        type: number
                        format: Int32
                        example: 90
                    Receiver:
                        type: object
                        properties:
                            Latitude:
                                description: Receiver's latitude provided in call in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 38.90699
                            Longitude:
                                description: Receiver's longitude provided in call in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 1.421416
                            Ground elevation m:
                                description: Ground elevation above mean sea level (AMSL) in either meters or feet as set by distance units.
                                type: number
                                format: float
                                example: 13
                            Antenna height m:
                                description: Antenna height above ground level in meters or feet as provided in API call.
                                type: number
                                format: float
                                example: 0.1
                            Receiver gain dBd:
                                description: Receive antenna gain measured in decibels relative to a dipole antenna (2.15dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 0.85
                            Receiver gain dBi:
                                description: Receive antenna gain measured in decibels relative to an isotropic antenna (0dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 3
                    Transmitters:
                        type: object
                        properties:
                            Latitude:
                                description: Latitude of transmitter in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 38.916
                            Longitude:
                                description: Longitude of transmitter in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 1.448
                            Ground elevation m:
                                description: Ground elevation above mean sea level (AMSL) in either meters or feet as set by distance units.
                                type: number
                                format: float
                                example: 0
                            Antenna height m:
                                description: Antenna height above ground level in meters or feet as provided in API call.
                                type: number
                                format: float
                                example: 1
                            Distance to receiver km:
                                description: Distance between transmitter and receiver in kilometers OR miles measured from the base of the antennas. Units determined within output object.
                                type: number
                                format: float
                                example: 2.512
                            Azimuth to receiver deg:
                                description: Angle in degrees referenced to grid north from the transmitter base to the receiver base.
                                type: number
                                format: float
                                example: 246.46
                            Downtilt angle deg:
                                description: Angle in degrees from the transmitter to the receiver relative the horizon (0.0). A positive value is below the horizon (looking downhill).
                                type: number
                                format: float
                                example: 0.3
                            Antenna gain dBd:
                                description: Transmit antenna gain measured in decibels relative to a dipole antenna (2.15dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: -1
                            Antenna gain dBi:
                                description: Transmit antenna gain measured in decibels relative to a isotropic antenna (0dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 1.15
                            Polarisation:
                                description: Antenna polarisation as requested. Either Horizontal or Vertical.
                                type: string
                                example: Horizontal
                            Power W:
                                description: Transmit power before antenna measured in Watts.
                                type: number
                                format: float
                                example: 0.1
                            Power dBm:
                                description: Transmit power before antenna measured in decibel milliwatts
                                type: string
                                example: 21.15
                            ERP W:
                                description: Transmitter Effective Radiated Power (dipole) after antenna gain in Watts.
                                type: number
                                format: float
                                example: 0.08
                            EIRP W:
                                description: Transmitter Effective Isotropic Radiated Power (isotropic) after antenna gain in Watts.
                                type: number
                                format: float
                                example: 0.13
                            ERP dBm:
                                description: Transmitter Effective Radiated Power (dipole) after antenna gain in decibel milliwatts
                                type: number
                                format: float
                                example: 19
                            EIRP dBm:
                                description: Transmitter Effective Isotropic Radiated Power (isotropic) after antenna gain in decibel milliwatts
                                type: number
                                format: float
                                example: 21.15
                            Free space path loss dB:
                                description: Pure link path loss using ITU-R P.525 measured in decibels
                                type: number
                                format: float
                                example: 95.1
                            Bandwidth MHz:
                                description: Signal bandwidth measured in megahertz
                                type: number
                                format: float
                                example: 1
                            Johnson Nyquist noise dB:
                                description: Johnson Nyquist noise measured in decibels (dB)
                                type: number
                                format: float
                                example: 10.2
                            Noise floor dBm:
                                description: Noise floor measured in decibel milliwatts (dBm)
                                type: number
                                format: float
                                example: -100
                            Channel noise dBm:
                                description: Noise floor measured in decibel milliwatts (dBm)
                                type: number
                                format: float
                                example: -89.8
                            Signal power at receiver dBm:
                                description: Received signal power at receiver measured in decibel milliwatts (dBm)
                                type: number
                                format: float
                                example: -205.6
                            Signal to Noise Ratio dB:
                                description: Signal to noise ratio measured in decibels (dB)
                                type: number
                                format: float
                                example: -115.8
                            Computed path loss dB:
                                description: Total computed path loss at receiver (including gains/losses) measured in decibels (dB)
                                type: number
                                format: float
                                example: 225.6
                            Model attenuation dB:
                                description: Additional path loss from the propagation model, measured in decibels
                                type: number
                                format: float
                                example: 130.6
                            Field strength at receiver dBuV/m:
                                description: Field strength at receiver measured in decibel microvolts per meter.
                                type: number
                                format: float
                                example: -68.5
                            RX voltage 50 ohm dipole uV:
                                description: Received power reference to a 50 ohm dipole measured in micro volts
                                type: number
                                format: float
                                example: 0
                            RX voltage 50 ohm dipole dBuV:
                                description: Received power reference to a 50 ohm dipole measured in decibel micro volts
                                type: number
                                format: float
                                example: -95
                            RX voltage 75 ohm dipole uV:
                                description: Received power reference to a 75 ohm dipole measured in micro volts
                                type: number
                                format: float
                                example: 0
                            RX voltage 75 ohm dipole dBuV:
                                description: Received power reference to a 75 ohm dipole measured in decibel micro volts
                                type: number
                                format: float
                                example: -94
                            Raise RX antenna for LOS:
                                description: Calculated height adjustment necessary to achieve line of sight in either meters or feet
                                type: number
                                format: float
                                example: 100.1
                            Raise RX antenna for fresnel 60%:
                                description: Calculated height adjustment necessary to clear 60% of the fresnel zone in either meters or feet
                                type: number
                                format: float
                                example: 313.1
                            Raise RX antenna for full fresnel:
                                description: Calculated height adjustment necessary to clear 100% of the fresnel zone in either meters or feet
                                type: number
                                format: float
                                example: 445.1
                            Obstructions:
                                description: Array of WGS84 latitude + longitude pairs describing obstructions along a path.
                                type: array
                                items:
                                  type: array
                                  items:
                                    type: array
                                    0:
                                      description: Latitude value of obstruction in WGS84 projection.
                                      type: number
                                      format: float
                                    1:
                                      description: Longitude value of obstruction in WGS84 projection.
                                      type: number
                                      format: float
                                  example:
                                    - [ 38.90701, 1.421483 ]
                                    - [ 38.90708, 1.421693 ]
                                    - [ 38.90719, 1.422009 ]
                                    - [ 38.90919, 1.427901 ]
                                    - [ 38.90926, 1.428112 ]
                                    - [ 38.90936, 1.428427 ]
                                    - [ 38.91357, 1.440844 ]
                                    - [ 38.91379, 1.441475 ]
                                    - [ 38.91382, 1.441581 ]
                                    - [ 38.9139, 1.441791 ]
                                    - [ 38.91393, 1.441896 ]
                                    - [ 38.91397, 1.442002 ]
                                    - [ 38.91404, 1.442212 ]
                                    - [ 38.91579, 1.447369 ]
                                    - [ 38.91582, 1.447474 ]
                                    - [ 38.91586, 1.447579 ]
                                    - [ 38.91589, 1.447684 ]
                                    - [ 38.91593, 1.44779 ]
                            Distance:
                                description: Distance array from transmitter to receiver to enable chart plotting. Units are kilometers or miles
                                type: array
                                items:
                                  type: number
                                  format: float
                                example:
                                  - 0.01
                                  - 0.02
                                  - 0.03
                                  - 0.04
                                  - 0.05
                                  - 0.06
                                  - 0.07
                                  - 0.08
                                  - 0.089
                                  - 0.099
                                  - 0.109
                                  - 0.119
                                  - 0.129
                                  - 0.139
                                  - 0.149
                                  - 0.159
                                  - 0.169
                                  - 0.179
                                  - 0.189
                                  - 0.199
                                  - 0.209
                                  - 0.219
                                  - 0.229
                                  - 0.239
                                  - 0.249
                                  - 0.259
                                  - 0.268
                                  - 0.278
                                  - 0.288
                                  - 0.298
                                  - 0.308
                                  - 0.318
                                  - 0.328
                                  - 0.338
                                  - 0.348
                                  - 0.358
                                  - 0.368
                                  - 0.378
                                  - 0.388
                                  - 0.398
                                  - 0.408
                                  - 0.418
                                  - 0.428
                                  - 0.437
                                  - 0.447
                                  - 0.457
                                  - 0.467
                                  - 0.477
                                  - 0.487
                                  - 0.497
                                  - 0.507
                                  - 0.517
                                  - 0.527
                                  - 0.537
                                  - 0.547
                                  - 0.557
                                  - 0.567
                                  - 0.577
                                  - 0.587
                                  - 0.597
                                  - 0.606
                                  - 0.616
                                  - 0.626
                                  - 0.636
                                  - 0.646
                                  - 0.656
                                  - 0.666
                                  - 0.676
                                  - 0.686
                                  - 0.696
                                  - 0.706
                                  - 0.716
                                  - 0.726
                                  - 0.736
                                  - 0.746
                                  - 0.756
                                  - 0.766
                                  - 0.776
                                  - 0.785
                                  - 0.795
                                  - 0.805
                                  - 0.815
                                  - 0.825
                                  - 0.835
                                  - 0.845
                                  - 0.855
                                  - 0.865
                                  - 0.875
                                  - 0.885
                                  - 0.895
                                  - 0.905
                                  - 0.915
                                  - 0.925
                                  - 0.935
                                  - 0.945
                                  - 0.954
                                  - 0.964
                                  - 0.974
                                  - 0.984
                                  - 0.994
                                  - 1.004
                                  - 1.014
                                  - 1.024
                                  - 1.034
                                  - 1.044
                                  - 1.054
                                  - 1.064
                                  - 1.074
                                  - 1.084
                                  - 1.094
                                  - 1.104
                                  - 1.114
                                  - 1.124
                                  - 1.133
                                  - 1.143
                                  - 1.153
                                  - 1.163
                                  - 1.173
                                  - 1.183
                                  - 1.193
                                  - 1.203
                                  - 1.213
                                  - 1.223
                                  - 1.233
                                  - 1.243
                                  - 1.253
                                  - 1.263
                                  - 1.273
                                  - 1.283
                                  - 1.293
                                  - 1.302
                                  - 1.312
                                  - 1.322
                                  - 1.332
                                  - 1.342
                                  - 1.352
                                  - 1.362
                                  - 1.372
                                  - 1.382
                                  - 1.392
                                  - 1.402
                                  - 1.412
                                  - 1.422
                                  - 1.432
                                  - 1.442
                                  - 1.452
                                  - 1.462
                                  - 1.471
                                  - 1.481
                                  - 1.491
                                  - 1.501
                                  - 1.511
                                  - 1.521
                                  - 1.531
                                  - 1.541
                                  - 1.551
                                  - 1.561
                                  - 1.571
                                  - 1.581
                                  - 1.591
                                  - 1.601
                                  - 1.611
                                  - 1.621
                                  - 1.631
                                  - 1.641
                                  - 1.65
                                  - 1.66
                                  - 1.67
                                  - 1.68
                                  - 1.69
                                  - 1.7
                                  - 1.71
                                  - 1.72
                                  - 1.73
                                  - 1.74
                                  - 1.75
                                  - 1.76
                                  - 1.77
                                  - 1.78
                                  - 1.79
                                  - 1.8
                                  - 1.81
                                  - 1.819
                                  - 1.829
                                  - 1.839
                                  - 1.849
                                  - 1.859
                                  - 1.869
                                  - 1.879
                                  - 1.889
                                  - 1.899
                                  - 1.909
                                  - 1.919
                                  - 1.929
                                  - 1.939
                                  - 1.949
                                  - 1.959
                                  - 1.969
                                  - 1.979
                                  - 1.988
                                  - 1.998
                                  - 2.008
                                  - 2.018
                                  - 2.028
                                  - 2.038
                                  - 2.048
                                  - 2.058
                                  - 2.068
                                  - 2.078
                                  - 2.088
                                  - 2.098
                                  - 2.108
                                  - 2.118
                                  - 2.128
                                  - 2.138
                                  - 2.148
                                  - 2.158
                                  - 2.167
                                  - 2.177
                                  - 2.187
                                  - 2.197
                                  - 2.207
                                  - 2.217
                                  - 2.227
                                  - 2.237
                                  - 2.247
                                  - 2.257
                                  - 2.267
                                  - 2.277
                                  - 2.287
                                  - 2.297
                                  - 2.307
                                  - 2.317
                                  - 2.327
                                  - 2.336
                                  - 2.346
                                  - 2.356
                                  - 2.366
                                  - 2.376
                                  - 2.386
                                  - 2.396
                                  - 2.406
                                  - 2.416
                                  - 2.426
                                  - 2.436
                                  - 2.446
                                  - 2.456
                                  - 2.466
                                  - 2.476
                                  - 2.486
                                  - 2.496
                                  - 2.506
                                  - 2.512
                            Terrain:
                                description: |
                                  Array of terrain heights along the path to enable plotting. 
                                  Heights will be adjusted to represent the difference between the transmitter and the receiver heights (normalisation). 
                                  For absolute values please see `Terrain_AMSL`.
                                type: array
                                items:
                                  type: number
                                  format: float
                                example:
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 1
                                  - 1
                                  - 1
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 2
                                  - 4
                                  - 6
                                  - 8
                                  - 8
                                  - 8
                                  - 8
                                  - 7
                                  - 6
                                  - 6
                                  - 5
                                  - 4
                                  - 4
                                  - 4
                                  - 4
                                  - 5
                                  - 5
                                  - 4
                                  - 4
                                  - 3
                                  - 3
                                  - 2
                                  - 1
                                  - 1
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 1
                                  - 1
                                  - 1
                                  - 1
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 0
                                  - 1
                                  - 3
                                  - 4
                                  - 5
                                  - 6
                                  - 7
                                  - 7
                                  - 7
                                  - 8
                                  - 7
                                  - 7
                                  - 7
                                  - 6
                                  - 6
                                  - 6
                                  - 5
                                  - 6
                                  - 6
                                  - 6
                                  - 6
                                  - 6
                                  - 6
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 5
                                  - 4
                                  - 4
                                  - 5
                                  - 5
                                  - 6
                                  - 7
                                  - 8
                                  - 9
                                  - 9
                                  - 10
                                  - 11
                                  - 12
                                  - 13
                                  - 13
                                  - 13
                                  - 13
                                  - 13
                                  - 13
                                  - 12
                                  - 12
                                  - 11
                                  - 11
                                  - 10
                                  - 10
                                  - 9
                                  - 8
                                  - 8
                                  - 7
                                  - 7
                                  - 7
                                  - 6
                                  - 6
                                  - 6
                                  - 5
                                  - 5
                                  - 5
                                  - 4
                                  - 4
                                  - 3
                                  - 3
                                  - 3
                                  - 4
                                  - 5
                                  - 6
                                  - 6
                                  - 7
                                  - 7
                                  - 8
                                  - 9
                                  - 9
                                  - 10
                                  - 11
                                  - 11
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 10
                                  - 11
                                  - 11
                                  - 11
                                  - 12
                                  - 12
                                  - 13
                                  - 13
                                  - 14
                                  - 14
                                  - 14
                                  - 14
                                  - 14
                                  - 14
                                  - 13
                                  - 13
                                  - 13
                                  - 12
                                  - 12
                                  - 12
                            Terrain_AMSL:
                              description: |
                                Array of terrain heights along the path to enable plotting.
                                Heights are above mean sea level in metres or feet.
                              type: array
                              items:
                                type: number
                                format: float
                              example:
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0
                                - 0.2857143
                                - 0.6122449
                                - 0.9854227
                                - 1.554769
                                - 1.878919
                                - 2.059873
                                - 2.213366
                                - 2.164594
                                - 1.91969
                                - 1.756807
                                - 1.548727
                                - 1.175032
                                - 0.9257952
                                - 0.6642221
                                - 0.3950071
                                - 0.2835749
                                - 0.1918292
                                - 0.1243444
                                - 0.08567836
                                - 0.05740742
                                - 0.03820432
                                - 0.02589859
                                - 0.01735862
                                - 0.01163736
                                - 0.007842081
                                - 0.00526258
                                - 0.003534574
                                - 0.002377034
                                - 0.001596313
                                - 0.00107256
                                - 0.0007208438
                                - 0.0004842452
                                - 0.0003253784
                                - 0.0002186382
                                - 0.0001468945
                                - 9.87016e-5
                                - 6.631919e-5
                                - 0.2857588
                                - 0.6122748
                                - 0.6997286
                                - 1.371109
                                - 1.811873
                                - 3.411816
                                - 5.513543
                                - 7.248176
                                - 9.167648
                                - 9.989909
                                - 9.915105
                                - 9.581809
                                - 8.926689
                                - 7.7748
                                - 7.183328
                                - 6.554974
                                - 5.787586
                                - 5.789413
                                - 5.875996
                                - 5.921856
                                - 6.226752
                                - 6.003515
                                - 5.736018
                                - 5.566612
                                - 4.900878
                                - 4.314787
                                - 3.683182
                                - 2.842692
                                - 2.405809
                                - 1.847383
                                - 1.299412
                                - 0.9360863
                                - 0.5832688
                                - 0.5455382
                                - 0.580699
                                - 0.6727866
                                - 0.828432
                                - 0.7259882
                                - 0.6038867
                                - 0.4511867
                                - 0.2544374
                                - 0.187073
                                - 0.1275281
                                - 0.08129121
                                - 0.05655605
                                - 0.03791077
                                - 0.02510829
                                - 0.01708216
                                - 0.01144303
                                - 0.007661926
                                - 0.005169588
                                - 0.003467792
                                - 0.002328472
                                - 0.00156655
                                - 0.001051831
                                - 0.0007066933
                                - 0.0004750106
                                - 0.0003190764
                                - 0.2859287
                                - 0.612389
                                - 0.9855195
                                - 1.697691
                                - 2.185086
                                - 2.552614
                                - 2.49077
                                - 2.032638
                                - 1.439432
                                - 0.8518343
                                - 0.6177007
                                - 0.4155667
                                - 0.2693002
                                - 0.1860811
                                - 0.1244211
                                - 0.08282892
                                - 0.1990473
                                - 0.3437568
                                - 0.5179476
                                - 1.151536
                                - 1.716177
                                - 2.626523
                                - 4.070605
                                - 5.201901
                                - 6.557004
                                - 7.68993
                                - 8.349834
                                - 8.799538
                                - 8.977043
                                - 9.018059
                                - 8.827806
                                - 8.688987
                                - 8.362122
                                - 7.982702
                                - 7.719116
                                - 7.294849
                                - 6.999524
                                - 7.001927
                                - 7.042328
                                - 7.291968
                                - 7.476603
                                - 7.401557
                                - 7.167161
                                - 6.863617
                                - 6.633191
                                - 6.380567
                                - 6.268196
                                - 6.183136
                                - 6.118843
                                - 6.081454
                                - 6.054776
                                - 6.036439
                                - 6.024667
                                - 6.016555
                                - 6.011094
                                - 6.007474
                                - 6.005018
                                - 6.003369
                                - 6.145123
                                - 6.307644
                                - 6.493734
                                - 6.706643
                                - 6.78686
                                - 6.85532
                                - 6.764118
                                - 6.629471
                                - 6.321273
                                - 5.959266
                                - 5.987144
                                - 6.181098
                                - 6.589644
                                - 7.536841
                                - 8.329655
                                - 9.065163
                                - 10.13309
                                - 10.7897
                                - 11.71257
                                - 12.80505
                                - 13.61533
                                - 14.30471
                                - 14.67501
                                - 14.79929
                                - 14.68272
                                - 14.59386
                                - 14.29655
                                - 13.79616
                                - 13.3838
                                - 12.78236
                                - 12.28033
                                - 11.92093
                                - 11.14052
                                - 10.4774
                                - 9.93412
                                - 9.221719
                                - 8.947605
                                - 8.586206
                                - 8.107933
                                - 7.805963
                                - 7.357158
                                - 7.038722
                                - 6.885978
                                - 6.468837
                                - 6.199077
                                - 5.793413
                                - 5.208761
                                - 4.885893
                                - 4.555438
                                - 4.807156
                                - 5.46407
                                - 6.260952
                                - 7.218883
                                - 7.991986
                                - 8.495974
                                - 8.95812
                                - 9.635154
                                - 10.29846
                                - 10.98453
                                - 11.70259
                                - 12.1408
                                - 12.11828
                                - 11.99452
                                - 11.75051
                                - 11.26619
                                - 11.28732
                                - 11.32915
                                - 11.41181
                                - 11.71832
                                - 11.7799
                                - 11.84429
                                - 11.90607
                                - 12.07575
                                - 12.40373
                                - 12.91222
                                - 13.48453
                                - 13.9715
                                - 14.48118
                                - 14.84817
                                - 15.32869
                                - 15.80829
                                - 15.85502
                                - 15.856
                                - 15.64562
                                - 15.33666
                                - 14.9769
                                - 14.5656
                                - 14.12559
                                - 13.66687
                                - 13.47972
                                - 13.3246
                            Landcover distance:
                              description: |
                                Array of distances along the path to enable plotting. 
                                Measured along the path in km, measured from the transmitter.
                              type: array
                              items:
                                type: number
                                format: float
                              example:
                                - 0.01
                                - 0.02
                                - 0.03
                                - 0.04
                                - 0.05
                                - 0.06
                                - 0.07
                                - 0.08
                                - 0.089
                                - 0.099
                                - 0.109
                                - 0.119
                                - 0.129
                                - 0.139
                                - 0.149
                                - 0.159
                                - 0.169
                                - 0.179
                                - 0.189
                                - 0.199
                                - 0.209
                                - 0.219
                                - 0.229
                                - 0.239
                                - 0.249
                                - 0.259
                                - 0.268
                                - 0.278
                                - 0.288
                                - 0.298
                                - 0.308
                                - 0.318
                                - 0.328
                                - 0.338
                                - 0.348
                                - 0.358
                                - 0.368
                                - 0.378
                                - 0.388
                                - 0.398
                                - 0.408
                                - 0.418
                                - 0.428
                                - 0.437
                                - 0.447
                                - 0.457
                                - 0.467
                                - 0.477
                                - 0.487
                                - 0.497
                                - 0.507
                                - 0.517
                                - 0.527
                                - 0.537
                                - 0.547
                                - 0.557
                                - 0.567
                                - 0.577
                                - 0.587
                                - 0.597
                                - 0.606
                                - 0.616
                                - 0.626
                                - 0.636
                                - 0.646
                                - 0.656
                                - 0.666
                                - 0.676
                                - 0.686
                                - 0.696
                                - 0.706
                                - 0.716
                                - 0.726
                                - 0.736
                                - 0.746
                                - 0.756
                                - 0.766
                                - 0.776
                                - 0.785
                                - 0.795
                                - 0.805
                                - 0.815
                                - 0.825
                                - 0.835
                                - 0.845
                                - 0.855
                                - 0.865
                                - 0.875
                                - 0.885
                                - 0.895
                                - 0.905
                                - 0.915
                                - 0.925
                                - 0.935
                                - 0.945
                                - 0.954
                                - 0.964
                                - 0.974
                                - 0.984
                                - 0.994
                                - 1.004
                                - 1.014
                                - 1.024
                                - 1.034
                                - 1.044
                                - 1.054
                                - 1.064
                                - 1.074
                                - 1.084
                                - 1.094
                                - 1.104
                                - 1.114
                                - 1.124
                                - 1.133
                                - 1.143
                                - 1.153
                                - 1.163
                                - 1.173
                                - 1.183
                                - 1.193
                                - 1.203
                                - 1.213
                                - 1.223
                                - 1.233
                                - 1.243
                                - 1.253
                                - 1.263
                                - 1.273
                                - 1.283
                                - 1.293
                                - 1.302
                                - 1.312
                                - 1.322
                                - 1.332
                                - 1.342
                                - 1.352
                                - 1.362
                                - 1.372
                                - 1.382
                                - 1.392
                                - 1.402
                                - 1.412
                                - 1.422
                                - 1.432
                                - 1.442
                                - 1.452
                                - 1.462
                                - 1.471
                                - 1.481
                                - 1.491
                                - 1.501
                                - 1.511
                                - 1.521
                                - 1.531
                                - 1.541
                                - 1.551
                                - 1.561
                                - 1.571
                                - 1.581
                                - 1.591
                                - 1.601
                                - 1.611
                                - 1.621
                                - 1.631
                                - 1.641
                                - 1.65
                                - 1.66
                                - 1.67
                                - 1.68
                                - 1.69
                                - 1.7
                                - 1.71
                                - 1.72
                                - 1.73
                                - 1.74
                                - 1.75
                                - 1.76
                                - 1.77
                                - 1.78
                                - 1.79
                                - 1.8
                                - 1.81
                                - 1.819
                                - 1.829
                                - 1.839
                                - 1.849
                                - 1.859
                                - 1.869
                                - 1.879
                                - 1.889
                                - 1.899
                                - 1.909
                                - 1.919
                                - 1.929
                                - 1.939
                                - 1.949
                                - 1.959
                                - 1.969
                                - 1.979
                                - 1.988
                                - 1.998
                                - 2.008
                                - 2.018
                                - 2.028
                                - 2.038
                                - 2.048
                                - 2.058
                                - 2.068
                                - 2.078
                                - 2.088
                                - 2.098
                                - 2.108
                                - 2.118
                                - 2.128
                                - 2.138
                                - 2.148
                                - 2.158
                                - 2.167
                                - 2.177
                                - 2.187
                                - 2.197
                                - 2.207
                                - 2.217
                                - 2.227
                                - 2.237
                                - 2.247
                                - 2.257
                                - 2.267
                                - 2.277
                                - 2.287
                                - 2.297
                                - 2.307
                                - 2.317
                                - 2.327
                                - 2.336
                                - 2.346
                                - 2.356
                                - 2.366
                                - 2.376
                                - 2.386
                                - 2.396
                                - 2.406
                                - 2.416
                                - 2.426
                                - 2.436
                                - 2.446
                                - 2.456
                                - 2.466
                                - 2.476
                                - 2.486
                                - 2.496
                                - 2.506
                                - 2.512
                            Landcover codes:
                              description: |
                                Array of landcover type as referenced from ESA values.
                                * `10` - Water
                                * `20` - Trees
                                * `30` - Grass
                                * `40` - Swamp
                                * `50` - Crops
                                * `60` - Scrub
                                * `70` - Urban
                                * `80` - Rock
                                * `90` - Snow
                              type: array
                              items:
                                type: number
                                format: integer
                              example:
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 60
                                - 60
                                - 50
                                - 50
                                - 30
                                - 50
                                - 30
                                - 30
                                - 30
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 80
                                - 80
                                - 80
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 60
                                - 60
                                - 60
                                - 60
                                - 60
                                - 60
                                - 60
                                - 60
                                - 60
                                - 60
                                - 50
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 80
                                - 60
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                                - 50
                            Landcover heights:
                              description: Array of numbers of obstacle heights relative to the surface.
                              type: array
                              items:
                                type: number
                                format: integer
                              example:
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                                - 1
                            Fresnel:
                                description: Fresnel zone curve for plotting. Units are meters or feet and are reference to the line of sight path so a -5 value on a +20m LOS point above the earth would place the fresnel zone at +15m.
                                type: array
                                items:
                                  type: number
                                  format: float
                                example:
                                  - 0
                                  - -1.85
                                  - -2.61
                                  - -3.19
                                  - -3.68
                                  - -4.1
                                  - -4.49
                                  - -4.84
                                  - -5.16
                                  - -5.46
                                  - -5.74
                                  - -6.01
                                  - -6.27
                                  - -6.51
                                  - -6.74
                                  - -6.96
                                  - -7.18
                                  - -7.38
                                  - -7.58
                                  - -7.77
                                  - -7.96
                                  - -8.13
                                  - -8.31
                                  - -8.48
                                  - -8.64
                                  - -8.8
                                  - -8.95
                                  - -9.1
                                  - -9.25
                                  - -9.39
                                  - -9.53
                                  - -9.67
                                  - -9.8
                                  - -9.93
                                  - -10.06
                                  - -10.18
                                  - -10.3
                                  - -10.42
                                  - -10.53
                                  - -10.65
                                  - -10.76
                                  - -10.86
                                  - -10.97
                                  - -11.07
                                  - -11.17
                                  - -11.27
                                  - -11.37
                                  - -11.47
                                  - -11.56
                                  - -11.65
                                  - -11.74
                                  - -11.83
                                  - -11.91
                                  - -12
                                  - -12.08
                                  - -12.16
                                  - -12.24
                                  - -12.32
                                  - -12.39
                                  - -12.47
                                  - -12.54
                                  - -12.61
                                  - -12.68
                                  - -12.75
                                  - -12.81
                                  - -12.88
                                  - -12.94
                                  - -13.01
                                  - -13.07
                                  - -13.13
                                  - -13.19
                                  - -13.24
                                  - -13.3
                                  - -13.36
                                  - -13.41
                                  - -13.46
                                  - -13.51
                                  - -13.56
                                  - -13.61
                                  - -13.66
                                  - -13.71
                                  - -13.75
                                  - -13.8
                                  - -13.84
                                  - -13.88
                                  - -13.92
                                  - -13.96
                                  - -14
                                  - -14.04
                                  - -14.07
                                  - -14.11
                                  - -14.14
                                  - -14.18
                                  - -14.21
                                  - -14.24
                                  - -14.27
                                  - -14.3
                                  - -14.33
                                  - -14.36
                                  - -14.38
                                  - -14.41
                                  - -14.43
                                  - -14.46
                                  - -14.48
                                  - -14.5
                                  - -14.52
                                  - -14.54
                                  - -14.56
                                  - -14.58
                                  - -14.59
                                  - -14.61
                                  - -14.62
                                  - -14.64
                                  - -14.65
                                  - -14.66
                                  - -14.67
                                  - -14.68
                                  - -14.69
                                  - -14.7
                                  - -14.71
                                  - -14.71
                                  - -14.72
                                  - -14.72
                                  - -14.73
                                  - -14.73
                                  - -14.73
                                  - -14.73
                                  - -14.73
                                  - -14.73
                                  - -14.73
                                  - -14.73
                                  - -14.72
                                  - -14.72
                                  - -14.71
                                  - -14.7
                                  - -14.7
                                  - -14.69
                                  - -14.68
                                  - -14.67
                                  - -14.66
                                  - -14.65
                                  - -14.63
                                  - -14.62
                                  - -14.6
                                  - -14.59
                                  - -14.57
                                  - -14.55
                                  - -14.53
                                  - -14.51
                                  - -14.49
                                  - -14.47
                                  - -14.45
                                  - -14.42
                                  - -14.4
                                  - -14.37
                                  - -14.35
                                  - -14.32
                                  - -14.29
                                  - -14.26
                                  - -14.23
                                  - -14.2
                                  - -14.17
                                  - -14.13
                                  - -14.1
                                  - -14.06
                                  - -14.02
                                  - -13.99
                                  - -13.95
                                  - -13.91
                                  - -13.87
                                  - -13.82
                                  - -13.78
                                  - -13.74
                                  - -13.69
                                  - -13.64
                                  - -13.59
                                  - -13.54
                                  - -13.49
                                  - -13.44
                                  - -13.39
                                  - -13.34
                                  - -13.28
                                  - -13.22
                                  - -13.17
                                  - -13.11
                                  - -13.05
                                  - -12.98
                                  - -12.92
                                  - -12.86
                                  - -12.79
                                  - -12.72
                                  - -12.65
                                  - -12.58
                                  - -12.51
                                  - -12.44
                                  - -12.36
                                  - -12.29
                                  - -12.21
                                  - -12.13
                                  - -12.05
                                  - -11.97
                                  - -11.88
                                  - -11.8
                                  - -11.71
                                  - -11.62
                                  - -11.53
                                  - -11.43
                                  - -11.34
                                  - -11.24
                                  - -11.14
                                  - -11.04
                                  - -10.93
                                  - -10.82
                                  - -10.72
                                  - -10.6
                                  - -10.49
                                  - -10.37
                                  - -10.26
                                  - -10.13
                                  - -10.01
                                  - -9.88
                                  - -9.75
                                  - -9.62
                                  - -9.48
                                  - -9.34
                                  - -9.2
                                  - -9.05
                                  - -8.9
                                  - -8.74
                                  - -8.58
                                  - -8.42
                                  - -8.25
                                  - -8.07
                                  - -7.89
                                  - -7.7
                                  - -7.51
                                  - -7.31
                                  - -7.1
                                  - -6.88
                                  - -6.66
                                  - -6.42
                                  - -6.18
                                  - -5.92
                                  - -5.64
                                  - -5.35
                                  - -5.04
                                  - -4.71
                                  - -4.35
                                  - -3.95
                                  - -3.51
                                  - -2.99
                                  - -2.36
                                  - -1.48
                            dBm:
                                description: List of received power values along the path measured in dBm
                                type: array
                                items:
                                  type: number
                                  format: float
                                example:
                                  - -97.3
                                  - -109.1
                                  - -116.1
                                  - -121.2
                                  - -125.1
                                  - -128.4
                                  - -131.2
                                  - -133.5
                                  - -135.4
                                  - -128.5
                                  - -128.6
                                  - -129.1
                                  - -128.2
                                  - -130.6
                                  - -133.1
                                  - -135.2
                                  - -135.9
                                  - -142.1
                                  - -143.5
                                  - -145.2
                                  - -146.4
                                  - -147.4
                                  - -148.6
                                  - -149.8
                                  - -149.6
                                  - -149.7
                                  - -150.3
                                  - -150.5
                                  - -150.7
                                  - -151
                                  - -151.3
                                  - -151.7
                                  - -152
                                  - -152.5
                                  - -152.9
                                  - -153.2
                                  - -153.9
                                  - -154.2
                                  - -154.7
                                  - -155.2
                                  - -155.7
                                  - -156.2
                                  - -156.8
                                  - -157.3
                                  - -157.8
                                  - -158.3
                                  - -157.2
                                  - -155.6
                                  - -155.9
                                  - -152.7
                                  - -151.5
                                  - -146
                                  - -147.4
                                  - -146.1
                                  - -137.2
                                  - -135.8
                                  - -155.4
                                  - -161.5
                                  - -166.2
                                  - -171.9
                                  - -169.7
                                  - -169.9
                                  - -171.7
                                  - -168.1
                                  - -166.3
                                  - -165.3
                                  - -163.6
                                  - -164.1
                                  - -165.5
                                  - -165.2
                                  - -168.6
                                  - -169.6
                                  - -170.9
                                  - -171.4
                                  - -171.5
                                  - -171.8
                                  - -172.2
                                  - -171.3
                                  - -171
                                  - -169.7
                                  - -168.6
                                  - -167.5
                                  - -166.7
                                  - -166.7
                                  - -168.1
                                  - -168
                                  - -168.2
                                  - -168.1
                                  - -167.9
                                  - -167.9
                                  - -167.7
                                  - -167.6
                                  - -167.5
                                  - -167.3
                                  - -167.3
                                  - -167.1
                                  - -167
                                  - -167.1
                                  - -167.1
                                  - -167
                                  - -167
                                  - -167
                                  - -167
                                  - -167
                                  - -166.4
                                  - -165.7
                                  - -164.9
                                  - -163.7
                                  - -163
                                  - -162.6
                                  - -163
                                  - -170.2
                                  - -172.7
                                  - -174.5
                                  - -172.7
                                  - -171.8
                                  - -171.2
                                  - -170.4
                                  - -169.9
                                  - -169.4
                                  - -168.4
                                  - -167.9
                                  - -167.1
                                  - -167.3
                                  - -166.3
                                  - -164.7
                                  - -162.6
                                  - -161.4
                                  - -160.1
                                  - -159.3
                                  - -159.1
                                  - -159.2
                                  - -159.6
                                  - -160.1
                                  - -168.2
                                  - -169.6
                                  - -171.7
                                  - -174.5
                                  - -174.6
                                  - -174.6
                                  - -177
                                  - -174.5
                                  - -173.4
                                  - -171.9
                                  - -171.3
                                  - -172
                                  - -173.6
                                  - -175.8
                                  - -176.5
                                  - -177.4
                                  - -176.4
                                  - -176.1
                                  - -176
                                  - -175.8
                                  - -175.7
                                  - -178.1
                                  - -177.9
                                  - -177.8
                                  - -177.8
                                  - -177.8
                                  - -177.9
                                  - -178.1
                                  - -177.5
                                  - -177.1
                                  - -176.8
                                  - -176.5
                                  - -176.7
                                  - -176.8
                                  - -177.6
                                  - -178.6
                                  - -181.1
                                  - -184.1
                                  - -180.8
                                  - -178.6
                                  - -180.2
                                  - -177.5
                                  - -176
                                  - -179.2
                                  - -177.4
                                  - -176.6
                                  - -175.5
                                  - -174.4
                                  - -173.8
                                  - -173.5
                                  - -173.5
                                  - -173.9
                                  - -180.4
                                  - -182.3
                                  - -185.5
                                  - -190
                                  - -190.7
                                  - -192.1
                                  - -193
                                  - -193.6
                                  - -195.6
                                  - -196.6
                                  - -196.5
                                  - -198.7
                                  - -196.3
                                  - -196.2
                                  - -197.1
                                  - -196.5
                                  - -197.4
                                  - -197.5
                                  - -196.7
                                  - -197.6
                                  - -197.7
                                  - -198.2
                                  - -196.6
                                  - -199.9
                                  - -200
                                  - -198
                                  - -196
                                  - -193.9
                                  - -191.7
                                  - -188
                                  - -187.4
                                  - -186.9
                                  - -186.3
                                  - -185.6
                                  - -184.9
                                  - -183.9
                                  - -183.8
                                  - -184.4
                                  - -187.7
                                  - -194
                                  - -199.8
                                  - -195.7
                                  - -194.3
                                  - -193.5
                                  - -192
                                  - -192.4
                                  - -192.8
                                  - -193.2
                                  - -193.3
                                  - -193.2
                                  - -193
                                  - -192.2
                                  - -191.7
                                  - -191.3
                                  - -191.1
                                  - -190.8
                                  - -190.5
                                  - -191.1
                                  - -191.8
                                  - -198.1
                                  - -201.9
                                  - -203.9
                                  - -205.3
                                  - -206.4
                                  - -208
                                  - -206.5
                                  - -205.6
                            dB:
                                description: List of path loss values along the path measured in dB
                                type: array
                                items:
                                  type: number
                                  format: float
                                example:
                                  - 117.3
                                  - 129.1
                                  - 136.1
                                  - 141.2
                                  - 145.1
                                  - 148.4
                                  - 151.2
                                  - 153.5
                                  - 155.4
                                  - 148.5
                                  - 148.6
                                  - 149.1
                                  - 148.2
                                  - 150.6
                                  - 153.1
                                  - 155.2
                                  - 155.9
                                  - 162.1
                                  - 163.5
                                  - 165.2
                                  - 166.4
                                  - 167.4
                                  - 168.6
                                  - 169.8
                                  - 169.6
                                  - 169.7
                                  - 170.3
                                  - 170.5
                                  - 170.7
                                  - 171
                                  - 171.3
                                  - 171.7
                                  - 172
                                  - 172.5
                                  - 172.9
                                  - 173.2
                                  - 173.9
                                  - 174.2
                                  - 174.7
                                  - 175.2
                                  - 175.7
                                  - 176.2
                                  - 176.8
                                  - 177.3
                                  - 177.8
                                  - 178.3
                                  - 177.2
                                  - 175.6
                                  - 175.9
                                  - 172.7
                                  - 171.5
                                  - 166
                                  - 167.4
                                  - 166.1
                                  - 157.2
                                  - 155.8
                                  - 175.4
                                  - 181.5
                                  - 186.2
                                  - 191.9
                                  - 189.7
                                  - 189.9
                                  - 191.7
                                  - 188.1
                                  - 186.3
                                  - 185.3
                                  - 183.6
                                  - 184.1
                                  - 185.5
                                  - 185.2
                                  - 188.6
                                  - 189.6
                                  - 190.9
                                  - 191.4
                                  - 191.5
                                  - 191.8
                                  - 192.2
                                  - 191.3
                                  - 191
                                  - 189.7
                                  - 188.6
                                  - 187.5
                                  - 186.7
                                  - 186.7
                                  - 188.1
                                  - 188
                                  - 188.2
                                  - 188.1
                                  - 187.9
                                  - 187.9
                                  - 187.7
                                  - 187.6
                                  - 187.5
                                  - 187.3
                                  - 187.3
                                  - 187.1
                                  - 187
                                  - 187.1
                                  - 187.1
                                  - 187
                                  - 187
                                  - 187
                                  - 187
                                  - 187
                                  - 186.4
                                  - 185.7
                                  - 184.9
                                  - 183.7
                                  - 183
                                  - 182.6
                                  - 183
                                  - 190.2
                                  - 192.7
                                  - 194.5
                                  - 192.7
                                  - 191.8
                                  - 191.2
                                  - 190.4
                                  - 189.9
                                  - 189.4
                                  - 188.4
                                  - 187.9
                                  - 187.1
                                  - 187.3
                                  - 186.3
                                  - 184.7
                                  - 182.6
                                  - 181.4
                                  - 180.1
                                  - 179.3
                                  - 179.1
                                  - 179.2
                                  - 179.6
                                  - 180.1
                                  - 188.2
                                  - 189.6
                                  - 191.7
                                  - 194.5
                                  - 194.6
                                  - 194.6
                                  - 197
                                  - 194.5
                                  - 193.4
                                  - 191.9
                                  - 191.3
                                  - 192
                                  - 193.6
                                  - 195.8
                                  - 196.5
                                  - 197.4
                                  - 196.4
                                  - 196.1
                                  - 196
                                  - 195.8
                                  - 195.7
                                  - 198.1
                                  - 197.9
                                  - 197.8
                                  - 197.8
                                  - 197.8
                                  - 197.9
                                  - 198.1
                                  - 197.5
                                  - 197.1
                                  - 196.8
                                  - 196.5
                                  - 196.7
                                  - 196.8
                                  - 197.6
                                  - 198.6
                                  - 201.1
                                  - 204.1
                                  - 200.8
                                  - 198.6
                                  - 200.2
                                  - 197.5
                                  - 196
                                  - 199.2
                                  - 197.4
                                  - 196.6
                                  - 195.5
                                  - 194.4
                                  - 193.8
                                  - 193.5
                                  - 193.5
                                  - 193.9
                                  - 200.4
                                  - 202.3
                                  - 205.5
                                  - 210
                                  - 210.7
                                  - 212.1
                                  - 213
                                  - 213.6
                                  - 215.6
                                  - 216.6
                                  - 216.5
                                  - 218.7
                                  - 216.3
                                  - 216.2
                                  - 217.1
                                  - 216.5
                                  - 217.4
                                  - 217.5
                                  - 216.7
                                  - 217.6
                                  - 217.7
                                  - 218.2
                                  - 216.6
                                  - 219.9
                                  - 220
                                  - 218
                                  - 216
                                  - 213.9
                                  - 211.7
                                  - 208
                                  - 207.4
                                  - 206.9
                                  - 206.3
                                  - 205.6
                                  - 204.9
                                  - 203.9
                                  - 203.8
                                  - 204.4
                                  - 207.7
                                  - 214
                                  - 219.8
                                  - 215.7
                                  - 214.3
                                  - 213.5
                                  - 212
                                  - 212.4
                                  - 212.8
                                  - 213.2
                                  - 213.3
                                  - 213.2
                                  - 213
                                  - 212.2
                                  - 211.7
                                  - 211.3
                                  - 211.1
                                  - 210.8
                                  - 210.5
                                  - 211.1
                                  - 211.8
                                  - 218.1
                                  - 221.9
                                  - 223.9
                                  - 225.3
                                  - 226.4
                                  - 228
                                  - 226.5
                                  - 225.6
  /points:
    post:
      operationId: points
      description: 'This endpoint allows users to test many point-to-point links in one call. The points function tests many transmitters to one receiver and is designed for route analysis and smart meter rollouts. The simplest request requires: transmitter’s array of tuples (latitude, longitude, altitude) locations, antenna, receiver, and output objects defined. Model and environment options enhance accuracy.'
      tags:
        - Create
      summary: 'Point-to-multipoint path profile analysis (many Tx, one Rx)'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                site:
                  description: Name of site.
                  type: string
                  default: Points
                  minLength: 1
                  maxLength: 24
                network:
                  description: Network name/group.
                  type: string
                  default: Testing
                  minLength: 1
                  maxLength: 24
                transmitter:
                  $ref: '#/components/schemas/Transmitter'
                points:
                  type: array
                  items:
                    $ref: '#/components/schemas/Point'
                antenna:
                  $ref: '#/components/schemas/Antenna'
                receiver:
                  $ref: '#/components/schemas/Receiver'
                model:
                  $ref: '#/components/schemas/Model'
                environment:
                  $ref: '#/components/schemas/Environment'
                output:
                  $ref: '#/components/schemas/Output'
            examples:
              example-points:
                value:
                  site: Points
                  network: Testing
                  transmitter:
                    lat: 38.916
                    lon: 1.448
                    alt: 1
                    frq: 868
                    txw: 0.1
                    bwi: 0.1
                  points:
                    - lat: 38.916
                      lon: 1.411
                      alt: 1
                    - lat: 38.916
                      lon: 1.411
                      alt: 1
                  antenna:
                    txg: 2.15
                    txl: 0
                    ant: 1
                    azi: 0
                    tlt: 0
                    hbw: 0
                    vbw: 0
                    pol: v
                  receiver:
                    lat: 38.906986
                    lon: 1.421416
                    alt: 0.1
                    rxg: 2.15
                    rxs: -90
                  model:
                    pm: 1
                    pe: 2
                    cli: 6
                    ked: 0
                    rel: 95
                    ter: 4
                  environment:
                    clm: 1
                    cll: 2
                    mat: 0.25
                  output:
                    units: metric
                    col: RAINBOW.dBm
                    out: 2
                    ber: 0
                    mod: 1
                    nf: -114
                    res: 10
                    rad: 5
      responses:
        '200':
          description: Success – JSON object returned with array of transmitters; each containing an abridged path output with just the signal strength measurements and geometry.
          content:
            application/json:
              schema:
                type: object
                description: An object containing the results of the /path call.
                properties:
                    Engine:
                        type: string
                        description: Engine version string used
                        example: Sleipnir 1.4.4
                    kmz:
                        type: string
                        format: uri
                        description: URL to KMZ file.
                        example: 'https://api.cloudrf.com/API/archive/data?path=0728132101_Testing_PPA&uid=40843'
                    Chart image:
                        type: string
                        format: uri
                        description: URL to PNG image file.
                        example: 'https://api.cloudrf.com/API/archive/data?ppa=0728132101_Testing_PPA&uid=40843'
                    elapsed:
                        description: Time taken for API call (milliseconds).
                        type: number
                        format: Int32
                        example: 135
                    Frequency MHz:
                        description: Center frequency in megahertz.
                        type: number
                        format: float
                        example: 868
                    Propagation model:
                        description: 'Propagation model: 1 = ITM / Irregular Terrain Model (aka Longley Rice); 2 = LOS / Line of Sight; 3 = Okumura-Hata; 4 = ITU-R P.529 VHF/UHF, 5 = SUI / Stanford University Interim Microwave; 6 = COST231; 7 = Free space path loss; 8 = Reserved; 9 = Ericsson9999; 10 = Plane earth loss; 11 = Egli'
                        type: string
                        example: ITM
                    Earth dielectric constant:
                        description: ITM model only. 3 = City/Industrial, 5 = City, 13 = Mountain / Sand, 15 = Average ground / Arable, 25 = Good ground, 80 = Water. Ref https://www.qsl.net/n9zia/conduct.html
                        type: number
                        format: float
                        example: 14
                    Earth conductivity:
                        description: ITM model only. Corresponding conductivity measured in S/m ranging from 0.001 to 5.0. Ref https://www.qsl.net/n9zia/conduct.html
                        type: number
                        format: float
                        example: 0.01
                    Radio climate:
                        description: ITM model only. ITU climate codes. 1 = Equatorial, 2 = Continental Subtropical, 3 = Maritime Subtropical, 4 = Desert, 5 = Continental Temperate, 6 = Maritime temperate (Land), 7 = Maritime temperate (sea)
                        type: string
                        enum:
                            - Equatorial (Congo)
                            - Continental Subtropical (Sudan)
                            - Maritime Subtropical (West coast of Africa)
                            - Desert (Sahara)
                            - Continental Temperate
                            - Maritime Temperate (Land)
                            - Maritime Temperate (Sea)
                        example: Maritime Temperate (Land)
                    Atmospheric bending constant:
                        description: ITM model only. Number describing atmospheric refractive index. Default is 301
                        type: number
                        format: Int32
                        example: 301
                    Fraction of situations:
                        description: ITM model only. Reliability value for a given location. Default is 90%
                        type: number
                        format: Int32
                        example: 90
                    Fraction of time:
                        description: ITM model only. Reliability value for a given time. Default is 90%
                        type: number
                        format: Int32
                        example: 90
                    Receiver:
                        type: object
                        properties:
                            Latitude:
                                description: Receiver's latitude provided in call in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 38.90699
                            Longitude:
                                description: Receiver's longitude provided in call in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 1.421416
                            Ground elevation m:
                                description: Ground elevation above mean sea level (AMSL) in either meters or feet as set by distance units.
                                type: number
                                format: float
                                example: 22
                            Antenna height m:
                                description: Antenna height above ground level in meters or feet as provided in API call.
                                type: number
                                format: float
                                example: 1
                            Receiver gain dBd:
                                description: Receive antenna gain measured in decibels relative to a dipole antenna (2.15dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 0.0
                            Receiver gain dBi:
                                description: Receive antenna gain measured in decibels relative to an isotropic antenna (0dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 2.15
                    Transmitters:
                        type: object
                        properties:
                            Latitude:
                                description: Latitude of transmitter in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 38.916
                            Longitude:
                                description: Longitude of transmitter in WGS84 decimal degrees.
                                type: number
                                format: float
                                example: 1.448
                            Ground elevation m:
                                description: Ground elevation above mean sea level (AMSL) in either meters or feet as set by distance units.
                                type: number
                                format: float
                                example: 1
                            Antenna height m:
                                description: Antenna height above ground level in meters or feet as provided in API call.
                                type: number
                                format: float
                                example: 1
                            Distance to receiver km:
                                description: Distance between transmitter and receiver in kilometers OR miles measured from the base of the antennas. Units determined within output object.
                                type: number
                                format: float
                                example: 2.512
                            Azimuth to receiver deg:
                                description: Angle in degrees referenced to grid north from the transmitter base to the receiver base.
                                type: number
                                format: float
                                example: 246.46
                            Downtilt angle deg:
                                description: Angle in degrees from the transmitter to the receiver relative the horizon (0.0). A positive value is below the horizon (looking downhill).
                                type: number
                                format: float
                                example: 0.0
                            Antenna gain dBd:
                                description: Transmit antenna gain measured in decibels relative to a dipole antenna (2.15dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 0.0
                            Antenna gain dBi:
                                description: Transmit antenna gain measured in decibels relative to a isotropic antenna (0dB). 0dBd = 2.15dBi
                                type: number
                                format: float
                                example: 2.15
                            Polarisation:
                                description: Antenna polarisation as requested. Either Horizontal or Vertical.
                                type: string
                                example: Horizontal
                            Power W:
                                description: Transmit power before antenna measured in Watts.
                                type: number
                                format: float
                                example: 2.0
                            Power dBm:
                                description: Transmit power before antenna measured in decibel milliwatts
                                type: string
                                example: 35.16
                            ERP W:
                                description: Transmitter Effective Radiated Power (dipole) after antenna gain in Watts.
                                type: number
                                format: float
                                example: 2.0
                            EIRP W:
                                description: Transmitter Effective Isotropic Radiated Power (isotropic) after antenna gain in Watts.
                                type: number
                                format: float
                                example: 3.28
                            ERP dBm:
                                description: Transmitter Effective Radiated Power (dipole) after antenna gain in decibel milliwatts
                                type: number
                                format: float
                                example: 3.28
                            EIRP dBm:
                                description: Transmitter Effective Isotropic Radiated Power (isotropic) after antenna gain in decibel milliwatts
                                type: number
                                format: float
                                example: 35.16
                            Free space path loss dB:
                                description: Pure link path loss using ITU-R P.525 measured in decibels
                                type: number
                                format: float
                                example: 92
                            Bandwidth MHz:
                                description: Signal bandwidth measured in megahertz
                                type: number
                                format: float
                                example: 1.0
                            Signal power at receiver dBm:
                                description: Received signal power at receiver measured in decibel milliwatts (dBm)
                                type: number
                                format: float
                                example: -128.9
                            server:
                              description: Numerical identifier for this server / node. A points call with 100 nodes would return 100 servers numbered 1 to 100.
                              type: integer
                              format: int32
                              example: 1
  /bsa:
    post:
      operationId: bsa
      tags:
        - Analyse
      summary: Find the best site in a radius from a given location.
      description: |
        The best site analysis (BSA) endpoint can be used to find the best locations in a large area for a transmitter.
        Please note that the response of a BSA calculation is not of signal strength. Instead it is a normalised image where heatspots are a better location for placing your transmitter.
        The response for BSA is a greyscale image.
        BSA calculations require a gold or platinum subscription plan.
      requestBody:
        content:
            application/json:
              schema:
                type: object
                properties:
                  site:
                    description: Name of site.
                    type: string
                    default: BSA
                    minLength: 1
                    maxLength: 24
                  network:
                    description: Network name/group.
                    type: string
                    default: BSA
                    minLength: 1
                    maxLength: 24
                  transmitter:
                    $ref: '#/components/schemas/Transmitter'
                  antenna:
                    $ref: '#/components/schemas/Antenna'
                  receiver:
                    type: object
                    properties:
                      lat:
                        description: Latitude of receiver in WGS84 decimal degrees.
                        type: number
                        format: float
                        minimum: -89
                        maximum: 89
                        default: 0
                        example: 0
                      lon:
                        description: Longitude of receiver in WGS84 decimal degrees.
                        type: number
                        format: float
                        minimum: -180
                        maximum: 180
                        default: 0
                        example: 0
                      alt:
                        description: Altitude of receiver above ground level in `metric` or `imperial`. Distance unit set in `output` object.
                        type: number
                        format: integer
                        minimum: 1
                        maximum: 120000
                        default: 1
                        example: 1
                      rxg:
                        description: Receiver antenna gain in dBi.
                        type: number
                        format: float
                        minimum: -10
                        maximum: 60
                        default: 2.15
                        example: 3
                      rxs:
                        description: Receiver sensitivity/threshold in measured units. Measured units set in `output` object.
                        type: number
                        format: float
                        minimum: -140
                        maximum: 200
                        default: -90
                        example: -100
                  output:
                    type: object
                    properties:
                      units:
                        description: |
                          Define global distance units applied to heights and distances:
                          * `metric` - Define units in meters and kilometers.
                          * `imperial` - Define units in feet and miles.
                        type: string
                        default: metric
                        enum:
                          - metric
                          - imperial
                      col:
                        description: |
                          BSA colour schema

                          Filename examples: 

                          * BESTSITE.bsa
                          * CUSTOMSCHEMA.bsa

                          Please note that if you have created your own custom colour schema then you can use the name of the schema here.
                        type: string
                        default: BESTSITE.bsa
                      out:
                        description: Measured units for best site analysis in percentage.
                        type: number
                        format: integer
                        default: 7
                        example: 7
                      res:
                        description: Resolution in meters for produced output. A high resolution (eg. 2m) is much slower than a medium resolution (eg. 20m) for area calculations.
                        type: number
                        format: integer
                        minimum: 1
                        maximum: 300
                        default: 10
                        example: 10
                      rad:
                        description: Radius in kilometers for output. This is how far the area of your BSA calculation you wish to reach.
                        type: number
                        format: float
                        minimum: 0.03
                        maximum: 400
                        default: 5
                        example: 5
                        responses:
      responses:
        '200':
          description: Success – JSON object returned containing greyscale image URLs, color key values, and calculation statistics.
          content:
            application/json:
              schema:
                type: object
                description: An object containing the results of the /bsa call.
                properties:
                    kmz:
                      type: string
                      description: URL to KMZ file.
                      example: 'https://api.cloudrf.com/archive/bjdRdXlOUUpJV0FEOGpwUFh5bS91QT09/kmz'
                    PNG_WGS84:
                      type: string
                      format: uri
                      description: URL to image file applying the WGS84 standard.
                      example: 'https://api.cloudrf.com/users/1/0805143742_BSA_BSA.4326.png'
                    PNG_Mercator:
                      type: string
                      format: uri
                      description: URL to image file applying the Mercartor projection standard.
                      example: 'https://api.cloudrf.com/users/1/0805143742_BSA_BSA.3857.png'
                    bounds:
                      type: array
                      description: A list of image bounds as WGS84 decimal degrees. Order is clockwise from North,East,South,West.
                      items:
                        type: integer
                        format: float
                        example:
                          - 38.96091398221914
                          - 1.5057877843205172
                          - 38.871086017780854
                          - 1.3902122156794827
                    id:
                      type: string
                      description: Unique system identifier for the calculation. This is a one-up number from the main log table.
                      example: 4371076
                    sid:
                      type: string
                      description: Private unique system identifier for the calculation. This is a hash of the one-up number from the main log table intended for public maps etc.
                      example: bjdRdXlOUUpJV0FEOGpwUFh5bS91QT09
                    area:
                      type: string
                      description: Coverage area measured in kilometers squared.
                      example: 0
                    coverage:
                      type: string
                      description: Site efficiency computed from requested radius versus actual coverage area. A perfect circle out at sea would be 100% efficient.
                      example: 0
                    key:
                      type: array
                      description: Array of objects describing the RGB color schema as signal level in %, red, green and blue where red would be rgb(255,0,0).
                      items:
                        type: object
                        properties:
                          l:
                            type: string
                            description: Best site value percentage
                            example: '70%'
                          r:
                            description: RED colour intensity. 0 to 255.
                            type: integer
                            example: 255
                          g:
                            description: GREEN colour intensity. 0 to 255.
                            type: integer
                            example: 19
                          b:
                            description: BLUE colour intensity. 0 to 255.
                            type: integer
                            example: 0
                        example:
                          - l: '100%'
                            r: 107
                            g: 254
                            b: 1
                          - l: '90%'
                            r: 147
                            g: 251
                            b: 5
                          - l: '80%'
                            r: 184
                            g: 248
                            b: 8
                          - l: '70%'
                            r: 219
                            g: 244
                            b: 12
                          - l: '60%'
                            r: 241
                            g: 230
                            b: 16
                          - l: '50%'
                            r: 237
                            g: 192
                            b: 20
                          - l: '40%'
                            r: 234
                            g: 157
                            b: 23
                          - l: '30%'
                            r: 230
                            g: 124
                            b: 27
                          - l: '20%'
                            r: 227
                            g: 64
                            b: 34
                          - l: '10%'
                            r: 223
                            g: 64
                            b: 34
                          - l: '00%'
                            r: 220
                            g: 38
                            b: 38
                    elapsed:
                      description: Time taken for API call (milliseconds).
                      type: number
                      format: int32
                      example: 1572
                    balance:
                      description: API call credit usage. Only applies to public system.
                      type: integer
                      format: int32
                      example: 1

  /mesh:
    get:
      operationId: mesh
      tags:
        - Analyse
      summary: Merge sites into a super layer.
      description: |
        This endpoint returns a consolidated layer of many `area` calculations as a single super layer.
        Stronger signals are promoted over weaker ones. 
        **A consistent color schema for sites must be used.**
      parameters:
        - in: query
          name: network
          schema:
            type: string
            description: Network name.
            example: 100_BLUE_repeaters_nationwide.
          required: true
        - in: query
          required: true
          name: name
          schema:
            type: string
            description: Super layer name.
            example: National_map
      responses:
        '200':
          description: Success.
  /interference:
    get:
      operationId: interference
      tags:
        - Analyse
      summary: Find the best server for overlapping coverage
      description: This endpoint allows users to merge and analyze sites within a network channel to determine the best server at a given location. Each site will be dynamically allocated a monochrome color from a palette and the strongest signal promoted at a given location.
      parameters:
        - in: query
          required: true
          description: Network name.
          name: network
          schema:
            type: string
            example: Overlapping broadcast stations
        - in: query
          required: true
          description: Interference layer name.
          name: name
          schema:
            type: string
            example: QRM_map
      responses:
        '200':
          description: Returns a PNG URL along with image bounds in WGS84 coordinates, clockwise from North.
          content: {}
  /network:
    get:
      operationId: network
      tags:
        - Analyse
      summary: Find the best server for a location
      description: 'This endpoint allows users to query the network to find the best server(s) for a given receiver/customer location. A previously generated network is required. This method returns more data than the points API as it includes the arrays for terrain, landcover, obstructions, and path loss for each server.'
      parameters:
        - in: query
          required: true
          description: Network name.
          name: net
          schema:
            type: string
        - in: query
          required: true
          description: Super layer name.
          name: nam
          schema:
            type: string
        - in: query
          required: true
          description: Latitude in decimal degrees.
          name: lat
          schema:
            type: number
            format: float
        - in: query
          required: true
          description: Longitude in decimal degrees.
          name: lon
          schema:
            type: number
            format: float
        - in: query
          required: true
          description: Height above ground level in meters.
          name: alt
          schema:
            type: number
            format: float
        - in: query
          required: false
          description: Receiver gain in dBi.
          name: rxg
          schema:
            type: number
            format: float
      responses:
        '200':
          description: Success – JSON object returned providing results with a detailed path-profile output for each server.
          content: {}
  /archive/list:
    get:
      operationId: list
      tags:
        - Manage
      summary: List calculations from archive
      description: This endpoint allows users to list area and path calculations – sorted by time and limited to the last few hundred. To fetch all for a given network append a "net" filter with the network name.
      parameters:
        - in: query
          required: false
          description: North bounding box. WGS84 decimal degrees.
          name: 'n'
          schema:
            type: number
            format: float
            example: 65
        - in: query
          required: false
          description: East bounding box. WGS84 decimal degrees.
          name: e
          schema:
            type: number
            format: float
            example: 2
        - in: query
          required: false
          description: South bounding box. WGS84 decimal degrees.
          name: s
          schema:
            type: number
            format: float
            example: 50
        - in: query
          required: false
          description: West bounding box. WGS84 decimal degrees.
          name: w
          schema:
            type: number
            format: float
            example: -5
      responses:
        '200':
          description: Success – JSON array returned providing  of site names and limited metadata.
          content: {}
  /archive/delete:
    get:
      operationId: delete
      tags:
        - Manage
      summary: Delete calculation from database
      description: |
        **Warning! You could lose data.** 
        This endpoint deletes the entry from the database and the file from the disk.
        This deletes a single calculation from the database and from your folder. 
      parameters:
        - in: query
          required: true
          description: Unique calculation ID number.
          name: cid
          schema:
            type: integer
      responses:
        '200':
          description: Success – message returned confirming the number of sites deleted and elapsed time.
          content: {}
  /archive/delete/network:
    get:
      operationId: deleteNetwork
      tags:
        - Manage
      summary: Delete entire network
      description: |
        **Warning! You could lose lots of data.** 
        This endpoint deletes all associated child entries from the database and the files from the disk.
      parameters:
        - in: query
          required: true
          description: Network name.
          name: nid
          schema:
            type: string
      responses:
        '200':
          description: A message confirming the number of sites deleted and elapsed time.
          content: {}
  /archive/export:
    get:
      operationId: export
      tags:
        - Manage
      summary: Export calculation in GIS file format
      description: |
        This endpoint downloads your data in a format suitable for a third-party viewer such as Google Earth or ESRI Arcmap.
        Supported formats:
        * KML
        * KMZ
        * GeoTIFF
        * SHP
        * URL
        * HTML
      parameters:
        - in: query
          required: true
          description: Calculation file name.
          name: file
          schema:
            type: string
        - in: query
          required: true
          description: 'Required file format: KML; KMZ; SHP; GeoTIFF or ATAK ZIP'
          name: fmt
          schema:
            type: string
            enum:
              - kml
              - kmzppa
              - shp
              - tiff
              - zip
      responses:
        '200':
          description: Success – file download URL with the MIME type returned.
          content: {}
  /clutter/add:
    post:
      operationId: addClutter
      tags:
        - Manage
      summary: Upload clutter data as GeoJSON
      description: This endpoint supports upload of GeoJSON lineString and polygon features to your account.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  default: Clutter
                type:
                  type: string
                  default: FeatureCollection
                features:
                  type: array
                  items:
                    $ref: '#/components/schemas/Feature'
            examples:
              example-add-clutter:
                value:
                  name: Clutter
                  type: FeatureCollection
                  features:
                    - type: Feature
                      features:
                        geometry: Polygon
                        coordinates:
                          - - -2.648749
                            - 51.639982
                          - - -2.648814
                            - 51.641129
                          - - -2.647935
                            - 51.641446
                          - - -2.646937
                            - 51.64096
                          - - -2.647176
                            - 51.640137
                          - - -2.646178
                            - 51.639692
                          - - -2.647154
                            - 51.638546
                          - - -2.647827
                            - 51.639544
                          - - -2.648749
                            - 51.639982
                        properties:
                          height: '4'
                          material: '1'
      responses:
        '200':
          description: Success – JSON information message returned with count of clutter items added.
          content:
            application/json:
              schema:
                description: Count of clutter items.
                properties:
                  info:
                    type: string
                    example: Added 1 item(s) of clutter. Rejected 0 item(s) of clutter. Total 1 items(s) of clutter exist on your profile.
  /clutter/get/{latitude}/{longitude}:
    get:
      operationId: getClutter
      tags:
        - Manage
      summary: Get private clutter data for a location.
      description: |
        This endpoint fetches private clutter items for the given co-ordinates out to 1 decimal degree radius (approximately 120 km at the equator). 
        Results are limited to 100 items sorted by nearest first. 
        GeoJSON coordinates are passed as a clean URL, for example, `https://api.cloudrf.com/clutter/get/51.637723/-2.649606`
      parameters:
        - in: query
          required: true
          name: latitude
          description: GeoJSON coordinate latitude in decimal degrees.
          schema:
            type: number
            format: float
            example: 51.637723
        - in: query
          required: true
          name: longitude
          description: GeoJSON coordinate longitude in decimal degrees.
          schema:
            type: number
            format: float
            example: -2.649606
      responses:
        '200':
          description: Success – JSON Feature Collection array returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  features:
                    $ref: '#/components/schemas/Feature'
                  id:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Clutter identifier
                        example: '643'
  /clutter/delete/{id}:
    get:
      operationId: deleteClutter
      tags:
        - Manage
      summary: Delete clutter item by its ID
      description: |
        Delete a private clutter item referenced by its `id` passed as a clean URL. For example, `/clutter/delete/123`
        The `id` is returned by the get clutter endpoint (`/clutter/get`)
        Please note that if you pass in an `id` value of `0` then all clutter for your profile will be deleted.
      parameters:
        - in: query
          required: true
          description: Clutter `id` number.
          name: id
          schema:
            type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  info:
                    type: string
                    example: 'Deleted a total of 1 clutter entries. ID #2858 deleted.'
  /clutter/delete/0:
    get:
      operationId: deleteAllClutter
      tags:
        - Manage
      summary: Delete all clutter on your profile
      description: |
        Similar to `/clutter/delete/{id}`, however if you pass an `id` value of `0` then you will delete all clutter on your profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  info:
                    type: string
                    example: 'Deleted a total of 4 clutter entries.'
  /my-metrics:
    get:
      operationId: myMetrics
      tags:
        - Account
      summary: Get metrics and statistics for your account API usage.
      description: |
        Get a detailed breakdown of metrics and statistics for your account API usage over your purchase period. 
        This includes a breakdown of total API requests and their types, along with the different types of requests which were made on each day.
      responses:
        '200':
          description: Success – JSON object returned containing metrics and statistics.
          content:
            application/json:
              schema:
                type: object
                description: An object containing the results of the /bsa call.
                properties:
                  from:
                    type: string
                    format: date-time
                    description: The period over which the metrics have been calculated.
                    example: '2022-07-10 13:06:36.851'
                  count_total:
                    type: number
                    format: integer
                    description: The total number of requests over the period.
                    example: 2279
                  time_series:
                    type: object
                    description: Array of objects describing the total calculation of each type for each day in ISO8601 format.
                    properties:
                      YYYY-MM-DD:
                        type: object
                        properties:
                          area:
                            type: number
                            format: integer
                            description: The number of area calculations on the day.
                          path:
                            type: number
                            format: integer
                            description: The number of path calculations on the day.
                          points:
                            type: number
                            format: integer
                            description: The number of points calculations on the day.
                          mesh:
                            type: number
                            format: integer
                            description: The number of mesh calculations on the day.
                          interference:
                            type: number
                            format: integer
                            description: The number of interference calculations on the day.
                          network:
                            type: number
                            format: integer
                            description: The number of network calculations on the day.
                          best_site_analysis:
                            type: number
                            format: integer
                            description: The number of best site analysis calculations on the day.
                    example:
                    - '2022-07-11':
                      - area: 1
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-07-12':
                      - area: 102
                        path: 6
                        points: 15
                        mesh: 6
                        interference: 6
                        network: 6
                        best_site_analysis: 0
                    - '2022-07-13':
                      - area: 45
                        path: 1
                        points: 2
                        mesh: 1
                        interference: 1
                        network: 1
                        best_site_analysis: 0
                    - '2022-07-14':
                      - area: 31
                        path: 3
                        points: 6
                        mesh: 3
                        interference: 3
                        network: 3
                        best_site_analysis: 0
                    - '2022-07-15':
                      - area: 45
                        path: 4
                        points: 73
                        mesh: 4
                        interference: 4
                        network: 4
                        best_site_analysis: 0
                    - '2022-07-18':
                      - area: 62
                        path: 25
                        points: 23
                        mesh: 6
                        interference: 6
                        network: 13
                        best_site_analysis: 0
                    - '2022-07-20':
                      - area: 217
                        path: 76
                        points: 40
                        mesh: 20
                        interference: 20
                        network: 20
                        best_site_analysis: 0
                    - '2022-07-21':
                      - area: 30
                        path: 2
                        points: 6
                        mesh: 3
                        interference: 3
                        network: 3
                        best_site_analysis: 0
                    - '2022-07-22':
                      - area: 0
                        path: 22
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-07-25':
                      - area: 102
                        path: 3
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 35
                    - '2022-07-26':
                      - area: 134
                        path: 0
                        points: 375
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 20
                    - '2022-07-27':
                      - area: 11
                        path: 1
                        points: 29
                        mesh: 1
                        interference: 1
                        network: 1
                        best_site_analysis: 4
                    - '2022-07-28':
                      - area: 10
                        path: 53
                        points: 2
                        mesh: 1
                        interference: 1
                        network: 1
                        best_site_analysis: 0
                    - '2022-07-29':
                      - area: 0
                        path: 37
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-08-01':
                      - area: 50
                        path: 1
                        points: 19
                        mesh: 1
                        interference: 3
                        network: 1
                        best_site_analysis: 9
                    - '2022-08-02':
                      - area: 56
                        path: 4
                        points: 8
                        mesh: 1
                        interference: 2
                        network: 4
                        best_site_analysis: 0
                    - '2022-08-03':
                      - area: 109
                        path: 11
                        points: 92
                        mesh: 11
                        interference: 14
                        network: 11
                        best_site_analysis: 0
                    - '2022-08-04':
                      - area: 1
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-08-05':
                      - area: 15
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 23
                    - '2022-08-08':
                      - area: 1
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 3
                    - '2022-08-09':
                      - area: 30
                        path: 1
                        points: 2
                        mesh: 0
                        interference: 0
                        network: 1
                        best_site_analysis: 0
                  types_total:
                    type: object
                    description: Object containing a total count of each of the different types of calculations over the period.
                    properties:
                      area:
                        type: number
                        format: integer
                        description: Count total of the number of area calculations over the period.
                        example: 1052
                      path:
                        type: number
                        format: integer
                        description: Count total of the number of path calculations over the period.
                        example: 250
                      points:
                        type: number
                        format: integer
                        description: Count total of the number of points calculations over the period.
                        example: 692
                      mesh:
                        type: number
                        format: integer
                        description: Count total of the number of mesh calculations over the period.
                        example: 58
                      interference:
                        type: number
                        format: integer
                        description: Count total of the number of interference calculations over the period.
                        example: 64
                      network:
                        type: number
                        format: integer
                        description: Count total of the number of network calculations over the period.
                        example: 69
                      best_site_analysis:
                        type: number
                        format: integer
                        description: Count total of the number of best site analysis calculations over the period.
                        example: 94

components:
  schemas:
    Transmitter:
      type: object
      properties:
        lat:
          description: Latitude of transmitter in WGS84 decimal degrees.
          type: number
          format: float
          minimum: -89
          maximum: 89
          default: 38.916
          example: 38.916
        lon:
          description: Longitude of transmitter in WGS84 decimal degrees.
          type: number
          format: float
          minimum: -180
          maximum: 180
          default: 1.448
          example: 1.448
        alt:
          description: Altitude of transmitter above ground level in `metric` or `imperial`. Distance unit set in `output` object.
          type: number
          format: float
          minimum: 0.1
          maximum: 120000
          default: 1
          example: 1
        frq:
          description: Center frequency in megahertz.
          type: number
          format: float
          minimum: 2
          maximum: 100000
          default: 868
          example: 868
        txw:
          description: Transmitter power in watts before the antenna.
          type: number
          format: float
          minimum: 0.001
          maximum: 2000000
          default: 0.1
          example: 0.1
        bwi:
          description: |
            Bandwidth in MHz. 
            * 1MHz has a noise floor of -114dBm
            * 10MHz has a noise floor of -104dBm
            * 20MHz has a noise floor of -101dBm
          type: number
          format: float
          minimum: 0.1
          maximum: 100
          default: 0.1
          example: 1
    Antenna:
      type: object
      properties:
        txg:
          description: Transmitter antenna gain in dBi. A half-wave dipole has a gain of 2.15dBi. A mobile phone is 0 to 2dBi, depending on the frequency.
          type: number
          format: float
          minimum: -10
          maximum: 60
          default: 2.15
          example: 2.15
        txl:
          description: Feeder loss in dB. A long feeder has more loss. Loss varies by material and wavelength eg. LMR-400
          type: number
          format: float
          minimum: 0
          maximum: 60
          default: 0
          example: 1
        ant:
          description: |
            Antenna pattern code:
            * `0` - Allows custom options (see: `hbw`; `vbw`; `fbr`)
            * `1` - Vertical dipole (omni-directional)
          type: number
          format: integer
          default: 1
          example: 0
          enum:
            - 0
            - 1
        azi:
          description: Antenna azimuth in degrees north.
          type: number
          format: float
          minimum: 0
          maximum: 360
          default: 0
          example: 1
        tlt:
          description: Antenna tilt in degrees below the horizon (inverted) where horizon is `0`.
          type: number
          format: float
          minimum: -90
          maximum: 90
          default: 0
          example: 10
        hbw:
          description: Custom antenna horizontal beamwidth in degrees. For use only with `ant` value of `0`.
          type: number
          format: float
          minimum: 0
          maximum: 360
          default: 0
          example: 2
        vbw:
          description: Custom antenna vertical beamwidth in degrees. For use only with `ant` value of `0`.
          type: number
          format: float
          minimum: 0
          maximum: 360
          default: 0
          example: 2
        fbr:
          description: Front-to-back ratio measured in dB. A highly directional antenna will have a high FBR.
          type: number
          format: integer
          minimum: 0
          maximum: 60
          default: 0
          example: 0
        pol:
          description: |
            Antenna polarization:
            * `v` - Vertical
            * `h` - Horizontal
          type: string
          enum:
            - v
            - h
          default: v
          example: h
    Receiver:
      type: object
      properties:
        lat:
          description: Latitude of receiver in WGS84 decimal degrees.
          type: number
          format: float
          minimum: -89
          maximum: 89
          default: 0
          example: 38.906986
        lon:
          description: Longitude of receiver in WGS84 decimal degrees.
          type: number
          format: float
          minimum: -180
          maximum: 180
          default: 0
          example: 1.421416
        alt:
          description: Altitude of receiver above ground level in `metric` or `imperial`. Distance unit set in `output` object.
          type: number
          format: float
          minimum: 0.1
          maximum: 120000
          default: 0.1
        rxg:
          description: Receiver antenna gain in dBi.
          type: number
          format: float
          minimum: -10
          maximum: 60
          default: 2.15
          example: 3
        rxs:
          description: Receiver sensitivity/threshold in measured units. Measured units set in `output` object.
          type: number
          format: float
          minimum: -140
          maximum: 200
          default: -90
          example: -100
    Model:
      type: object
      properties:
        pm:
          description: |
            Propagation model:
            * `1` - Irregular Terrain Model (ITM) (Longley-Rice)
            * `2` - Line of Sight (LOS)
            * `3` - Okumura-Hata 
            * `4` - ITU-R P.529 (ECC33)
            * `5` - SUI Microwave
            * `6` - COST231-Hata
            * `7` - ITU-R P.525 (Free space path loss)
            * `8` - Reserved
            * `9` - Ericsson 9999
            * `10` - Plane Earth Loss
            * `11` - Egli VHF/UHF
          type: number
          format: integer
          minimum: 1
          maximum: 11
          default: 1
          example: 1
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 9
            - 10
            - 11
        pe:
          description: |
            Propagation model subtype (environment):
            * `1` - Conservative (Urban)
            * `2` - Average (Suburban)
            * `3` - Optimistic (Rural)
          type: number
          format: integer
          minimum: 1
          maximum: 3
          default: 2
          example: 2
          enum:
            - 1
            - 2
            - 3
        cli:
          description: |
            Radio climate for ITM model:
            * `1` - Equatorial (Congo)
            * `2` - Continental Subtropical (Sudan)
            * `3` - Maritime Subtropical (West coast of Africa)
            * `4` - Desert (Sahara)
            * `5` - Continental Temperate
            * `6` - Maritime Temperate and Over Land (UK and West coasts of US & Europe)
            * `7` - Maritime Temperate, Over Sea
          type: number
          format: integer
          minimum: 1
          maximum: 7
          default: 6
          example: 7
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
        ked:
          description: |
            Include knife edge diffraction for enhancing models with NLOS coverage (ITM includes this already):
            * `0` - Knife-edge diffraction disabled. In such cases the model applies a conservative line of sight.
            * `1` - Knife-edge diffraction enabled.
          type: number
          format: integer
          enum:
            - 0
            - 1
          default: 1
          example: 1
        rel:
          description: Model reliability (fade margin) represented as a percentage (%). 50% adds 0dB loss, 99% adds 9.9dB loss.
          type: number
          format: integer
          minimum: 50
          maximum: 99
          default: 90
          example: 55
        ter:
          description: |
            Terrain short code for ITM model: 
            * `1` - Water
            * `2` - Wet ground
            * `3` - Farmland
            * `4` - Forest/Average
            * `5` - Mountain/Sand
            * `6` - City/Poor ground
          type: number
          format: integer
          minimum: 1
          maximum: 6
          default: 4
          example: 3
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
    Environment:
      type: object
      properties:
        clt:
          description: 'Clutter profile name. If not supplied, but `cll` > `0` then `Minimal.clt` will be used'
          type: string
          default: 'Minimal.clt'
        cll:
          description: |
            Clutter mode:
            * `0` - Disabled (DSM only)
            * `1` - Enabled (System 10m landcover)
            * `2` - Enabled (System 10m landcover plus 3D buildings)
          type: number
          format: integer
          minimum: 0
          maximum: 2
          default: 2
          example: 1
          enum:
            - 0
            - 1
            - 2
        clm:
          description: |
            Custom clutter: 
            * `0` - Disabled
            * `1` - Enabled (This requires that you have created clutter in the local area first)
          type: number
          format: integer
          minimum: 0
          maximum: 1
          default: 0
          enum:
            - 0
            - 1
    Output:
      type: object
      properties:
        units:
          description: |
            Define global distance units applied to heights and distances:
            * `metric` - Define units in meters and kilometers.
            * `imperial` - Define units in feet and miles.
          type: string
          default: metric
          enum:
            - metric
            - imperial
        col:
          description: |
            Colour schema code OR filename string of your chosen output colour schema. 

            Numerical codes:
            * `1` - Cellular (5)
            * `2` - Red
            * `3` - Green
            * `4` - Blue
            * `5` - Microwave (7)
            * `7` - Custom RGB
            * `8` - Automatic by frequency
            * `9` - Greyscale/GIS
            * `10` - Rainbow (24)
            * `11` - Green/Blue/Red
            * `13` - Sub noise floor (10)
            * `14` - TV broadcasting (4)
            * `15` - Red threshold
            * `16` - Green threshold
            * `17` - Blue threshold

            Filename examples: 

            * RAINBOW.dBm
            * CUSTOMSCHEMA.dBm

            Please note that if you have created your own custom colour schema then you can use the name of the schema here.
          type: string
          default: RAINBOW.dBm
        out:
          description: |
            Measured units (Please note that your measured unit should match the measured unit of your `col` colour schema):
            * `1` - Path loss (dB)
            * `2` - Received power (dBm) - Default
            * `3` - Field strength (dBuV)
            * `4` - Signal-to-Noise Ratio (dB) - Supports the `nf` option in the `output` object
            * `5` - Bit-Error-Rate (BER) - Supports the `ber` and the `mod` options in `output` object
            * `6` - Received signal Received Power (dBm)
            * `7` - Best site analysis (%) - Used with best site analysis calculations
          type: number
          format: integer
          minimum: 1
          maximum: 7
          default: 2
          example: 2
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
        ber:
          description: |
            Bit-Error-Rate (These should be combined with an appropriate `mod` value in the `output` object):
            * `1` - 0.1 / 10e-1
            * `2` - 0.01 / 10e-2
            * `3` - 0.001 / 10e-3
            * `4` - 0.0001 / 10e-4
            * `5` - 0.00001 / 10e-5
            * `6` - 0.000001 / 10e-6

            LoRa Spread Factors (These are only valid for a LoRa `mod` value (`11`) in the `output` object):
            * `7` - LoRa SF7 / 5469bps
            * `8` - LoRa SF8 / 3125bps
            * `9` - LoRa SF9 / 1758bps
            * `10` - LoRa SF10 / 977bps
            * `11` - LoRa SF11 / 537bps
            * `12` - LoRa SF12 / 293bps
          type: number
          format: integer
          minimum: 0
          maximum: 12
          default: 0
          example: 2
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
        mod:
          description: |
            Modulation as combined with the `ber` value in the `output` object:
            * `1` - 4QAM
            * `2` - 16QAM
            * `3` - 64QAM
            * `4` - 256QAM
            * `5` - 1024QAM
            * `6` - BPSK
            * `7` - QPSK
            * `8` - 8PSK
            * `9` - 16PSK
            * `10` - 32PSK
            * `11` - LoRa
          type: number
          format: integer
          minimum: 1
          maximum: 11
          default: 1
          example: 7
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
        nf:
          description: Noise floor in dBm for when using an SNR value (`4`) with `out` in the `output` object. 
          type: number
          format: float
          minimum: -130
          maximum: -50
          default: -120
          example: -100
        res:
          description: Resolution in meters for produced output. A high resolution (eg. 2m) is much slower than a medium resolution (eg. 20m) for area calculations.
          type: number
          format: integer
          minimum: 1
          maximum: 300
          default: 10
          example: 10
        rad:
          description: Radius in kilometers for output. This is not a guarantee a signal will reach, only that is where you want to model out to. Set with care!
          type: number
          format: float
          minimum: 0.03
          maximum: 400
          default: 5
          example: 5
    Point:
      type: object
      properties:
        lat:
          description: Latitude in WGS84 decimal degrees.
          type: number
          format: float
          minimum: -89
          maximum: 89
          default: 38.916
          example: 1.421416
        lon:
          description: Longitude in WGS84 decimal degrees.
          type: number
          format: float
          minimum: -180
          maximum: 180
          default: 1.411
          example: 38.906986
        alt:
          description: Altitude above ground level in `metric` or `imperial`. Distance unit set in `output` object.
          type: number
          format: float
          minimum: 0.1
          maximum: 120000
          default: 1
          example: 100
    Feature:
      type: object
      properties:
        type:
          type: string
          description: Identifier for item of clutter.
          default: Feature
        features:
          type: object
          properties:
            geometry:
              type: string
              description: Shape describing an item of clutter
              default: Polygon
              example: Polygon
            coordinates:
              type: string
              description: '[GeoJSON](https://github.com/geojson/schema) coordinate pairs. Locations of item/s of clutter passed as an array. For example: [-2.646178,51.639692].'
              example: '[-2.646178,51.639692]'
            properties:
              type: object
              properties:
                height:
                  type: string
                  description: Clutter object height in m
                  example: '4'
                material:
                  type: string
                  description: 'Clutter object material. The material code/type/attenuation options are: 1 Tree/s:0.25; 2 Trees:0.5; 3 Timber:1.0; 4\tTimber:1.5; 5\tBrick:1.5; 6\tBrick:2.0; 7\tConcrete:3.0; 8\tConcrete:4.0; 9\tMetal:6.0.;'
                  enum:
                    - '1'
                    - '2'
                    - '3'
                    - '4'
                    - '5'
                    - '6'
                    - '7'
                    - '8'
                    - '9'
                  example: '1'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: key
      description: An APIKey passed in the request headers.
