---
title: "Get data extraction statistics"
method: GET
path: "/v1/stats"
tags: ["Data & Analytics"]
---

# Get data extraction statistics

`GET /v1/stats`

## Request

- Base URL: `https://api.rateapi.dev`
- URL: `https://api.rateapi.dev/v1/stats`
- Auth: API key in header `X-API-Key`

Returns comprehensive statistics about rate extraction activity. Use this to understand the scale and freshness of the data being collected.

**Filtering Options:**
- `startTime` / `endTime`: Filter by date range. Supports ISO8601 dates or relative times (e.g., `now-24h`, `now-7d`)
- `product_type`: Filter by product type (matching /v1/decisions ProductType enum)

**Use Cases:**
- Monitor data collection health
- Build transparency dashboards
- Track extraction trends over time
- Verify coverage for specific product types

**Authentication required**: Pass your API key in the `X-API-Key` header.

## Query parameters

- `startTime` string
- `endTime` string
- `product_type` 'mortgage' | 'auto_loan' | 'rv' | 'boat' | 'motorcycle' | 'powersports' | 'personal_loan' | 'heloc' | 'student_loan' | 'equipment_loan' | 'credit_card'

## Response `200`

Statistics retrieved successfully

- StatsResponse: Data extraction statistics response
  - `query` object, required: Echo of the query parameters used
    - `startTime` string: Start of the time range
    - `endTime` string: End of the time range
    - `product_type` string: Product type filter applied (or 'all')
  - `summary` object, required: High-level summary statistics
    - `totalRates` integer: Total rates extracted in the time range
    - `ratesPerHour` integer: Average rates extracted per hour
    - `activeInstitutions` integer: Number of institutions with data in the time range
    - `hoursInRange` number: Total hours in the queried time range
  - `products` object, required: Product category breakdown
    - `breakdown` object[]: Per-product-type extraction counts, largest first.
      - `product_type` string: Product type identifier
      - `name` string: Human-readable product name
      - `count` integer: Number of rates extracted
      - `percentage` number: Percentage of total extractions
    - `totalCategories` integer: Number of product categories with data
    - `supported` string[]: List of supported product type values for filtering
  - `hourlyTrend` object[], required: Hourly extraction counts for charting
    - `hour` string, date-time: Hour bucket (ISO8601)
    - `total` integer: Total extractions this hour
    - `mortgage` integer: Mortgage extractions
    - `auto_loan` integer: Auto loan extractions
    - `personal_loan` integer: Personal loan extractions
    - `heloc` integer: HELOC extractions
    - `credit_card` integer: Credit card extractions
  - `coverage` object, required: Data coverage statistics
    - `states` integer: Number of US states covered
    - `institutions` integer: Total institutions monitored
    - `activeInstitutions` integer: Institutions with data in time range
    - `productTypes` integer: Distinct product types extracted
  - `dataQuality` object, required: Data quality information
    - `validation` string: Validation methodology
    - `updateFrequency` string: How often data is refreshed
    - `accuracy` string: Accuracy after validation
  - `generatedAt` string, date-time, required: When this response was generated

## Other responses

- `400`: Invalid parameters
- `401`: Missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/rateapi/apis/rate-api.md) · [All operations](https://skmtc.dev/rateapi/apis/rate-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rateapi/apis/rate-api/revisions/06a6db76995f?raw)