Data & Analytics

Consumer rate-alert subscription (double opt-in email)

Consent-first, EMAIL-delivered rate alerts: a borrower (or an AI agent on their behalf) is notified when the live market meets their target (rate/apr/monthly_payment crossing a threshold). Action-discriminated: subscribe creates a pending alert and sends a double-opt-in confirmation email (the alert only activates after the recipient confirms); confirm activates it; list returns a borrower's alerts; unsubscribe is a one-click token unsubscribe. Stores only email + alert criteria; never sold; one-click unsubscribe in every email (CAN-SPAM). This route is the single source of truth; the MCP subscribe_rate_alert/list_rate_alerts/unsubscribe_rate_alert tools call it.

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

post/v1/alerts

Request

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

Request body

OR
OR
OR

Example request

{
  "email": "borrower@example.com",
  "state": "CA",
  "amount": 450000,
  "term_months": 360,
  "credit_score": 740,
  "target": {
    "value": 6
  }
}

Response

Action result. subscribe returns pending_confirmation; confirm returns active; list returns alerts; unsubscribe returns unsubscribed.

status'pending_confirmation' | 'active' | 'unsubscribed' | 'ok' required

Outcome of the requested action.

alert_idstring

Identifier of the alert the action applied to. Absent on list.

emailstring email

Recipient the alert is bound to.

messagestring

Human-readable next step, e.g. "Check your inbox to confirm".

next_actionsstring[]

Follow-up calls that make sense from here.

disclosuresstring[]

Consent and CAN-SPAM statements that apply to this alert.

Example response

{
  "alert_id": "ra_ab12cd34"
}

Changes

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