{"id":18799882,"url":"https://github.com/mcnaveen/random-words-api","last_synced_at":"2025-04-12T22:19:17.859Z","repository":{"id":37165978,"uuid":"308511242","full_name":"mcnaveen/Random-Words-API","owner":"mcnaveen","description":"🦄 Get Random Words (with pronunciation) for Free using this API","archived":false,"fork":false,"pushed_at":"2025-04-01T10:56:44.000Z","size":830,"stargazers_count":177,"open_issues_count":14,"forks_count":69,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-04T01:33:44.615Z","etag":null,"topics":["english-words","hacktoberfest","random-english-word","random-word","random-word-generator","random-words","randomwords","words-api"],"latest_commit_sha":null,"homepage":"https://random-words-api.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mcnaveen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":"mcnaveen","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://www.buymeacoffee.com/mcnaveen"}},"created_at":"2020-10-30T03:06:46.000Z","updated_at":"2025-04-03T08:52:30.000Z","dependencies_parsed_at":"2023-10-23T15:31:54.233Z","dependency_job_id":"f23094a6-ead3-4569-bf40-346b0869d735","html_url":"https://github.com/mcnaveen/Random-Words-API","commit_stats":{"total_commits":194,"total_committers":10,"mean_commits":19.4,"dds":0.6288659793814433,"last_synced_commit":"e60af96c0251f95860cf35f332b18634a02a87e6"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcnaveen%2FRandom-Words-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcnaveen%2FRandom-Words-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcnaveen%2FRandom-Words-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcnaveen%2FRandom-Words-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcnaveen","download_url":"https://codeload.github.com/mcnaveen/Random-Words-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248638055,"owners_count":21137592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["english-words","hacktoberfest","random-english-word","random-word","random-word-generator","random-words","randomwords","words-api"],"created_at":"2024-11-07T22:16:57.375Z","updated_at":"2025-04-12T22:19:17.828Z","avatar_url":"https://github.com/mcnaveen.png","language":"JavaScript","funding_links":["https://patreon.com/mcnaveen","https://www.buymeacoffee.com/mcnaveen"],"categories":[],"sub_categories":[],"readme":"# Random Words API\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n![build-test](https://github.com/mcnaveen/Random-Words-API/workflows/build-test/badge.svg)\n\n🦄 Get Random Words (with pronunciation) for Free using this API\n\n## 🌍 Languages\n\n- English\n- Dutch\n- Spanish\n- French\n- Chinese\n- Japanese\n\n## 🚀 API\n\n- English Random Words - `https://random-words-api.vercel.app/word`\n- Dutch Random Words - `https://random-words-api.vercel.app/word/dutch`\n- Spanish Random Words - `https://random-words-api.vercel.app/word/spanish`\n- French Random Words - `https://random-words-api.vercel.app/word/french`\n- Chinese Random Words - `https://random-words-api.vercel.app/word/chinese`\n- Japanese Random Words - `https://random-words-api.vercel.app/word/japanese`\n- Turkish Random Words - `https://random-words-api.vercel.app/word/turkish`\n\n- PWA Demo - [Check Here](https://words.sanweb.info/)\n\n## 🎛 Route Options (English Only)\n- Base URL: `https://random-words-api.vercel.app/word/english`\n```text\n- /noun\n- /sentence\n- /question\n- /adjective\n- /idiom\n- /verb\n- /letter\n- /paragraph\n- /vocabulary\n- /1-word-quotes\n- /2-word-quotes\n- /3-word-quotes\n- /affirmation\n```\n\n## 🌐 Sample API Response\n\n- API: `https://random-words-api.vercel.app/word/`\n- Method: `GET`\n\n```json\n[\n  {\n    \"word\": \"Exactor\",\n    \"definition\": \"One who exacts; extortioner; claimer of rights  \",\n    \"pronunciation\": \"Eksaktor\"\n  }\n]\n```\n\n## 🌐 Sample Dutch Response\n\n- API: `https://random-words-api.vercel.app/word/dutch`\n- Method: `GET`\n\n```json\n[\n  {\n    \"word\": \"Perfect\",\n    \"definition\": \"Perfect\",\n    \"pronunciation\": \"Perfekt\"\n  }\n]\n```\n\n- Check [api.rest](/test/api.rest) file for more details\n\n## 💡 Learn New word\n\n- [Join Telegram Channel](https://t.me/learnwordoftheday)\n- [Learn Online](https://words.sanweb.info/)\n\n## ✨ Installation (Development)\n\n```sh\n# Clone the Repo\ngit clone https://github.com/mcnaveen/random-words-api random-words-api\n\n# Cd into Directory\ncd random-words\n\n# Install Dependencies\nnpm install\n\n# Start the Development Server\nnpm run dev\n```\n\n## 🔀 Deploying to Heroku\n\nOneClick Deploy on Heroku\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/mcnaveen/Random-Words-API)\n\n## 🔀 Deploying to Vercel\n\nOneClick Deploy on Vercel\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fmcnaveen%2FRandom-Words-API.git)\n\nOR\n\n```html\n- Fork the Repo - Login to Vercel (https://vercel.com/dashboard) - Click Import\nProject - Give Forked Repo URL - Go Live\n```\n\n## 🔐 Rate Limit\n\n- To configure the rate limit, edit the `utils/index.js` file\n- Look for `limiter` variable\n- `max` is the maximum number of requests allowed in a given time window\n- `windowMs` is the time window in milliseconds\n- `message` is the message to be returned when the rate limit is exceeded\n\n## 😇 Add New Language\n- Create a new folder in `data` with the full language name `ex: english`\n- Add the words in the `words.json` file\n- It should be an array of objects with `id`, `word`, and `definition` properties\n- The `id` should be a unique number for each word\n- The `word` should be the word in the language\n- The `definition` should be the definition of the word in English\n- The `pronunciation` should be the pronunciation of the word in the language (Optional)\n\n## :question: How to Contribute?\n\nMake your changes and follow the below instructions. We follow conventional commits.\n\n### ✍️ Commit\n\n- Stage all changes\n\n```sh\ngit add .\n```\n\n- Commit the changes\n\n```sh\nyarn commit\n```\n\n- Push the changes to GitHub\n\n```sh\ngit push \u003cTO YOUR FORK\u003e\n```\n\n## ⚛ USED BY\n\n|      Project Name       |                        Demo/Preview                        |                        Source Code                        | Author                                   |\n| :---------------------: | :--------------------------------------------------------: | :-------------------------------------------------------: | ---------------------------------------- |\n|    Vue Random Words     |             [Demo](https://words.sanweb.info/)             |   [Source](https://github.com/mskian/vue-random-words)    | [@mskian](https://github.com/mskian)     |\n|    Speak \u0026 Spell Elm    |        [Demo](https://speak-and-spell.vercel.app/)         |  [Source](https://github.com/gacallea/elm_speakandspell)  | [@gacallea](https://github.com/gacallea) |\n|    Random Words CLI     | [Showcase](https://www.npmjs.com/package/random-words-cli) |  [Source](https://github.com/mcnaveen/random-words-cli)   | [@mcnaveen](https://github.com/mcnaveen) |\n| Random Words CLI (Deno) | [Showcase](https://deno.land/x/randomwords) | [Source](https://github.com/mskian/deno-random-words-cli) | [@mskian](https://github.com/mskian) |\n\n## ☑ License\n\n- MIT\n\n## ⚠ Disclaimer\n\nWe don't own any data or word. All belongs to the owner of Website. Use it for educational purpose only.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/mcnaveen\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8493007?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMC Naveen\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mcnaveen/Random-Words-API/issues?q=author%3Amcnaveen\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/commits?author=mcnaveen\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#data-mcnaveen\" title=\"Data\"\u003e🔣\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/commits?author=mcnaveen\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#example-mcnaveen\" title=\"Examples\"\u003e💡\u003c/a\u003e \u003ca href=\"#ideas-mcnaveen\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-mcnaveen\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/pulls?q=is%3Apr+reviewed-by%3Amcnaveen\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/jonah-butler\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/18040568?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ejonah-butler\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mcnaveen/Random-Words-API/commits?author=jonah-butler\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/commits?author=jonah-butler\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://santhoshveer.com/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10300271?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSanthosh Veer\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mcnaveen/Random-Words-API/commits?author=mskian\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/commits?author=mskian\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-mskian\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-mskian\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/issues?q=author%3Amskian\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/mcnaveen/Random-Words-API/pulls?q=is%3Apr+reviewed-by%3Amskian\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcnaveen%2Frandom-words-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcnaveen%2Frandom-words-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcnaveen%2Frandom-words-api/lists"}