> ## Documentation Index
> Fetch the complete documentation index at: https://docs.risk.matrisk.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with the Matrisk API

<img className="block dark:hidden rounded-lg" src="https://mintcdn.com/three-sigma-data/krO97y3WKndm6k1i/images/crashes-exploding.webp?fit=max&auto=format&n=krO97y3WKndm6k1i&q=85&s=9965f1861639bd55233a3f01cc584ef7" alt="Hero Light" width="1920" height="1080" data-path="images/crashes-exploding.webp" />

<img className="hidden dark:block" src="https://mintcdn.com/three-sigma-data/krO97y3WKndm6k1i/images/crashes-exploding.webp?fit=max&auto=format&n=krO97y3WKndm6k1i&q=85&s=9965f1861639bd55233a3f01cc584ef7" alt="Hero Dark" width="1920" height="1080" data-path="images/crashes-exploding.webp" />

Welcome to the **Matrisk API**! Our API leverages **millions of crash records** to create a **risk score** that helps carriers price their policies more accurately using historical crash data. Carriers can ping our API during both **new policy creation** and **policy renewal** to generate real-time risk scores.

***

## **Core Flows Supported**

Our API supports three primary flows:

### 1. **Crash Data**

* **Description**: Get aggregated crash statistics at various levels of granularity (e.g., by location, time, severity).
* **Use Case**: Designed for **sophisticated carriers** who want to build or enhance their own internal risk models.

### 2. **Risk Score by Garaging Location**

* **Description**: Risk score based on **where the vehicle is garaged**.
* **Use Case**: Simple lookup to determine risk based on the location where the car is primarily kept.

### 3. **Risk Score by Telematics Data**

* **Description**: Risk score based on **historical driving behavior**.
* **Use Case**: By analyzing driving patterns, we can determine exactly where a policyholder drives for a finer risk score.

***

## **Create your API Key**

To access the API, generate your API key by visiting the **[Matrisk Dashboard](https://api.risk.matrisk.ai)** and navigating to the **Profile tab**.

***

## **Setup Your API Key**

Once you've created an API key, store it safely and export it as an environment variable.

```bash theme={null}
# Save your API key to your terminal environment
export MATRISK_API_KEY="your_api_key_here"
```

***

## **Make Your First API Request**

With your API key ready, you can make your first request. Choose your method below.

### Example Request Using curl

```bash theme={null}
curl -X POST "https://api.risk.matrisk.ai/v1/garaging-risk-score" \
-H "Authorization: Bearer $MATRISK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "model_version": "v1",
  "policy_holder_id": "12345",
  "vehicles": [
    {
      "vehicle_id": "abc123",
      "garaging_location": {
        "address": "123 Main St, Miami, FL 33101"
      }
    }
  ]
}'
```

***

### **Backtesting Risk Scores**

Our API supports **bulk asynchronous endpoints**, enabling users to efficiently process **hundreds of thousands of requests** simultaneously. This makes it easy to evaluate the effectiveness of our risk score on **large volumes of historical policy data**.

* **Policy vs. Policy Holder**
  * While we're pricing **specific policies**, we can leverage **telematics data from previous policies** to further refine risk scores.
  * **Example**: A policyholder may have multiple vehicles, each insured under a different policy. Our API ensures all relevant data is considered to generate an accurate and holistic risk score.

***

Get started with the **Matrisk API** today and unlock better insights for smarter insurance pricing! 🎉
