Skip to main content
Documentation Powered by Redocly

External API (1.0.0)

Download OpenAPI specification:Download

The External API services endpoints that are not directly connected to the OpenAPI platform. These endpoints are predominantly used for third-party integrators and are billed on a usage-based subscription. If you would like to leverage the External API, please contact us (developers@hailtrace.com).

Authentication

Authorization

The API key given to the external intergrator.

Security Scheme Type API Key
Header parameter name: Authorization

Hail History Report (PDF)

Order Hail History Report

Allows the client to generate a hail history report PDF for a specific location. You must provide latitude and longitude or a valid street_address. Latitude and longitude will supercede street_address and bypass the reverse geocoding process, if provided. Providing a street_address is strongly encouraged as it will show up on the final report.

Authorizations:
Authorization
    Request Body schema: application/json
    street_address
    string

    The address to order (reverse-geocoded if no lat/lng are provided)

    latitude
    string

    The latitude for the report.

    longitude
    string

    The longitude for the report.

    min_convective_date
    required
    string <date>

    The min convective date for the hail history table in the report.

    max_convective_date
    required
    string <date>

    The max convective date for the hail history table in the report.

    contractor_variant
    boolean
    Default: false

    Provides a specific version of the report for contractors. This excludes SDOL (Suggested date of loss) calculation variants.

    object (Profile)

    Responses

    Request samples

    Content type
    application/json
    {
    • "street_address": "1600 Burlwood Rd, Norman, OK 73026",
    • "latitude": "36.70133871536629",
    • "longitude": "-117.21559539277622",
    • "min_convective_date": "2011-01-01",
    • "max_convective_date": "2022-06-16",
    • "contractor_variant": false,
    • "profile": {
      }
    }

    Get Hail History Report

    Request a previously generated report by ID.

    Authorizations:
    Authorization

      Responses

      Response samples

      Content type
      application/json
      {
      • "_id": "62e7f70a470ceef4fa1d11bd",
      • "report_id": "0NPM9PRM3",
      • "street_address": "string",
      • "min_convective_date": "2019-08-24",
      • "max_convective_date": "2019-08-24",
      • "status": "COMPLETE",
      • "latitude": 36.70133871536629,
      • "longitude": -117.21559539277622,
      • "sdol_lookahead_days": 45,
      • "diameter_in_threshold": 0.75,
      • "damage_probability_threshold": 0,
      • "search_radius_mi": 0,
      • "created_at": "2022-08-01T15:53:46.505Z",
      • "contractor_variant": false,
      • "profile": {
        },
      • "location": {
        },
      • "type": "RDOL_IS_SDOL"
      }