{"_id":"@apiverve/menstrualcycle","_rev":"4-831e7f2f5278a8ea8b7e5efe4416b35e","name":"@apiverve/menstrualcycle","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.12":{"name":"@apiverve/menstrualcycle","version":"1.1.12","keywords":["menstrual cycle","period tracker","cycle calculator","period calendar","menstruation tracker"],"author":{"url":"http://apiverve.com/","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/menstrualcycle@1.1.12","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/menstrualcycle?utm_source=npm","bugs":{"url":"https://github.com/apiverve/menstrualcycle-api/issues"},"dist":{"shasum":"d56c6a7d990bf98743976b15443ad2ec51f6df9f","tarball":"https://registry.npmjs.org/@apiverve/menstrualcycle/-/menstrualcycle-1.1.12.tgz","fileCount":7,"integrity":"sha512-ZifIA8Mg0KREIWh4CVc0fd/ceHJ7f3fRT4ekluvTavwlJXq2YmVqrKK3P6mwvPIcQtJo1vd6W+4AefxZeeX22Q==","signatures":[{"sig":"MEUCIQD4Wpna2FMn7bDl86/KbgHlAbvXNSX2OkHN+kT8Bii7LAIgEeys7PLf2DS0VkDXYZ20R/jWnzE/rPeg2WXvDLPlm1E=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18737},"main":"index.js","types":"index.d.ts","gitHead":"9d8e77b9fc6545198b9b9f57ce739a87b73ef06c","scripts":{"test":"mocha","example":"node examples/basic.js"},"_npmUser":{"name":"apivervehq","email":"hello@apiverve.com"},"repository":{"url":"git+https://github.com/apiverve/menstrualcycle-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Menstrual Cycle Calculator predicts future menstrual cycles, fertile windows, and ovulation dates based on cycle history and patterns.","directories":{},"_nodeVersion":"20.13.1","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/menstrualcycle_1.1.12_1765262842767_0.29384280420699826","host":"s3://npm-registry-packages-npm-production"}},"1.1.13":{"name":"@apiverve/menstrualcycle","version":"1.1.13","keywords":[],"author":{"url":"https://apiverve.com","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/menstrualcycle@1.1.13","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/menstrualcycle?utm_source=npm&utm_medium=homepage","bugs":{"url":"https://github.com/apiverve/menstrualcycle-api/issues"},"dist":{"shasum":"ac638fdb5c71c89040681f9febfe5d15ba497d33","tarball":"https://registry.npmjs.org/@apiverve/menstrualcycle/-/menstrualcycle-1.1.13.tgz","fileCount":5,"integrity":"sha512-WrkfXIlBxPvU/uKzoGAfUqqdRFUo4yTADR2rPndPNrttPDzKlLAUdkJ0TVVl4A0XMab1A+H7lI+y+nESeIVD3A==","signatures":[{"sig":"MEYCIQCgRZ3y1O2rRK809aHbpwDYszPA0gt4DcG2WqopaqSTEAIhAOBS97JtqEWfRoceFxSOBJgCQg0HLOwfBDRl99tZfb99","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22497},"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/menstrualcycle-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Menstrual Cycle Calculator predicts future menstrual cycles, fertile windows, and ovulation dates based on cycle history and patterns.","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/menstrualcycle_1.1.13_1771047543912_0.8179185725367462","host":"s3://npm-registry-packages-npm-production"}},"1.1.14":{"name":"@apiverve/menstrualcycle","version":"1.1.14","keywords":[],"author":{"url":"https://apiverve.com","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/menstrualcycle@1.1.14","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/menstrualcycle?utm_source=npm&utm_medium=homepage","bugs":{"url":"https://github.com/apiverve/menstrualcycle-api/issues"},"dist":{"shasum":"5d2930e38b36fe5fd4eeeaeaead05e0fa6815ca4","tarball":"https://registry.npmjs.org/@apiverve/menstrualcycle/-/menstrualcycle-1.1.14.tgz","fileCount":5,"integrity":"sha512-zVouzqH/rWbovcNGgS5Se/9Erghyelun2V/8o1YFMue5wiTsiJB0EIeFN3LzrxotThUjLc/WEiPLXudM7vizUA==","signatures":[{"sig":"MEUCIGGK89S8EWTw4rBSefddXhPZ4tPVJX+jXbA6bF6YnolAAiEAk8vmDun9Eq0XMQzZkfIRKWoWtDEQMzDBboaLgwNp8bg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22206},"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/menstrualcycle-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Menstrual Cycle Calculator predicts future menstrual cycles, fertile windows, and ovulation dates based on cycle history and patterns.","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/menstrualcycle_1.1.14_1771238541083_0.47003403353841056","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@apiverve/menstrualcycle","version":"1.2.0","description":"Menstrual Cycle Calculator predicts future menstrual cycles, fertile windows, and ovulation dates based on cycle history and patterns.","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/menstrualcycle-api.git","directory":"npm"},"keywords":["menstrual cycle","period tracker","cycle calculator","period calendar","menstruation tracker"],"author":{"name":"APIVerve","email":"hello@apiverve.com","url":"https://apiverve.com"},"license":"MIT","bugs":{"url":"https://github.com/apiverve/menstrualcycle-api/issues"},"homepage":"https://apiverve.com/marketplace/menstrualcycle?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/menstrualcycle@1.2.0","_nodeVersion":"24.15.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-QdsZVWTAwaPM0VufyMnkzcgkvg2CoMuxoTMFWW5CobX23wdjSkOY3X6KtE4+o7IW6kWH83kagpmhNe3RsXUGLw==","shasum":"9fdbea467b94df0e799201c030cd5a748b58c1fe","tarball":"https://registry.npmjs.org/@apiverve/menstrualcycle/-/menstrualcycle-1.2.0.tgz","fileCount":5,"unpackedSize":22824,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFKjflf/q89v8uNGgvIJCd0Yrnxwm/R4wq1IaP02jKqHAiAaHkfPgCruYydxJV6nipx/OqljmCJZhrhLngHzIIUJOw=="}]},"_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/menstrualcycle_1.2.0_1784151973153_0.5043181827671381"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-09T06:47:22.696Z","modified":"2026-07-15T21:46:13.418Z","1.1.12":"2025-12-09T06:47:22.939Z","1.1.13":"2026-02-14T05:39:04.073Z","1.1.14":"2026-02-16T10:42:21.232Z","1.2.0":"2026-07-15T21:46:13.300Z"},"bugs":{"url":"https://github.com/apiverve/menstrualcycle-api/issues"},"author":{"name":"APIVerve","email":"hello@apiverve.com","url":"https://apiverve.com"},"license":"MIT","homepage":"https://apiverve.com/marketplace/menstrualcycle?utm_source=npm&utm_medium=homepage","keywords":["menstrual cycle","period tracker","cycle calculator","period calendar","menstruation tracker"],"repository":{"type":"git","url":"git+https://github.com/apiverve/menstrualcycle-api.git","directory":"npm"},"description":"Menstrual Cycle Calculator predicts future menstrual cycles, fertile windows, and ovulation dates based on cycle history and patterns.","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"readme":"# Menstrual Cycle Calculator API\r\n\r\nMenstrual Cycle Calculator predicts future menstrual cycles, fertile windows, and ovulation dates based on cycle history and patterns.\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/menstrualcycle.svg)](https://www.npmjs.com/package/@apiverve/menstrualcycle)\r\n\r\nThis is a Javascript Wrapper for the [Menstrual Cycle Calculator API](https://apiverve.com/marketplace/menstrualcycle?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/menstrualcycle\r\n```\r\n\r\nUsing yarn:\r\n```shell\r\nyarn add @apiverve/menstrualcycle\r\n```\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the Menstrual Cycle Calculator 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 Menstrual Cycle Calculator API documentation is found here: [https://docs.apiverve.com/ref/menstrualcycle](https://docs.apiverve.com/ref/menstrualcycle?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 menstrualcycleAPI = require('@apiverve/menstrualcycle');\r\nconst api = new menstrualcycleAPI({\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  last_period: \"2024-01-01\",\n  cycle_length: 28,\n  period_length: 5,\n  cycles: 3\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  last_period: \"2024-01-01\",\n  cycle_length: 28,\n  period_length: 5,\n  cycles: 3\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  last_period: \"2024-01-01\",\n  cycle_length: 28,\n  period_length: 5,\n  cycles: 3\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    \"last_period_date\": \"2024-01-01\",\n    \"cycle_length\": 28,\n    \"period_length\": 5,\n    \"cycles_calculated\": 3,\n    \"cycles\": [\n      {\n        \"cycle_number\": 1,\n        \"period\": {\n          \"start_date\": \"2024-01-01\",\n          \"end_date\": \"2024-01-05\",\n          \"duration_days\": 5\n        },\n        \"ovulation\": {\n          \"date\": \"2024-01-15\",\n          \"day_of_cycle\": 14\n        },\n        \"fertile_window\": {\n          \"start_date\": \"2024-01-10\",\n          \"end_date\": \"2024-01-15\",\n          \"duration_days\": 6\n        },\n        \"pms_phase\": {\n          \"start_date\": \"2023-12-21\",\n          \"end_date\": \"2023-12-31\"\n        },\n        \"cycle_phases\": {\n          \"menstrual\": {\n            \"start\": \"2024-01-01\",\n            \"end\": \"2024-01-05\",\n            \"description\": \"Menstruation\"\n          },\n          \"follicular\": {\n            \"start\": \"2024-01-06\",\n            \"end\": \"2024-01-14\",\n            \"description\": \"Follicular phase - preparing for ovulation\"\n          },\n          \"ovulation\": {\n            \"date\": \"2024-01-15\",\n            \"description\": \"Ovulation - most fertile day\"\n          },\n          \"luteal\": {\n            \"start\": \"2024-01-16\",\n            \"end\": \"2024-01-28\",\n            \"description\": \"Luteal phase - preparing for next period\"\n          }\n        },\n        \"status\": \"past\",\n        \"days_until\": null,\n        \"days_ago\": 715\n      },\n      {\n        \"cycle_number\": 2,\n        \"period\": {\n          \"start_date\": \"2024-01-29\",\n          \"end_date\": \"2024-02-02\",\n          \"duration_days\": 5\n        },\n        \"ovulation\": {\n          \"date\": \"2024-02-12\",\n          \"day_of_cycle\": 14\n        },\n        \"fertile_window\": {\n          \"start_date\": \"2024-02-07\",\n          \"end_date\": \"2024-02-12\",\n          \"duration_days\": 6\n        },\n        \"pms_phase\": {\n          \"start_date\": \"2024-01-18\",\n          \"end_date\": \"2024-01-28\"\n        },\n        \"cycle_phases\": {\n          \"menstrual\": {\n            \"start\": \"2024-01-29\",\n            \"end\": \"2024-02-02\",\n            \"description\": \"Menstruation\"\n          },\n          \"follicular\": {\n            \"start\": \"2024-02-03\",\n            \"end\": \"2024-02-11\",\n            \"description\": \"Follicular phase - preparing for ovulation\"\n          },\n          \"ovulation\": {\n            \"date\": \"2024-02-12\",\n            \"description\": \"Ovulation - most fertile day\"\n          },\n          \"luteal\": {\n            \"start\": \"2024-02-13\",\n            \"end\": \"2024-02-25\",\n            \"description\": \"Luteal phase - preparing for next period\"\n          }\n        },\n        \"status\": \"past\",\n        \"days_until\": null,\n        \"days_ago\": 687\n      },\n      {\n        \"cycle_number\": 3,\n        \"period\": {\n          \"start_date\": \"2024-02-26\",\n          \"end_date\": \"2024-03-01\",\n          \"duration_days\": 5\n        },\n        \"ovulation\": {\n          \"date\": \"2024-03-11\",\n          \"day_of_cycle\": 14\n        },\n        \"fertile_window\": {\n          \"start_date\": \"2024-03-06\",\n          \"end_date\": \"2024-03-11\",\n          \"duration_days\": 6\n        },\n        \"pms_phase\": {\n          \"start_date\": \"2024-02-15\",\n          \"end_date\": \"2024-02-25\"\n        },\n        \"cycle_phases\": {\n          \"menstrual\": {\n            \"start\": \"2024-02-26\",\n            \"end\": \"2024-03-01\",\n            \"description\": \"Menstruation\"\n          },\n          \"follicular\": {\n            \"start\": \"2024-03-02\",\n            \"end\": \"2024-03-10\",\n            \"description\": \"Follicular phase - preparing for ovulation\"\n          },\n          \"ovulation\": {\n            \"date\": \"2024-03-11\",\n            \"description\": \"Ovulation - most fertile day\"\n          },\n          \"luteal\": {\n            \"start\": \"2024-03-12\",\n            \"end\": \"2024-03-24\",\n            \"description\": \"Luteal phase - preparing for next period\"\n          }\n        },\n        \"status\": \"past\",\n        \"days_until\": null,\n        \"days_ago\": 659\n      }\n    ],\n    \"current_status\": {\n      \"phase\": \"Unknown\",\n      \"description\": \"\",\n      \"next_period\": null,\n      \"days_until_next_period\": null\n    },\n    \"averages\": {\n      \"cycle_length\": 28,\n      \"period_duration\": 5,\n      \"days_between_periods\": 28\n    },\n    \"disclaimer\": \"This calculator provides estimates only. Actual cycles may vary. Consult a healthcare provider for medical advice.\"\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"}