Opterrix Capacity & Risk Assessment (3.7.2)

Download OpenAPI specification:Download

Opterrix API for accessing capacity and risk assessment data using configurable portfolios. To create a portfolio, contact your administrator to configure a portfolio using the Opterrix webapp.

Single Location Calls

Returns the capacity and/or risk assessment data for the the requested lat lng pair or address for the requested portfolio. Coordinate lat lng pair requests are available by default. Access to address requests is provisioned separately.

Capacity

Returns the capacity and exposure data for the cell containing the requested lat lng pair or address for the requested portfolio. The requesting user must have access to the capacity module to use this endpoint.

Authorizations:

API Key Authentication

query Parameters

lat	float Latitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
lng	float Longitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
address	float Address of the requested location. Must provide a `lat` `lng` pair or an `address`. To use this parameter, the requesting user must be provisioned for geocoding.
portfolio required	int Id of the requested portfolio. `id` values can be obtained for the portfolios the requesting user has access to by using the `/inventory` endpoint.

Responses

Response samples

200
400
403
404

Content type

application/json

{"capacity": {"available_capacity": 993980988,
"capacity_rule": {"description": "Capacity rule description text",
"name": "Capacity Rule Name"
},
"capacity_status": 0,
"percent_capacity": 0.006019012,
"total_capacity": 1000000000,
"total_usage": 6019012
},
"portfolio_details": {"Policies In-Force": 9,
"Total Insured Value": 6019012
},
"request": {"cell": "H3-251235",
"geocoded_address": "string",
"input_address": "string",
"latlng": [43,
-89
],
"portfolio_id": 18,
"state": "Wisconsin",
"timestamp": "2023-10-18T11:29:54.873215"
}
}

Risk Assessment

Returns the risk assessment data for both the location as well as the cell containing the requested lat lng pair or address for the requested portfolio. The requesting user must have access to the risk module to use this endpoint.

Authorizations:

API Key Authentication

query Parameters

lat	float Latitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
lng	float Longitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
address	float Address of the requested location. Must provide a `lat` `lng` pair or an `address`. To use this parameter, the requesting user must be provisioned for geocoding.
portfolio required	int Id of the requested portfolio. `id` values can be obtained for the portfolios the requesting user has access to by using the `/inventory` endpoint.
include_additional_risk_factors	bool Default: false Flag to include the additional risk factor data

Responses

Response samples

200
400
403
404

Content type

application/json

{"risk_assessment": [{"blended_risk_score_rule": {"description": "Blended risk score rule description text",
"name": "Blended Risk Rule Name"
},
"key": "blended",
"name": "Blended Risk Score",
"score_cell": 6,
"score_location": 5
},
{"key": "coastal_surge",
"name": "Coastal Surge",
"score_cell": null,
"score_location": null
},
{"key": "convective_wind",
"name": "Convective Wind",
"score_cell": 9,
"score_location": 9
},
{"key": "earthquake",
"name": "Earthquake",
"score_cell": 3,
"score_location": 2
},
{"key": "excessive_rainfall",
"name": "Excessive Rainfall",
"score_cell": 6,
"score_location": 7
},
{"key": "flash_flood",
"name": "Flash Flood",
"score_cell": 5,
"score_location": 6
},
{"key": "hail",
"name": "Hail",
"score_cell": 8,
"score_location": 8
},
{"key": "ice_storm",
"name": "Ice Storm",
"score_cell": 5,
"score_location": 4
},
{"key": "riverine_flood",
"name": "Riverine Flood",
"score_cell": 5,
"score_location": 6
},
{"key": "tornado",
"name": "Tornado",
"score_cell": 10,
"score_location": 9
},
{"key": "tropical_wind",
"name": "Tropical Wind",
"score_cell": 2,
"score_location": 2
},
{"key": "wildfire",
"name": "Wildfire",
"score_cell": 3,
"score_location": 2
},
{"key": "winter_storm",
"name": "Winter Storm",
"score_cell": 6,
"score_location": 6
}
],
"request": {"cell": "H3-251235",
"geocoded_address": "string",
"input_address": "string",
"latlng": [43,
-89
],
"portfolio_id": 18,
"state": "Wisconsin",
"timestamp": "2023-10-18T11:29:54.873215"
}
}

Capacity & Risk Assessment

Returns both the risk assessment and capacity data for the requested lat lng pair or address for the requested portfolio. The requesting user must have access to both the risk module and the capacity module to use this endpoint.

Authorizations:

API Key Authentication

query Parameters

lat	float Latitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
lng	float Longitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
address	float Address of the requested location. Must provide a `lat` `lng` pair or an `address`. To use this parameter, the requesting user must be provisioned for geocoding.
portfolio required	int Id of the requested portfolio. `id` values can be obtained for the portfolios the requesting user has access to by using the `/inventory` endpoint.
include_additional_risk_factors	bool Default: false Flag to include the additional risk factor data

Responses

Response samples

200
400
403
404

Content type

application/json

{"capacity": {"available_capacity": 993980988,
"capacity_rule": {"description": "Capacity rule description text",
"name": "Capacity Rule Name"
},
"capacity_status": 0,
"percent_capacity": 0.006019012,
"total_capacity": 1000000000,
"total_usage": 6019012
},
"portfolio_details": {"Policies In-Force": 9,
"Total Insured Value": 6019012
},
"risk_assessment": [{"blended_risk_score_rule": {"description": "Blended risk score rule description text",
"name": "Blended Risk Rule Name"
},
"key": "blended",
"name": "Blended Risk Score",
"score_cell": 6,
"score_location": 5
},
{"key": "coastal_surge",
"name": "Coastal Surge",
"score_cell": null,
"score_location": null
},
{"key": "convective_wind",
"name": "Convective Wind",
"score_cell": 9,
"score_location": 9
},
{"key": "earthquake",
"name": "Earthquake",
"score_cell": 3,
"score_location": 2
},
{"key": "excessive_rainfall",
"name": "Excessive Rainfall",
"score_cell": 6,
"score_location": 7
},
{"key": "flash_flood",
"name": "Flash Flood",
"score_cell": 5,
"score_location": 6
},
{"key": "hail",
"name": "Hail",
"score_cell": 8,
"score_location": 8
},
{"key": "ice_storm",
"name": "Ice Storm",
"score_cell": 5,
"score_location": 4
},
{"key": "riverine_flood",
"name": "Riverine Flood",
"score_cell": 5,
"score_location": 6
},
{"key": "tornado",
"name": "Tornado",
"score_cell": 10,
"score_location": 9
},
{"key": "tropical_wind",
"name": "Tropical Wind",
"score_cell": 2,
"score_location": 2
},
{"key": "wildfire",
"name": "Wildfire",
"score_cell": 3,
"score_location": 2
},
{"key": "winter_storm",
"name": "Winter Storm",
"score_cell": 6,
"score_location": 6
}
],
"request": {"cell": "H3-251235",
"geocoded_address": "string",
"input_address": "string",
"latlng": [43,
-89
],
"portfolio_id": 18,
"state": "Wisconsin",
"timestamp": "2023-10-18T11:29:54.873215"
}
}

Batch Calls

Returns the capacity and/or cell-level risk assessment data for all requested lat lng pairs for the requested portfolio. Latitude and longitude pairs can be sent using a .csv file. The file must contain at minimum a unique id column, a lat column, and a lng column. This process is asynchronous meaning the batch call is requested and then the results are generated in the background. The final results file can be retrieved via a secondary request once the results are ready.

Batch Capacity

Requests the capacity and exposure data for each requested lat lng pair for the requested portfolio. The requesting user must have access to the capacity module to use this endpoint.

Authorizations:

API Key Authentication

query Parameters

portfolio

required

int

Id of the requested portfolio. id values can be obtained for the portfolios the requesting user has access to by using the /inventory endpoint.

Request Body schema: multipart/form-data

file	string <binary>

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "Request accepted. Processing.",
"status_guid": "81368199-a6df-4991-8906-05d2576a2490"
}

Batch Risk Assessment

Requests the cell-level risk assessment data for each requested lat lng pair for the requested portfolio. The requesting user must have access to the risk module to use this endpoint.

Authorizations:

API Key Authentication

query Parameters

portfolio

required

int

Id of the requested portfolio. id values can be obtained for the portfolios the requesting user has access to by using the /inventory endpoint.

Request Body schema: multipart/form-data

file	string <binary>

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "Request accepted. Processing.",
"status_guid": "81368199-a6df-4991-8906-05d2576a2490"
}

Batch Capacity & Risk Assessment

Requests both the cell-level risk assessment data and the capacity data for each requested lat lng pair for the requested portfolio. The requesting user must have access to both the risk module and the capacity module to use this endpoint.

Authorizations:

API Key Authentication

query Parameters

portfolio

required

int

Id of the requested portfolio. id values can be obtained for the portfolios the requesting user has access to by using the /inventory endpoint.

Request Body schema: multipart/form-data

file	string <binary>

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "Request accepted. Processing.",
"status_guid": "81368199-a6df-4991-8906-05d2576a2490"
}

Batch Call Status Check

Get the status of the batch call corresponding to the requested status_guid.

Authorizations:

API Key Authentication

query Parameters

report_guid

required

string

Globally unique identifier to track the status of a request and download the result.

Responses

Response samples

200
400

Content type

application/json

{"finished": true,
"report_guid": "81368199-a6df-4991-8906-05d2576a2490",
"status": "Complete"
}

Download Batch Call Results

Download the results of the batch call corresponding to the requested status_guid. Use the /batch_status call to check that the results are ready to download.

Authorizations:

API Key Authentication

query Parameters

report_guid

required

string

Globally unique identifier to track the status of a request and download the result.

Responses

Response samples

400

Content type

application/json

{"error": "Missing or invalid status_guid"
}

Underwriting Report

Generates an underwriting report PDF containing capacity and/or risk assessment data for the requested lat lng pair or address for the requested portfolio. This process is asynchronous meaning the report is requested and then the result is generated in the background. The final report PDF file can be retrieved via a secondary request once the report is ready. If the requesting user does not have access to the risk assessment module, the report will not contain risk assessment data. If the requesting user does not have access to the capacity module, the report will not contain capacity data. Coordinate lat lng pair requests are available by default. Access to address requests is provisioned separately.

Request Underwriting Report

Initiates an asynchronous request for a PDF containing risk assessment and/or capacity data for the requested lat lng pair or address for the requested portfolio.

Authorizations:

API Key Authentication

query Parameters

lat	float Latitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
lng	float Longitude of the requested location. Must provide a `lat` `lng` pair or an `address`.
address	float Address of the requested location. Must provide a `lat` `lng` pair or an `address`. To use this parameter, the requesting user must be provisioned for geocoding.
portfolio required	int Id of the requested portfolio. `id` values can be obtained for the portfolios the requesting user has access to by using the `/inventory` endpoint.
report_id required	string Report ID to use as a label for this report. Common use cases are policy numbers or claim numbers. This value does not need to be unique.

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "Request accepted. Processing.",
"report_guid": "81368199-a6df-4991-8906-05d2576a2490"
}

Underwriting Report Status Check

Get the status of the report corresponding to the requested report_guid.

Authorizations:

API Key Authentication

query Parameters

report_guid

required

string

Globally unique identifier to track the status of a request and download the result.

Responses

Response samples

200
400

Content type

application/json

{"finished": true,
"report_guid": "81368199-a6df-4991-8906-05d2576a2490",
"status": "Report generation completed, file available for download",
"success": true
}

Download Underwriting Report

Download the final PDF report corresponding to the requested report_guid. Use the /pdf_report/status call to check that the PDF is ready to download.

Authorizations:

API Key Authentication

query Parameters

report_guid

required

string

Globally unique identifier to track the status of a request and download the result.

Responses

Response samples

400
500

Content type

application/json

{"error": "Missing report_guid parameter"
}

Inventory

Returns a list of all the portfolios available to your user, alongside metadata about each portfolio. The id returned for each portfolio is used to retrieve capacity and risk assessment data for that portfolio. Only portfolios with is_published as True may be used to retrieve capacity and risk assessment data.

Authorizations:

API Key Authentication

Responses

Response samples

200

Content type

application/json

[{"account": "decidia",
"blended_score_rule_type": "single_rule",
"capacity_rule_type": "geographic",
"created_at": "2023-01-10 14:05:20.492797-05:00",
"created_by": "test@test.com",
"exposure_table": "decidia/PAR_ALL",
"id": 18,
"is_publishable": true,
"is_published": true,
"name": "Example Portfolio",
"updated_at": "2023-01-10 14:15:20.492797-05:00",
"updated_by": "test@test.com"
}
]