Global

Type Definitions

Meaning

Properties:
Name Type Description
word String
frequency definition Frequency of the usage of this meaning (possibly, not sure)
synsetid String id that identifies this particular meaning
lang String language, always "en" so far
frequency number Frequency of the usage of this meaning (possibly, not sure)
definition String the short definition of this meaning
Source:
Type:
  • Object

VocExample

API's detailed outbound example representation.
Properties:
Name Type Description
text string the example text
offsets Array.<number> an array of offsets that delimit the word in the text. 0-indexed, start inclusive, end exclusive.
Source:
Type:
  • Object

VocList

Voc API's detailed outbound representation of a list. This is a direct mapping of Vocabulary.com's API
Properties:
Name Type Description
wordlistid number the word list id
name string the title of the list
description string the description of the list
words Array.<VocWord> an array of words in Vocabulary.com's format
shared boolean whether the list is shared (public) or not (private)
createdate string example object
modifieddate string a short definition
wordcount number the count of words in the list
learnable number the count of learnable words in the list
unlearnable boolean the count of unlearnable words in the list
owner boolean whether the requester is the owner of the list
Source:
Type:
  • Object

VocListDescription

Voc API's detailed outbound representation of a list. This is a direct mapping of Vocabulary.com's API
Properties:
Name Type Description
wordlistid number the word list id
name string the title of the list
description string the description of the list
shared boolean whether the list is shared (public) or not (private)
createdate string date the list was created
modifieddate string date the list was modified
activitydate string date the list was last played
wordcount number the count of words in the list
owner boolean whether the requester is the owner of the list
p number progress of learning this list
ap number progress of the learning activity on this list (guessed)
Source:
Type:
  • Object

VocWord

Voc API's detailed outbound word representation. This is a direct mapping of Vocabulary.com's API
Properties:
Name Type Description
word string the word
lang lang the language
description string description
example VocExample example object
shortdefinition string a short definition
definition string a longer definition
audio Array.<string> an array of audio codes
ffreq string I have no clue
Source:
Type:
  • Object

Word

Voc API's inbound representation of a word. This is what you give to the API.
Properties:
Name Type Attributes Description
word string the word
location string <optional>
URL location of the word
description string <optional>
description to be added to be attached to the word in a word list
example string <optional>
example or source text containing the word
title string <optional>
the title of the web page that contained the word
Source:
Type:
  • Object

WordSimilarity

Properties:
Name Type Description
word String
similarity number similarity to a given word (low 0 - 1 high)
Source:
Type:
  • Object