@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api api.wordnik.com
@base https://api.wordnik.com/v4
@version 4.0
@auth ApiKey api_key in query
@endpoints 16
@toc word.json(11), words.json(5)

@group word.json
@endpoint GET /word.json/{word}/audio
@required {word: any}
@optional {useCanonical: any, limit: any}
@returns(200)

@endpoint GET /word.json/{word}/definitions
@required {word: any}
@optional {limit: any, partOfSpeech: any, includeRelated: any, sourceDictionaries: any, useCanonical: any, includeTags: any}
@returns(200)

@endpoint GET /word.json/{word}/etymologies
@required {word: any}
@optional {useCanonical: any}
@returns(200)

@endpoint GET /word.json/{word}/examples
@required {word: any}
@optional {includeDuplicates: any, useCanonical: any, skip: any, limit: any}
@returns(200)

@endpoint GET /word.json/{word}/frequency
@required {word: any}
@optional {useCanonical: any, startYear: any, endYear: any}
@returns(200)

@endpoint GET /word.json/{word}/hyphenation
@required {word: any}
@optional {useCanonical: any, sourceDictionary: any, limit: any}
@returns(200)

@endpoint GET /word.json/{word}/phrases
@required {word: any}
@optional {limit: any, wlmi: any, useCanonical: any}
@returns(200)

@endpoint GET /word.json/{word}/pronunciations
@required {word: any}
@optional {useCanonical: any, sourceDictionary: any, typeFormat: any, limit: any}
@returns(200)

@endpoint GET /word.json/{word}/relatedWords
@required {word: any}
@optional {useCanonical: any, relationshipTypes: any, limitPerRelationshipType: any}
@returns(200)

@endpoint GET /word.json/{word}/scrabbleScore
@required {word: any}
@returns(200)

@endpoint GET /word.json/{word}/topExample
@required {word: any}
@optional {useCanonical: any}
@returns(200)

@endgroup

@group words.json
@endpoint GET /words.json/randomWord
@optional {hasDictionaryDef: any, includePartOfSpeech: any, excludePartOfSpeech: any, minCorpusCount: any, maxCorpusCount: any, minDictionaryCount: any, maxDictionaryCount: any, minLength: any, maxLength: any}
@returns(200)

@endpoint GET /words.json/randomWords
@optional {hasDictionaryDef: any, includePartOfSpeech: any, excludePartOfSpeech: any, minCorpusCount: any, maxCorpusCount: any, minDictionaryCount: any, maxDictionaryCount: any, minLength: any, maxLength: any, sortBy: any, sortOrder: any, limit: any}
@returns(200)

@endpoint GET /words.json/reverseDictionary
@required {query: any}
@optional {findSenseForWord: any, includeSourceDictionaries: any, excludeSourceDictionaries: any, includePartOfSpeech: any, excludePartOfSpeech: any, minCorpusCount: any, maxCorpusCount: any, minLength: any, maxLength: any, expandTerms: any, includeTags: any, sortBy: any, sortOrder: any, skip: any, limit: any}
@returns(200)

@endpoint GET /words.json/search/{query}
@required {query: any}
@optional {allowRegex: any, caseSensitive: any, includePartOfSpeech: any, excludePartOfSpeech: any, minCorpusCount: any, maxCorpusCount: any, minDictionaryCount: any, maxDictionaryCount: any, minLength: any, maxLength: any, skip: any, limit: any}
@returns(200)

@endpoint GET /words.json/wordOfTheDay
@optional {date: any}
@returns(200)

@endgroup

@end
