{"_id":"@apiverve/mortgagerate","_rev":"3-704b1aefa68a3e558704f58c3d38d910","name":"@apiverve/mortgagerate","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.13":{"name":"@apiverve/mortgagerate","version":"1.1.13","keywords":[],"author":{"url":"https://apiverve.com","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/mortgagerate@1.1.13","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/mortgagerate?utm_source=npm&utm_medium=homepage","bugs":{"url":"https://github.com/apiverve/mortgagerate-api/issues"},"dist":{"shasum":"c2a682a9ba3f7a30129987b1081b8e2232cb76b7","tarball":"https://registry.npmjs.org/@apiverve/mortgagerate/-/mortgagerate-1.1.13.tgz","fileCount":5,"integrity":"sha512-JRnjLqSvoBkWhbUx/OifY5FDylBKSCF9fXo0Ewo6jH2I/SnSl4ZRZZZitTZu/+nzAx/DnPedPnMhY2MyCI1JaQ==","signatures":[{"sig":"MEUCIQCsHzCveleDGb1e5h5oJFa0QQACYc14ABhUjmvnOS+LWQIgdiG5/hRo6QawOAdWnqd2XSBE8QsMRGHKBjjfpcNFkOU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":16759},"main":"index.js","types":"index.d.ts","engines":{"node":">=14.0.0"},"gitHead":"603be281ba20b71024115a78fa6ae64907e245cc","scripts":{"test":"mocha","example":"node examples/basic.js"},"_npmUser":{"name":"charifield","email":"charifield@gmail.com"},"repository":{"url":"git+https://github.com/apiverve/mortgagerate-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Mortgage Rate is a tool for retrieving current and historical US fixed-rate mortgage rates. It returns weekly average rates for 30-year and 15-year fixed mortgages from the Freddie Mac Primary Mortgage Market Survey.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.0","dependencies":{"axios":"1.13.2","promise":"^8.3.0","node-fetch":"^3.3.2"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.2","mocha":"^11.0.1","dotenv":"^16.4.7"},"_npmOperationalInternal":{"tmp":"tmp/mortgagerate_1.1.13_1771047851373_0.3404967310929514","host":"s3://npm-registry-packages-npm-production"}},"1.1.14":{"name":"@apiverve/mortgagerate","version":"1.1.14","keywords":[],"author":{"url":"https://apiverve.com","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/mortgagerate@1.1.14","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/mortgagerate?utm_source=npm&utm_medium=homepage","bugs":{"url":"https://github.com/apiverve/mortgagerate-api/issues"},"dist":{"shasum":"ab00874a24fde1c7546a48131781dacdc3defd64","tarball":"https://registry.npmjs.org/@apiverve/mortgagerate/-/mortgagerate-1.1.14.tgz","fileCount":5,"integrity":"sha512-2MITyo7z+kuBgmFWV4KOnHYhRsvxOQ9ASyiTw5QjBKZonUuCVGa4YCdEkTKQkBFZGJU/FCXEyBLpDbdmJO6v1g==","signatures":[{"sig":"MEUCIQDu5KtqYPuMMzblgGZqKjrGiD+aOAFWF1N1r7VdREQPfAIgPp4wqSCwb0HTmjQkLwxTZ7N25/TQ64hdU30oSzSz6PY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":16468},"main":"index.js","types":"index.d.ts","engines":{"node":">=14.0.0"},"gitHead":"2f35257ac4df6e979213a38ff3974fd82a1cf5b1","scripts":{"test":"mocha","example":"node examples/basic.js"},"_npmUser":{"name":"charifield","email":"charifield@gmail.com"},"repository":{"url":"git+https://github.com/apiverve/mortgagerate-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Mortgage Rate is a tool for retrieving current and historical US fixed-rate mortgage rates. It returns weekly average rates for 30-year and 15-year fixed mortgages from the Freddie Mac Primary Mortgage Market Survey.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.0","dependencies":{"axios":"1.13.2","promise":"^8.3.0","node-fetch":"^3.3.2"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.2","mocha":"^11.0.1","dotenv":"^16.4.7"},"_npmOperationalInternal":{"tmp":"tmp/mortgagerate_1.1.14_1771238725770_0.24925246626918818","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@apiverve/mortgagerate","version":"1.2.0","description":"Mortgage Rate is a tool for retrieving current and historical US fixed-rate mortgage rates. It returns weekly average rates for 30-year and 15-year fixed mortgages from the Freddie Mac Primary Mortgage Market Survey.","main":"index.js","types":"index.d.ts","sideEffects":false,"engines":{"node":">=18.0.0"},"scripts":{"test":"mocha","example":"node examples/basic.js"},"repository":{"type":"git","url":"git+https://github.com/apiverve/mortgagerate-api.git","directory":"npm"},"keywords":["mortgage rate","30 year mortgage","15 year mortgage","fixed rate mortgage","freddie mac"],"author":{"name":"APIVerve","email":"hello@apiverve.com","url":"https://apiverve.com"},"license":"MIT","bugs":{"url":"https://github.com/apiverve/mortgagerate-api/issues"},"homepage":"https://apiverve.com/marketplace/mortgagerate?utm_source=npm&utm_medium=homepage","devDependencies":{"mocha":"^11.0.1","chai":"^5.1.2","dotenv":"^16.4.7"},"dependencies":{"axios":"1.13.2","form-data":"^4.0.1"},"gitHead":"2878cdb345f00af84126a08bcc1be2b68ae96fec","_id":"@apiverve/mortgagerate@1.2.0","_nodeVersion":"24.15.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-lqWVr0KJxgKFrnL6RCYoUo8ecjMR+RCqHPtdVN4ak7MIKHsuICtSrjRd/NXPurA3lw1iRqNLEiHW9pQs1sZJ2w==","shasum":"56d5e1c647840a771ef8354d9f7a866ef78ab09b","tarball":"https://registry.npmjs.org/@apiverve/mortgagerate/-/mortgagerate-1.2.0.tgz","fileCount":5,"unpackedSize":17720,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIBUEucZgN4iePxw7RDNnCHt3Z1iwJxd+eVsMC3OVAiHaAiEAzqHEJlm+PNod3n+jL/D4j+TKCtHB0Ni/+PD3S6++cUc="}]},"_npmUser":{"name":"apivervehq","email":"hello@apiverve.com"},"directories":{},"maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mortgagerate_1.2.0_1784152236371_0.8788225521480759"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-14T05:44:11.264Z","modified":"2026-07-15T21:50:36.654Z","1.1.13":"2026-02-14T05:44:11.526Z","1.1.14":"2026-02-16T10:45:25.918Z","1.2.0":"2026-07-15T21:50:36.523Z"},"bugs":{"url":"https://github.com/apiverve/mortgagerate-api/issues"},"author":{"name":"APIVerve","email":"hello@apiverve.com","url":"https://apiverve.com"},"license":"MIT","homepage":"https://apiverve.com/marketplace/mortgagerate?utm_source=npm&utm_medium=homepage","keywords":["mortgage rate","30 year mortgage","15 year mortgage","fixed rate mortgage","freddie mac"],"repository":{"type":"git","url":"git+https://github.com/apiverve/mortgagerate-api.git","directory":"npm"},"description":"Mortgage Rate is a tool for retrieving current and historical US fixed-rate mortgage rates. It returns weekly average rates for 30-year and 15-year fixed mortgages from the Freddie Mac Primary Mortgage Market Survey.","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"readme":"# Mortgage Rate API\r\n\r\nMortgage Rate is a tool for retrieving current and historical US fixed-rate mortgage rates. It returns weekly average rates for 30-year and 15-year fixed mortgages from the Freddie Mac Primary Mortgage Market Survey.\r\n\r\n![Build Status](https://img.shields.io/badge/build-passing-green)\r\n![Code Climate](https://img.shields.io/badge/maintainability-B-purple)\r\n![Prod Ready](https://img.shields.io/badge/production-ready-blue)\r\n[![npm version](https://img.shields.io/npm/v/@apiverve/mortgagerate.svg)](https://www.npmjs.com/package/@apiverve/mortgagerate)\r\n\r\nThis is a Javascript Wrapper for the [Mortgage Rate API](https://apiverve.com/marketplace/mortgagerate?utm_source=npm&utm_medium=readme)\r\n\r\n---\r\n\r\n## Installation\r\n\r\nUsing npm:\r\n```shell\r\nnpm install @apiverve/mortgagerate\r\n```\r\n\r\nUsing yarn:\r\n```shell\r\nyarn add @apiverve/mortgagerate\r\n```\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the Mortgage Rate API client, you have to setup your account and obtain your API Key.\r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)\r\n\r\n---\r\n\r\n## Quick Start\r\n\r\n[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)\r\n\r\nThe Mortgage Rate API documentation is found here: [https://docs.apiverve.com/ref/mortgagerate](https://docs.apiverve.com/ref/mortgagerate?utm_source=npm&utm_medium=readme).\r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```javascript\r\nconst mortgagerateAPI = require('@apiverve/mortgagerate');\r\nconst api = new mortgagerateAPI({\r\n    api_key: '[YOUR_API_KEY]'\r\n});\r\n```\r\n\r\n---\r\n\r\n## Usage\r\n\r\n---\r\n\r\n### Perform Request\r\n\r\nUsing the API is simple. All you have to do is make a request. The API will return a response with the data you requested.\r\n\r\n```javascript\r\nvar query = {\n  type: \"30year\",\n  year: 2023,\n  month: 6\n};\r\n\r\napi.execute(query, function (error, data) {\r\n    if (error) {\r\n        return console.error(error);\r\n    } else {\r\n        console.log(data);\r\n    }\r\n});\r\n```\r\n\r\n---\r\n\r\n### Using Promises\r\n\r\nYou can also use promises to make requests. The API returns a promise that you can use to handle the response.\r\n\r\n```javascript\r\nvar query = {\n  type: \"30year\",\n  year: 2023,\n  month: 6\n};\r\n\r\napi.execute(query)\r\n    .then(data => {\r\n        console.log(data);\r\n    })\r\n    .catch(error => {\r\n        console.error(error);\r\n    });\r\n```\r\n\r\n---\r\n\r\n### Using Async/Await\r\n\r\nYou can also use async/await to make requests. The API returns a promise that you can use to handle the response.\r\n\r\n```javascript\r\nasync function makeRequest() {\r\n    var query = {\n  type: \"30year\",\n  year: 2023,\n  month: 6\n};\r\n\r\n    try {\r\n        const data = await api.execute(query);\r\n        console.log(data);\r\n    } catch (error) {\r\n        console.error(error);\r\n    }\r\n}\r\n```\r\n\r\n---\r\n\r\n## Example Response\r\n\r\n```json\r\n{\n  \"status\": \"ok\",\n  \"error\": null,\n  \"data\": {\n    \"rateType\": \"30year\",\n    \"name\": \"30-Year Fixed Rate Mortgage\",\n    \"term\": 30,\n    \"type\": \"fixed\",\n    \"country\": \"US\",\n    \"year\": 2023,\n    \"month\": 6,\n    \"count\": 4,\n    \"rates\": [\n      {\n        \"week\": \"2023-06-01\",\n        \"rate\": 6.79\n      },\n      {\n        \"week\": \"2023-06-08\",\n        \"rate\": 6.71\n      },\n      {\n        \"week\": \"2023-06-15\",\n        \"rate\": 6.69\n      },\n      {\n        \"week\": \"2023-06-22\",\n        \"rate\": 6.67\n      }\n    ],\n    \"change1w\": -0.02,\n    \"changeDirection\": \"down\",\n    \"previousRate\": 6.69,\n    \"previousDate\": \"2023-06-15\"\n  }\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).\r\n\r\n---\r\n\r\n## Updates\r\n\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=readme), [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=readme), and [Refund Policy](https://apiverve.com/refund?utm_source=npm&utm_medium=readme).\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2026 APIVerve, and EvlarSoft LLC\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n","readmeFilename":"README.md"}