{"id":16372765,"url":"https://github.com/mucsi96/forvo","last_synced_at":"2025-03-21T01:31:44.483Z","repository":{"id":51841545,"uuid":"106922179","full_name":"mucsi96/forvo","owner":"mucsi96","description":"Forvo’s API gives you access to 4 million audio pronunciations and translations in over 340 languages. ","archived":false,"fork":false,"pushed_at":"2021-05-09T15:12:29.000Z","size":989,"stargazers_count":15,"open_issues_count":7,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T19:40:03.394Z","etag":null,"topics":["api","forvo","language","learn","pronunciations","speech"],"latest_commit_sha":null,"homepage":null,"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/mucsi96.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-14T11:26:37.000Z","updated_at":"2025-03-04T22:39:01.000Z","dependencies_parsed_at":"2022-09-08T00:40:48.551Z","dependency_job_id":null,"html_url":"https://github.com/mucsi96/forvo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Fforvo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Fforvo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Fforvo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Fforvo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mucsi96","download_url":"https://codeload.github.com/mucsi96/forvo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244721229,"owners_count":20498913,"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":["api","forvo","language","learn","pronunciations","speech"],"created_at":"2024-10-11T03:12:20.800Z","updated_at":"2025-03-21T01:31:44.198Z","avatar_url":"https://github.com/mucsi96.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# forvo\n\n[Forvo’s](https://forvo.com/) API gives you access to 4 million audio pronunciations and translations in over 340 languages.\n\n# Getting started\n\nFirst you need to have Forvo to be installed locally.\n\n```bash\nnpm i --save forvo\n```\n\nNow you can get the best pronunciation for a word pronounced by native speaker.\nYou need to have an API key for [Forvo](https://api.forvo.com/).\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n    const wordPronunciations = await forvo.standardPronunciation({ word: 'auf Wiederschauen', language: 'de' })\n    // {\n    //   items:[\n    //     { id: 5943, word: 'auf_wiederschauen', original: 'auf Wiederschauen', pathmp3: 'https://apifree.forvo.com/audio/3h3h...\n    //   ]\n    // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\n# API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n### Table of Contents\n\n-   [forvoApi](#forvoapi)\n    -   [Parameters](#parameters)\n    -   [Examples](#examples)\n-   [Api](#api)\n    -   [Properties](#properties)\n-   [Api.wordPronunciations](#apiwordpronunciations)\n    -   [Parameters](#parameters-1)\n    -   [Examples](#examples-1)\n-   [Api.standardPronunciation](#apistandardpronunciation)\n    -   [Parameters](#parameters-2)\n    -   [Examples](#examples-2)\n-   [Api.languageList](#apilanguagelist)\n    -   [Parameters](#parameters-3)\n    -   [Examples](#examples-3)\n-   [Api.popularLanguages](#apipopularlanguages)\n    -   [Parameters](#parameters-4)\n    -   [Examples](#examples-4)\n-   [Api.pronouncedWordsSearch](#apipronouncedwordssearch)\n    -   [Parameters](#parameters-5)\n    -   [Examples](#examples-5)\n-   [Api.wordsSearch](#apiwordssearch)\n    -   [Parameters](#parameters-6)\n    -   [Examples](#examples-6)\n-   [Api.popularPronouncedWords](#apipopularpronouncedwords)\n    -   [Parameters](#parameters-7)\n    -   [Examples](#examples-7)\n\n## forvoApi\n\nThis function creates forvo api.\n\n### Parameters\n\n-   `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Configuration object for forvo api\n    -   `options.key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Your forvo api key\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\n```\n\nReturns **API** Api\n\n## Api\n\nThis object represents a forvo Api.\n\nType: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n### Properties\n\n-   `wordPronunciations` **[Api.wordPronunciations](#apiwordpronunciations)** This function gets all the pronunciations from a word.\n-   `standardPronunciation` **[Api.standardPronunciation](#apistandardpronunciation)** This function gets the standard (top rated) pronunciation from a word.\n-   `languageList` **[Api.languageList](#apilanguagelist)** This function gets languages availables at Forvo.\n-   `popularLanguages` **[Api.popularLanguages](#apipopularlanguages)** This function gets the most popular languages.\n-   `pronouncedWordsSearch` **[Api.pronouncedWordsSearch](#apipronouncedwordssearch)** This function gets words starting with a pattern alphabetically ordered with one or more pronunciations.\n-   `wordsSearch` **[Api.wordsSearch](#apiwordssearch)** This function gets words starting with a pattern alphabetically ordered.\n-   `popularPronouncedWords` **[Api.popularPronouncedWords](#apipopularpronouncedwords)** This function gets the most popular words with, at least, one pronunciation..\n\n## Api.wordPronunciations\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/word-pronunciations)**\n\nThis function gets all the pronunciations from a word.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.word` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The word you want to get its pronunciations.\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** To get only the pronunciations recorded in the given language.\n    -   `parameters.country` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** To get only the pronunciations recorded by users of this country. You should use the Alpha-3 code.\n    -   `parameters.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Returns the pronunciation recorded by a specific user.\n    -   `parameters.sex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** m (for male), f (for female)\n    -   `parameters.rate` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** To get only the pronunciations rated with at least the given value.\n    -   `parameters.order` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** date-desc (pronunciations order by pronounced time, from recent to older)\n        date-asc (pronunciations order by pronounced time, older to recent)\n        rate-desc (pronunciations order by rate, high rated first)\n        rate-asc (pronunciations order by rate, low rated first)\n    -   `parameters.limit` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Max. pronunciations returned.\n    -   `parameters.groupInLanguages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Group pronunciations in languages. Default value is false.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.wordPronunciations({ word: 'Apfel', language: 'de' })\n  // {\n  //   attributes: { total: 11 },\n  //   items:[\n  //     { id: 5943, word: 'apfel', original: 'Apfel', pathmp3: 'https://apifree.forvo.com/audio/3h3h...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** All the pronunciations from a word\n\n## Api.standardPronunciation\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/standard-pronunciation)**\n\nThis function gets the standard (top rated) pronunciation from a word.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.word` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The word you want to get its pronunciations.\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** To get only the pronunciations recorded in the given language.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.standardPronunciation({ word: 'auf Wiederschauen', language: 'de' })\n  // {\n  //   items:[\n  //     { id: 5943, word: 'auf_wiederschauen', original: 'auf Wiederschauen', pathmp3: 'https://apifree.forvo.com/audio/3h3h...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** Standard (top rated) pronunciation from a word\n\n## Api.languageList\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/language-list)**\n\nThis function gets languages availables at Forvo.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Language code or \"native\" to get the language list with the names of the languages in their native languages. Default is English (en).\n    -   `parameters.order` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Values: \"name\" or \"code\". Default is name.\n    -   `parameters.minPronunciations` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Values: any integer number. To get only the languagues with, at least, the given number of pronunciations.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.languageList()\n  // {\n  //   attributes: { total: 349 },\n  //   items:[\n  //     { code: 'abq', en: 'Abaza' },\n  //     { code: 'ab', en: 'Abkhazian' },\n  //     ...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** Languages availables at Forvo.\n\n## Api.popularLanguages\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/language-popular)**\n\nThis function gets the most popular languages.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Values: Language code or \"native\" to get the language list with the names of the languages in their native languages. Default is English (en).\n    -   `parameters.order` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Values: \"popular\", \"name\" or \"code\". Default is \"popular\".\n    -   `parameters.limit` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Values: any integer number. Max. languages returned. Default is 10.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.popularLanguages()\n  // {\n  //   attributes: { total: 10 },\n  //   items:[\n  //     { code: 'de', en: 'German' },\n  //     { code: 'tt', en: 'Tatar' },\n  //     ...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** The most popular languages\n\n## Api.pronouncedWordsSearch\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/pronounced-words-search)**\n\nThis function gets words starting with a pattern alphabetically ordered with one or more pronunciations.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.search` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The pattern you want to search.\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** To get only the pronunciations recorded in the given language.\n    -   `parameters.pagesize` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Values: any integer number between 1-100. Set the page size in results. Default is 20.\n    -   `parameters.page` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Values: any integer number. Set the page results you want to retrieve. Default is 1.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.pronouncedWordsSearch({ search: 'aus', language: 'de' })\n  // {\n  //   attributes: attributes: { page: 1, pagesize: 20, total_pages: 7, total: 121 },\n  //   items:[\n  //     { id: 20945, word: 'aus', original: 'aus', num_pronunciations: '4', standard_pronunciation: ... },\n  //     { id: 20945, word: 'aus_dem_weg_gehen', original: 'aus dem Weg gehen', num_pronunciations ... }\n  //     ...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** Words starting with a pattern alphabetically ordered with one or more pronunciations\n\n## Api.wordsSearch\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/words-search)**\n\nThis function gets words starting with a pattern alphabetically ordered.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.search` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The pattern you want to search.\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** To get only the pronunciations recorded in the given language.\n    -   `parameters.pagesize` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Values: any integer number between 1-100. Set the page size in results. Default is 20.\n    -   `parameters.page` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Values: any integer number. Set the page results you want to retrieve. Default is 1.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.wordsSearch({ search: 'aus', language: 'de' })\n  // {\n  //   attributes: attributes: { page: 1, pagesize: 20, total_pages: 7, total: 121 },\n  //   items:[\n  //     { id: 20945, word: 'aus', original: 'aus', num_pronunciations: '4', standard_pronunciation: ... },\n  //     { id: 20945, word: 'aus_dem_weg_gehen', original: 'aus dem Weg gehen', num_pronunciations ... }\n  //     ...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** Words starting with a pattern alphabetically ordered\n\n## Api.popularPronouncedWords\n\n-   **See: [forvo API documentation](https://api.forvo.com/documentation/popular-pronounced-words)**\n\nThis function gets the most popular words with, at least, one pronunciation.\n\n### Parameters\n\n-   `parameters` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Parameters object provided for forvo api\n    -   `parameters.language` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** To get only the words in the given language.\n    -   `parameters.limit` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Values: any integer number. Max. word returned. Default is 1000.\n\n### Examples\n\n```javascript\nimport forvoApi from 'forvo';\n\nconst forvo = forvoApi({ key: 'your api key' });\nconst start = async () =\u003e {\n  const wordPronunciations = await forvo.popularPronouncedWords({ language: 'de' })\n  // {\n  //   attributes: { total: 993 },\n  //   items:[\n  //     { id: 5619, word: 'adidas', original: 'Adidas', num_pronunciations: '4' },\n  //     { id: 3697234, word: 'airbagbereich', original: 'Airbagbereich', num_pronunciations: '3' }\n  //     ...\n  //   ]\n  // }\n}\n\nstart().catch(err =\u003e console.log(err.stack));\n```\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** The most popular words with, at least, one pronunciation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmucsi96%2Fforvo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmucsi96%2Fforvo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmucsi96%2Fforvo/lists"}