@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api public_doc_guest
@base https://od-api-demo.oxforddictionaries.com:443/api/v1
@version 1.11.0
@auth ApiKey app_id in header
@common_fields {app_id: any, app_key: any}
@endpoints 26
@hint download_for_search
@toc inflections(1), entries(8), search(2), wordlist(2), stats(3), languages(1), filters(2), lexicalcategories(1), registers(2), domains(2), regions(1), grammaticalFeatures(1)

@group inflections
@endpoint GET /inflections/{source_lang}/{word_id}/{filters}
@required {source_lang: any, filters: any, word_id: any}
@returns(200)
@errors {500}

@endgroup

@group entries
@endpoint GET /entries/{source_lang}/{word_id}
@required {source_lang: any, word_id: any}
@returns(200)
@errors {404, 500}

@endpoint GET /entries/{source_lang}/{word_id}/regions={region}
@required {source_lang: any, word_id: any, region: any}
@returns(200)
@errors {404, 500}

@endpoint GET /entries/{source_lang}/{word_id}/{filters}
@required {source_lang: any, word_id: any, filters: any}
@returns(200)
@errors {404, 500}

@endpoint GET /entries/{source_lang}/{word_id}/synonyms
@required {source_lang: any, word_id: any}
@returns(200)
@errors {404, 500}

@endpoint GET /entries/{source_lang}/{word_id}/antonyms
@required {source_lang: any, word_id: any}
@returns(200)
@errors {404, 500}

@endpoint GET /entries/{source_lang}/{word_id}/synonyms;antonyms
@required {source_lang: any, word_id: any}
@returns(200)
@errors {404, 500}

@endgroup

@group search
@endpoint GET /search/{source_lang}
@required {source_lang: any}
@optional {q: any, prefix: any, regions: any, limit: any, offset: any}
@returns(200)
@errors {404, 500}

@endpoint GET /search/{source_search_language}/translations={target_search_language}
@required {source_search_language: any, target_search_language: any}
@optional {q: any, prefix: any, regions: any, limit: any, offset: any}
@returns(200)
@errors {404, 500}

@endgroup

@group entries
@endpoint GET /entries/{source_translation_language}/{word_id}/translations={target_translation_language}
@required {source_translation_language: any, word_id: any, target_translation_language: any}
@returns(200)
@errors {400, 404, 500}

@endgroup

@group wordlist
@endpoint GET /wordlist/{source_lang}/{filters_basic}
@required {source_lang: any, filters_basic: any}
@optional {limit: any, offset: any}
@returns(200)
@errors {400, 404, 500}

@endpoint GET /wordlist/{source_lang}/{filters_advanced}
@required {source_lang: any, filters_advanced: any}
@optional {exclude: any, exclude_senses: any, exclude_prime_senses: any, word_length: any, prefix: any, exact: any, limit: any, offset: any}
@returns(200)
@errors {400, 404, 500}

@endgroup

@group entries
@endpoint GET /entries/{source_language}/{word_id}/sentences
@required {source_language: any, word_id: any}
@returns(200)
@errors {404, 500}

@endgroup

@group stats
@endpoint GET /stats/frequency/word/{source_lang}/
@required {source_lang: any}
@optional {corpus: any, wordform: any, trueCase: any, lemma: any, lexicalCategory: any}
@returns(200)
@errors {400, 404, 500}

@endpoint GET /stats/frequency/words/{source_lang}/
@required {source_lang: any}
@optional {corpus: any, wordform: any, trueCase: any, lemma: any, lexicalCategory: any, grammaticalFeatures: any, sort: any, collate: any, minFrequency: any, maxFrequency: any, minNormalizedFrequency: any, maxNormalizedFrequency: any, offset: any, limit: any}
@returns(200)
@errors {400, 404, 500}

@endpoint GET /stats/frequency/ngrams/{source_lang}/{corpus}/{ngram-size}/
@required {source_lang: any, corpus: any, ngram-size: any}
@optional {tokens: any, contains: any, punctuation: any, format: any, minFrequency: any, maxFrequency: any, minDocumentFrequency: any, maxDocumentFrequency: any, collate: any, sort: any, offset: any, limit: any}
@returns(200)
@errors {400, 404, 500}

@endgroup

@group languages
@endpoint GET /languages
@optional {sourceLanguage: any, targetLanguage: any}
@returns(200)
@errors {404, 500}

@endgroup

@group filters
@endpoint GET /filters
@returns(200)
@errors {500}

@endpoint GET /filters/{endpoint}
@required {endpoint: any}
@returns(200)
@errors {404, 500}

@endgroup

@group lexicalcategories
@endpoint GET /lexicalcategories/{language}
@required {language: any}
@returns(200)
@errors {404, 500}

@endgroup

@group registers
@endpoint GET /registers/{source_language}
@required {source_language: any}
@returns(200)
@errors {404, 500}

@endpoint GET /registers/{source_register_language}/{target_register_language}
@required {source_register_language: any, target_register_language: any}
@returns(200)
@errors {400, 404, 500}

@endgroup

@group domains
@endpoint GET /domains/{source_language}
@required {source_language: any}
@returns(200)
@errors {404}

@endpoint GET /domains/{source_domains_language}/{target_domains_language}
@required {source_domains_language: any, target_domains_language: any}
@returns(200)
@errors {400, 404}

@endgroup

@group regions
@endpoint GET /regions/{source_language}
@required {source_language: any}
@returns(200)
@errors {404}

@endgroup

@group grammaticalFeatures
@endpoint GET /grammaticalFeatures/{source_language}
@required {source_language: any}
@returns(200)
@errors {404}

@endgroup

@end