This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

FreeDictionaryApi

FreeDictionaryApi is a free API that provides dictionary data from Wiktionary and it is the one used by the useDictionaryLookup hook. It can be used to get word translations, definitions and examples.

Their own documentation

Licence

The API uses Wiktionary data under the CC BY-SA 4.0 license. Attribution to Wiktionary and FreeDictionaryApi is required when using the API.

Requests

The get request that the hook makes looks like this:

https://freedictionaryapi.com/api/v1/entries/<Language>/<Word>?translations=true

where Word is the word to look up and Language is the language of that word.

Response structure

The root object in the returned data contains an array called entries. At each index in entries is an object that represents a specific grammatical usage (verb, noun, etc) of the word. These objects contain information such as:

• Different forms (tense, conjugation, etc)
• Pronunciation
• Senses

Senses is an array that contains objects with information about different senses of the word. Included in these objects are:

• Definition
• Usage examples
• Quotes
• Synonyms and antonyms
• Translations

Example of returned data for the word "value"

Some of the arrays only shows one index for readability

{
  "word": "value",
  "entries": [
    {
      "language": { "code": "en", "name": "English" },
      "partOfSpeech": "noun",
      "pronunciations": [
        { "type": "ipa", "text": "/ˈvæl.juː/", "tags": [] }
      ],
      "forms": [
        { "word": "values", "tags": ["plural"] }
      ],
      "senses": [
        {
          "definition": "The quality that renders something desirable or valuable; worth.",
          "tags": ["countable", "uncountable"],
          "examples": [
            "There is tremendous value in a good education."
          ],
          "quotes": [
            {
              "text": "United were value for their win...",
              "reference": "2012 May 13, BBC Sport"
            }
          ],
          "synonyms": ["worth"],
          "antonyms": [],
          "translations": [
            { "language": { "code": "fr", "name": "French" }, "word": "valeur" },
            { "language": { "code": "de", "name": "German" }, "word": "Wert" }
          ]
        }
      ]
    }
  ],
  "source": {
    "url": "https://en.wiktionary.org/wiki/value",
    "license": { "name": "CC BY-SA 4.0", "url": "https://creativecommons.org/licenses/by-sa/4.0/" }
  }
}