{
  "openapi": "3.0.1",
  "info": {
    "title": "US Mortgage Rate Monitor: Freddie Mac 30-Year and 15-Year",
    "description": "Get current and historical US mortgage rates from Freddie Mac's Primary Mortgage Market Survey (PMMS) for 30-year fixed, 15-year fixed, and 5/1 ARM products. Includes weekly changes, threshold alerts, and automated weekly change monitoring.",
    "version": "1.0",
    "x-build-id": "7sozSHk7JKvdYH9pq"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/accountable_eel~us-mortgage-rate-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-accountable_eel-us-mortgage-rate-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/accountable_eel~us-mortgage-rate-monitor/runs": {
      "post": {
        "operationId": "runs-sync-accountable_eel-us-mortgage-rate-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/accountable_eel~us-mortgage-rate-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-accountable_eel-us-mortgage-rate-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "products": {
            "title": "Mortgage products to track (30y, 15y, 51arm)",
            "type": "array",
            "description": "One mortgage product code per line: 30y (30-Year Fixed), 15y (15-Year Fixed), or 51arm (5/1 ARM). Leave empty to track all available products. Accepted formats: 30y, 15y, 51arm, 30-year fixed, 15-year fixed. You're only charged for the ones we actually find — a miss costs nothing.",
            "items": {
              "type": "string"
            }
          },
          "weeks": {
            "title": "Historical survey weeks",
            "type": "integer",
            "description": "Number of weekly survey periods to include (1 for current week only, 12 for recent quarter, up to 520 for ten years). Default: 12.",
            "default": 12
          },
          "alertRateAbove": {
            "title": "Alert threshold: rate above (%)",
            "type": "number",
            "description": "Optional. Flag rate records where the mortgage rate is greater than or equal to this percent (e.g. 7.0)."
          },
          "alertRateBelow": {
            "title": "Alert threshold: rate below (%)",
            "type": "number",
            "description": "Optional. Flag rate records where the mortgage rate is less than or equal to this percent (e.g. 6.5)."
          },
          "alertChangeThreshold": {
            "title": "Alert threshold: weekly change (%)",
            "type": "number",
            "description": "Optional. Flag rate records where the absolute weekly rate change is at least this percentage points (e.g. 0.10)."
          },
          "onlyNewSinceLastRun": {
            "title": "Only return rates new since the last run (monitoring)",
            "type": "boolean",
            "description": "On: only survey weeks published since your last run are returned and charged for — ideal for weekly alerts when Freddie Mac publishes new survey rates on Thursdays. Off: returns all requested historical weeks every time.",
            "default": false
          },
          "deltaName": {
            "title": "Watchlist name (optional)",
            "type": "string",
            "description": "Optional name for this search's monitoring memory so you can distinguish multiple scheduled runs. Leave empty to auto-derive from selected products.",
            "default": ""
          },
          "testRun": {
            "title": "Try it first — only process the first 5",
            "type": "boolean",
            "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.",
            "default": false
          },
          "onlyFound": {
            "title": "Hide rows with no result",
            "type": "boolean",
            "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.",
            "default": false
          },
          "includeKeywords": {
            "title": "Only keep rows containing",
            "type": "array",
            "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.",
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Skip rows containing",
            "type": "array",
            "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Stop after this many results",
            "minimum": 1,
            "type": "integer",
            "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit."
          },
          "columns": {
            "title": "Which columns do you want?",
            "type": "array",
            "description": "Choose which pieces of information to include in each result row. All are included by default.",
            "items": {
              "type": "string",
              "enum": [
                "searchSummary",
                "rateCount",
                "monitorStatus",
                "rates",
                "product",
                "productName",
                "weekDate",
                "rate",
                "points",
                "margin",
                "spread",
                "previousWeekDate",
                "previousWeekRate",
                "weeklyChange",
                "weeklyChangeDirection",
                "thresholdTriggered",
                "alertReason",
                "sourceUrl",
                "isNew",
                "firstSeenAt"
              ],
              "enumTitles": [
                "Search summary",
                "Rates returned",
                "Monitoring status",
                "All mortgage rates",
                "Product code",
                "Mortgage product name",
                "Survey week date",
                "Mortgage rate (%)",
                "Points and fees (%)",
                "ARM margin (%)",
                "ARM spread (%)",
                "Previous week date",
                "Previous week rate (%)",
                "Weekly rate change (%)",
                "Change direction",
                "Threshold triggered",
                "Alert reason",
                "Source URL",
                "Is new rate",
                "First seen at"
              ]
            },
            "default": [
              "searchSummary",
              "rateCount",
              "monitorStatus",
              "rates",
              "product",
              "productName",
              "weekDate",
              "rate",
              "points",
              "margin",
              "spread",
              "previousWeekDate",
              "previousWeekRate",
              "weeklyChange",
              "weeklyChangeDirection",
              "thresholdTriggered",
              "alertReason",
              "sourceUrl",
              "isNew",
              "firstSeenAt"
            ]
          },
          "expandRows": {
            "title": "One row per mortgage rate (recommended) — turn off for one row per mortgage rate query instead",
            "type": "boolean",
            "description": "When on, each mortgage rate found gets its own row instead of being grouped under its mortgage rate query. You're still only charged once per mortgage rate query, no matter how many rows it produces.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 2,
            "type": "integer",
            "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.",
            "default": 1
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}