Welcome to HailTrace
Looking for our external api?
The docs below are for our OpenAPI Check out our extenal api docs for advanced integrations.
Let's discover The HailTrace OpenApi in less than 5 minutes.
The HailTrace OpenApi is designed to allow applications to act on behalf of HailTrace users. Currently, the api allows our integrators access to the following features:
- Finding Weather Events within a user's subscription.
- Rendering Weather Shapes on a specific date within a user's subscription.
- Ordering PDF Reports within a User's subscription.
- Listing the Impact History at a location within the User's subscription.
Our plan is to add additional use cases:
- Read/Write Assets
- Read/Write Contacts
- Read/Write Opportunities
Getting Started
Api Endpoint
openapi.hailtrace.com
Get started by retrieving your api key.
Retrieving Your Api Keys
First, contact our team ([email protected]) to register your application and get your app apiKey.
Second, you will need to procure an api key from the user your application will act as. Users can procure their api key from https://app.hailtrace.com/settings/api-keys
Set Authorization Headers
You will need to set the following authorization headers
| Header | Value |
|---|---|
x-app-id | Your application api key |
x-api-key | The User's api key |