fega / wordreference-api

An api to use the worldreference.com information

wordreference-api

An api to use the worldreference.com information

Installation

$ npm install --save wordreference-api

Usage

var wr = require('wordreference-api');
/**
 * wr
 * Gets the result for the given word, available languages: 'es', 'en', 'it', 'fr'
 * @param  {String} word Word to be searched
 * @param  {String} from from language, default 'en'
 * @param  {String} to   to language, default 'es'
 * @return {Object}      Object with the word data
 */
wr('Rainbow');
wr('Rainbow','en','fr').then((result)=> console.log);

Return:

{
  "word": "Rainbow",
  "pronWR": "/ˈreɪnˌbəʊ/",
  "audio": [
    "/audio/en/us/us/en069238.mp3",
    "/audio/en/uk/general/en069238.mp3",
    "/audio/en/uk/Yorkshire/en069238-55.mp3",
    "/audio/en/Irish/en069238.mp3",
    "/audio/en/scot/en069238.mp3",
    "/audio/en/us/south/en069238.mp3",
    "/audio/en/Jamaica/en069238.mp3"
  ],
  "translations": [
    {
      "title": "Principal Translations",
      "translations": [
        {
          "from": "rainbow",
          "fromType": "n",
          "toType": "grupo nom",
          "to": "arco iris "
        }
      ]
    },
    {
      "title": "Compound Forms:",
      "translations": [
        {
          "from": "rainbow trout",
          "fromType": "n",
          "toType": "nf",
          "to": "trucha arcoiris "
        }
      ]
    }
  ]
}

License

MIT © Fabian Gutierrez

wordreference-api's Issues

Audio is not working

The field audio in the result is not working (empty array).

I think word reference changed the html so a fix of the html parserer should be done

It is not an API

API calls provide a structured way to access data directly from a service's backend, unlike web scraping which parses raw HTML content.
result.word = $('h3.headerWord').text()
Your approach is highly depended on the structure of the website's HTML and if they change their design you should rewrite your code.
Maybe it's better to change your project's name to prevent confusion.