KatRisk APIs - A Digital Connection to Empower Loss Modelers

KatRisk API resources for modelers

SpatialKat API 1.0

KatRisk's SpatialKat API is the digital face to simplify the complexity of probabilistic loss model analysis. The API takes the modeler's input and can be seamlessly integrated into workflows to perform complex mathematical methods and financial calculations. SpatialKat is KatRisk's event-based probabilistic analysis software that calculates location through portfolio losses and produces event loss tables and exceedance probability curves. Fifty thousand years of simulated events, including tropical cyclones, storm surges, inland floods, and hail, are modeled.

KatRisk API overview

The SpatialKat API provides an interconnection between the components of the KatRisk platform. Modelers can use the API methods to perform the following operations:

  • Manage API versions

  • Upload exposures and financial terms

  • Import exposures and policies to the KatRisk platform

  • Get a system of records

  • Execute models

  • Schedule jobs

  • Download exposures and analysis results

Automation

Catastrophic modeling workflows are widely optimized as more advanced tools are leveraged to process voluminous data. Customers are looking for means to automate their workflows and minimize manual interventions using the traditional user interface. KatRisk APIs are not limited to a single workflow; the endpoints are catered toward creating various pre-defined processes. Suppose we want to run probabilistic models to study the potential effects of climate change on losses with various Representative Concentration Pathways (RCP) or NOAA sea-level rise scenarios. A sample workflow will upload the exposure once and rerun the probabilistic model analysis by varying the climate state and climate sensitivity parameters from the API request. This example illustrates where an automated workflow comes in handy to improve the process efficiency to analyze multiple scenarios. The capabilities of the API are the same as in the SpatialKat UI. 

Security

The API uses security keys generated within the SpatialKat. Each SpatialKat user should create an API key and be authorized to call the API. Users must log into SpatialKat with their credentials to generate a key. Every request to an API call must provide a valid SpatialKat API key in the header. 

API Job Queue

The SpatialKat API leverages SpatialKat's job queue to schedule batch jobs. API Jobs are added to the SpatialKat distributed platform's job queue and then executed by the job runner. When the API is called, it is added to the job queue and enters into the queued state. Once the job is picked for execution, the system updates the status to “processing”. The API request gets an instant response with the job details along with the position in the line. A simple status pooling heartbeat API allows querying near-real-time execution updates.

Documentation

The API framework comes with a Swagger endpoint. This interface has a provision to authorize users to call APIs and lists all available resources in the SpatialKat API. Users can modify the API request parameters and instantly view the API response. To call the API from the terminal window, Swagger conveniently generates a curl command. 

Versioning

The endpoint URL consists of three parts: the base URL, the supported version, and the action to be performed. The API version number is required in all API calls within the URL. Endpoints without a version number are not supported. Using a deprecated version in the endpoint URL will cause an error message.

Base URL

Version

Action

https://katrisk.platform.api/

V1

/model/execute

Performance and Scalability

The SpatialKat API is simply a layer of code that sits on top of the SpatialKat platform and provides programmatic access to modelers. The performance and scalability of the API depend on the underlying SpatialKat hardware configurations. The performance benchmark from a 25-core system with 1,150,000 location exposures, each having a unique site policy, 30,000 account policies, and 15,000 facultative policies, comes to approximately twelve minutes for a multi-peril analysis. Multi peril consists of tropical cyclones, storm surge, and inland flood. Demand surge is included here. At KatRisk, we prioritize performance and scalability to provide the best user experience and increase the SpatialKat ecosystem's availability. The analysis runtime is proportional to core count with close to linear scaling. Achieving scalability is more straightforward by simply increasing the core count.

Metering

SpatialKat metering helps to understand the usage statistics around the number of sites after a successful exposure import and the number of locations producing AAL after a successful analysis run. It also helps to understand resource usage at a granular level by user, day, month, and year. This identifies workloads whose resources require significantly higher usage and helps to manage to allocate the workload efficiently.

Code Samples

Code samples are essential in helping customers integrate the API into their workflows. KatRisk provides Python, C#, Java, R, and curl code samples. The examples walk through the primary usage and functionality of APIs. There are multiple workflows possible while automating business processes. KatRisk can guide clients in finding the proper workflow that fits their business needs.


By Swami Krishnamoorthy, Chief Technology Officer, KatRisk

Stay tuned for the “Location Loss API” blog post. To learn more about how KatRisk technology offerings and solutions, please reach out to us at contact@katrisk.com

  • Your privacy is important to us. It is KatRisk LLC's policy to respect your privacy and comply with any applicable law and regulation regarding any personal information we may collect about you, including across our website, https://www.katrisk.com, and other sites we own and operate.

    This policy is effective as of 19 April 2022 and was last updated on 19 April 2022.

    Information We Collect

    Information we collect includes both information you knowingly and actively provide us when using or participating in any of our services and promotions, and any information automatically sent by your devices in the course of accessing our products and services.

    Log Data

    When you visit our website, our servers may automatically log the standard data provided by your web browser. It may include your device’s Internet Protocol (IP) address, your browser type and version, the pages you visit, the time and date of your visit, the time spent on each page, other details about your visit, and technical details that occur in conjunction with any errors you may encounter.

    Please be aware that while this information may not be personally identifying by itself, it may be possible to combine it with other data to personally identify individual persons.

    Collection and Use of Information

    We may collect personal information from you when you do any of the following on our website:

    Use a mobile device or web browser to access our content

    Contact us via email, social media, or on any similar technologies

    When you mention us on social media

    We may collect, hold, use, and disclose information for the following purposes, and personal information will not be further processed in a manner that is incompatible with these purposes:

    Please be aware that we may combine information we collect about you with general information or research data we receive from other trusted sources.

    Security of Your Personal Information

    When we collect and process personal information, and while we retain this information, we will protect it within commercially acceptable means to prevent loss and theft, as well as unauthorized access, disclosure, copying, use, or modification.

    Although we will do our best to protect the personal information you provide to us, we advise that no method of electronic transmission or storage is 100% secure, and no one can guarantee absolute data security. We will comply with laws applicable to us in respect of any data breach.

    You are responsible for selecting any password and its overall security strength, ensuring the security of your own information within the bounds of our services.

    How Long We Keep Your Personal Information

    We keep your personal information only for as long as we need to. This time period may depend on what we are using your information for, in accordance with this privacy policy. If your personal information is no longer required, we will delete it or make it anonymous by removing all details that identify you.

    However, if necessary, we may retain your personal information for our compliance with a legal, accounting, or reporting obligation or for archiving purposes in the public interest, scientific, or historical research purposes or statistical purposes.

    Children’s Privacy

    We do not aim any of our products or services directly at children under the age of 13, and we do not knowingly collect personal information about children under 13.

    International Transfers of Personal Information

    The personal information we collect is stored and/or processed where we or our partners, affiliates, and third-party providers maintain facilities. Please be aware that the locations to which we store, process, or transfer your personal information may not have the same data protection laws as the country in which you initially provided the information. If we transfer your personal information to third parties in other countries: (i) we will perform those transfers in accordance with the requirements of applicable law; and (ii) we will protect the transferred personal information in accordance with this privacy policy.

    Your Rights and Controlling Your Personal Information

    You always retain the right to withhold personal information from us, with the understanding that your experience of our website may be affected. We will not discriminate against you for exercising any of your rights over your personal information. If you do provide us with personal information you understand that we will collect, hold, use and disclose it in accordance with this privacy policy. You retain the right to request details of any personal information we hold about you.

    If we receive personal information about you from a third party, we will protect it as set out in this privacy policy. If you are a third party providing personal information about somebody else, you represent and warrant that you have such person’s consent to provide the personal information to us.

    If you have previously agreed to us using your personal information for direct marketing purposes, you may change your mind at any time. We will provide you with the ability to unsubscribe from our email-database or opt out of communications. Please be aware we may need to request specific information from you to help us confirm your identity.

    If you believe that any information we hold about you is inaccurate, out of date, incomplete, irrelevant, or misleading, please contact us using the details provided in this privacy policy. We will take reasonable steps to correct any information found to be inaccurate, incomplete, misleading, or out of date.

    If you believe that we have breached a relevant data protection law and wish to make a complaint, please contact us using the details below and provide us with full details of the alleged breach. We will promptly investigate your complaint and respond to you, in writing, setting out the outcome of our investigation and the steps we will take to deal with your complaint. You also have the right to contact a regulatory body or data protection authority in relation to your complaint.

    Limits of Our Policy

    Our website may link to external sites that are not operated by us. Please be aware that we have no control over the content and policies of those sites, and cannot accept responsibility or liability for their respective privacy practices.

    Changes to This Policy

    At our discretion, we may change our privacy policy to reflect updates to our business processes, current acceptable practices, or legislative or regulatory changes. If we decide to change this privacy policy, we will post the changes here at the same link by which you are accessing this privacy policy.

    If required by law, we will get your permission or give you the opportunity to opt in to or opt out of, as applicable, any new uses of your personal information.

    Contact Us

    For any questions or concerns regarding your privacy, you may contact us using the following details:

    contact@katrisk.com