Metadata

Get dataset metadata

Returns metadata about the mortgage rates dataset including:

  • When the data was last updated
  • Total number of rates in the dataset
  • Available product types (e.g., "30-Year Fixed", "15-Year Fixed", "5/1 ARM")
  • Available institutions (credit unions)
  • Min/max ranges for rate, APR, and points

Use this endpoint to discover what data is available before querying /v1/decisions for personalized recommendations.

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

get/meta

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/meta
  • Auth: API key in header X-API-Key

Response

Dataset metadata retrieved successfully

generatedAtstring date-time required

ISO 8601 timestamp when the dataset was last generated/updated

countinteger required

Total number of mortgage rates in the complete dataset

productTypesstring[] required

Sorted list of all unique product types available in the dataset. Use these values for the productType filter.

institutionsstring[] required

Sorted list of all institutions (credit unions) in the dataset. Use these values for the institution filter.

Example response

{
  "generatedAt": "2024-01-15T12:00:00.000Z",
  "count": 500,
  "productTypes": [
    "15-Year Fixed",
    "30-Year Fixed",
    "5/1 ARM"
  ],
  "institutions": [
    "Navy Federal Credit Union",
    "Pentagon Federal Credit Union"
  ],
  "ranges": {
    "rate": {
      "min": 5.25,
      "max": 8.75
    },
    "apr": {
      "min": 5.25,
      "max": 8.75
    },
    "points": {
      "min": 5.25,
      "max": 8.75
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.