openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 72.6 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://od-api-demo.oxforddictionaries.com:443/api/v1"}],"x-hasEquivalentPaths":true,"info":{"license":{"name":"API Terms And Conditions","url":"https://developer.oxforddictionaries.com/api-terms-and-conditions"},"termsOfService":"http://helloreverb.com/terms/","title":"Oxford Dictionaries","version":"1.11.0","x-apisguru-categories":["text"],"x-logo":{"url":"https://twitter.com/OxfordWordsAPI/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.oxforddictionaries.com/swagger/spec/public_doc_guest.json","version":"3.0"}],"x-providerName":"oxforddictionaries.com"},"paths":{"/domains/{source_domains_language}/{target_domains_language}":{"get":{"description":"Returns a list of the available [domains](documentation/glossary?term=domain) for a given bilingual language dataset.\n","parameters":[{"description":"IANA language code","in":"path","name":"source_domains_language","required":true,"schema":{"enum":["en","es","nso","zu","ur","de","pt"],"type":"string"}},{"description":"IANA language code","in":"path","name":"target_domains_language","required":true,"schema":{"enum":["es","nso","zu","ms","id","tn","ro","de","pt"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilityLabels"}}},"description":"Successful response."},"400":{"description":"source_language and target_language are same."},"404":{"description":"Unknown source_language and/or target_language."}},"summary":"Lists available domains in a bilingual dataset","tags":["Utility"]}},"/domains/{source_language}":{"get":{"description":"Returns a list of the available [domains](documentation/glossary?term=domain) for a given monolingual language dataset.\n","parameters":[{"description":"IANA language code","in":"path","name":"source_language","required":true,"schema":{"enum":["en","es","nso","zu","hi","sw","ur","de","pt","ta","gu"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilityLabels"}}},"description":"Successful response."},"404":{"description":"Unknown source_language."}},"summary":"Lists available domains in a monolingual dataset","tags":["Utility"]}},"/entries/{source_language}/{word_id}/sentences":{"get":{"description":"\nUse this to retrieve sentences extracted from corpora which show how a word is used in the language. This is available for English and Spanish. For English, the sentences are linked to the correct [sense](documentation/glossary?term=sense) of the word in the dictionary. In Spanish, they are linked at the [headword](documentation/glossary?term=headword) level.\n <div id=\"sentences\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_language","required":true,"schema":{"enum":["en","es"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentencesResults"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_language\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve corpus sentences for a given word","tags":["The Sentence Dictionary"]}},"/entries/{source_lang}/{word_id}":{"get":{"description":"\nUse this to retrieve definitions, [pronunciations](documentation/glossary?term=pronunciation), example sentences, [grammatical information](documentation/glossary?term=grammaticalfeatures) and [word origins](documentation/glossary?term=etymology). It only works for dictionary [headwords](documentation/glossary?term=headword), so you may need to use the [Lemmatron](documentation/glossary?term=lemma) first if your input is likely to be an [inflected](documentation/glossary?term=inflection) form (e.g., 'swimming'). This would return the linked [headword](documentation/glossary?term=headword) (e.g., 'swim') which you can then use in the Entries endpoint. Unless specified using a region filter, the default lookup will be the Oxford Dictionary of English (GB). \n <div id=\"dictionary_entries\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","lv","hi","sw","ta","gu","fr"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEntry"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_lang or filters are not recognized\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve dictionary information for a given word","tags":["Dictionary entries"]}},"/entries/{source_lang}/{word_id}/antonyms":{"get":{"description":"\nRetrieve words that are opposite in meaning to the input word ([antonym](documentation/glossary?term=thesaurus)).\n\n <div id=\"antonyms\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Thesaurus"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_lang or filters are not recognized\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve words that mean the opposite","tags":["Thesaurus"]}},"/entries/{source_lang}/{word_id}/regions={region}":{"get":{"description":"\nUSe this filter to restrict the lookup to either our Oxford Dictionary of English (GB) or New Oxford American Dictionary (US).\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"description":"Region filter parameter. gb = Oxford Dictionary of English. us = New Oxford American Dictionary.","in":"path","name":"region","required":true,"schema":{"enum":["gb","us"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEntry"}}},"description":"Successful response."},"404":{"description":"no entry is found matching supplied source_lang and id\nand/or that entry has no senses with translations in the target language. \n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Specify GB or US dictionary for English entry search","tags":["Dictionary entries"]}},"/entries/{source_lang}/{word_id}/synonyms":{"get":{"description":"\nUse this to retrieve words that are similar in meaning to the input word ([synonym](documentation/glossary?term=synonym)).\n\n <div id=\"synonyms\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Thesaurus"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_lang or filters are not recognized\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve words that are similar","tags":["Thesaurus"]}},"/entries/{source_lang}/{word_id}/synonyms;antonyms":{"get":{"description":"\nRetrieve available [synonyms](documentation/glossary?term=thesaurus) and [antonyms](documentation/glossary?term=thesaurus) for a given word and language. \n\n <div id=\"synonyms_and_antonyms\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Thesaurus"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_lang or filters are not recognized\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve synonyms and antonyms for a given word","tags":["Thesaurus"]}},"/entries/{source_lang}/{word_id}/{filters}":{"get":{"description":"\nUse filters to limit the [entry](documentation/glossary?term=entry) information that is returned. For example, you may only require definitions and not everything else, or just [pronunciations](documentation/glossary?term=pronunciation). The full list of filters can be retrieved from the filters Utility endpoint. You can also specify values within the filter using '='. For example 'grammaticalFeatures=singular'. Filters can also be combined using a semicolon.\n\n <div id=\"dictionary_entries_filters\"></div>\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","lv","hi","sw","ta","gu","fr"],"type":"string"}},{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},{"description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive. To list multiple values in single condition divide them with comma.","in":"path","name":"filters","required":true,"schema":{"default":"grammaticalFeatures=singular,past;lexicalCategory=noun","items":{"pattern":"(lexicalCategory|grammaticalFeatures)=.+","type":"string"},"type":"string"},"style":"simple"},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEntry"}}},"description":"Successful response."},"404":{"description":"no entry is found matching supplied source_lang and id\nand/or that entry has no senses with translations in the target language. \n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Apply filters to response","tags":["Dictionary entries"]}},"/entries/{source_translation_language}/{word_id}/translations={target_translation_language}":{"get":{"description":"\nUse this to return translations for a given word. In the event that a word in the dataset does not have a direct translation, the response will be a [definition](documentation/glossary?term=entry) in the target language.\n\n <div id=\"translation\"></div>\n","parameters":[{"description":"IANA language code","in":"path","name":"source_translation_language","required":true,"schema":{"enum":["en","es","nso","zu","ms","id","tn","ur","de","pt"],"type":"string"}},{"description":"The source word","in":"path","name":"word_id","required":true,"schema":{"default":"change","type":"string"}},{"description":"IANA language code","in":"path","name":"target_translation_language","required":true,"schema":{"enum":["es","nso","zu","ms","id","tn","ro","de","pt"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEntry"}}},"description":"Successful response. In case word doesn't have a direct translation a response would be definitions."},"400":{"description":"any of target languages is unknown"},"404":{"description":"no entry is found matching supplied source_lang and id\nand/or that entry has no senses with translations in the target language(s). \n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve translation for a given word","tags":["Translation"]}},"/filters":{"get":{"description":"Returns a list of all the valid filters to construct API calls.\n","parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filters"}}},"description":"Successful response."},"500":{"description":"Internal Error. An error occurred while processing the data."}},"summary":"Lists available filters","tags":["Utility"]}},"/filters/{endpoint}":{"get":{"description":"Returns a list of all the valid filters for a given endpoint to construct API calls.\n","parameters":[{"description":"Name of the endpoint.","in":"path","name":"endpoint","required":true,"schema":{"enum":["entries","inflections","translations"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filters"}}},"description":"Successful response."},"404":{"description":"Unknown endpoint."},"500":{"description":"Internal Error. An error occurred while processing the data."}},"summary":"Lists available filters for specific endpoint","tags":["Utility"]}},"/grammaticalFeatures/{source_language}":{"get":{"description":"Returns a list of the available [grammatical features](documentation/glossary?term=grammaticalfeatures) for a given language dataset.\n","parameters":[{"description":"IANA language code. If provided output will be filtered by sourceLanguage.","in":"path","name":"source_language","required":true,"schema":{"enum":["en","es","lv","nso","zu","ms","tn","ur","hi","sw","de","pt","ta","gu"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilityLabels"}}},"description":"Successful response."},"404":{"description":"Unknown source_language."}},"summary":"Lists available grammatical features in a dataset","tags":["Utility"]}},"/inflections/{source_lang}/{word_id}/{filters}":{"get":{"description":"\nUse this to check if a word exists in the dictionary, or what 'root' form it links to (e.g., swimming > swim). The response tells you the possible [lemmas](documentation/glossary?term=lemma) for a given [inflected](documentation/glossary?term=inflection) word. This can then be combined with other endpoints to retrieve more information.\n\n <div id=\"lemmatron\"></div>\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","hi","nso","tn","zu","de","pt"],"type":"string"}},{"description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive. To list multiple values in single condition divide them with comma.","in":"path","name":"filters","required":true,"schema":{"default":"grammaticalFeatures=singular,past;lexicalCategory=noun","items":{"pattern":"(lexicalCategory|grammaticalFeatures)=.+","type":"string"},"type":"string"},"style":"simple"},{"description":"The input word","in":"path","name":"word_id","required":true,"schema":{"default":"swimming","type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lemmatron"}}},"description":"Successful response."},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Check a word exists in the dictionary and retrieve its root form","tags":["Lemmatron"]}},"/languages":{"get":{"description":"Returns a list of monolingual and bilingual language datasets available in the API\n","parameters":[{"description":"IANA language code. If provided output will be filtered by sourceLanguage.","in":"query","name":"sourceLanguage","required":false,"schema":{"enum":["es","en","lv","nso","zu","ms","id","tn","ur","hi","sw","ro","de","pt","ta","gu"],"type":"string"}},{"description":"IANA language code. If provided output will be filtered by sourceLanguage.","in":"query","name":"targetLanguage","required":false,"schema":{"enum":["es","en","lv","nso","zu","ms","id","tn","ur","hi","sw","ro"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Languages"}}},"description":"Successful response."},"404":{"description":"Unknown sourceLanguage and/or targetLanguage."},"500":{"description":"Internal Error. An error occurred while processing the data."}},"summary":"Lists available dictionaries","tags":["Utility"]}},"/lexicalcategories/{language}":{"get":{"description":"Returns a list of available [lexical categories](documentation/glossary?term=lexicalcategory) for a given language dataset.\n","parameters":[{"description":"IANA language code","in":"path","name":"language","required":true,"schema":{"enum":["es","en","lv","nso","zu","ms","id","tn","ur","hi","sw","ro","de","pt","ta","gu"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilityLabels"}}},"description":"Successful response."},"404":{"description":"Unknown language."},"500":{"description":"Internal Error. An error occurred while processing the data."}},"summary":"Lists available lexical categories in a dataset","tags":["Utility"]}},"/regions/{source_language}":{"get":{"description":"Returns a list of the available [regions](documentation/glossary?term=regions) for a given monolingual language dataset.\n","parameters":[{"description":"IANA language code","in":"path","name":"source_language","required":true,"schema":{"enum":["en"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Regions"}}},"description":"Successful response."},"404":{"description":"Unknown source_language."}},"summary":"Lists available regions in a monolingual dataset","tags":["Utility"]}},"/registers/{source_language}":{"get":{"description":"Returns a list of the available [registers](documentation/glossary?term=registers) for a given monolingual language dataset.\n","parameters":[{"description":"IANA language code","in":"path","name":"source_language","required":true,"schema":{"enum":["en","es","hi","id","lv","ms","sw","ur","de","pt","ta","gu"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilityLabels"}}},"description":"Successful response."},"404":{"description":"Unknown source_language."},"500":{"description":"Internal Error. An error occurred while processing the data."}},"summary":"Lists available registers in a monolingual dataset","tags":["Utility"]}},"/registers/{source_register_language}/{target_register_language}":{"get":{"description":"Returns a list of the available [registers](documentation/glossary?term=registers) for a given bilingual language dataset.\n","parameters":[{"description":"IANA language code","in":"path","name":"source_register_language","required":true,"schema":{"enum":["en","es","ms","id","ur","de","pt"],"type":"string"}},{"description":"IANA language code","in":"path","name":"target_register_language","required":true,"schema":{"enum":["es","en","nso","zu","ms","id","tn","ro","de","pt"],"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilityLabels"}}},"description":"Successful response."},"400":{"description":"source_language and target_language are same."},"404":{"description":"Unknown source_language and/or target_language."},"500":{"description":"Internal Error. An error occurred while processing the data."}},"summary":"Lists available registers in a bilingual dataset","tags":["Utility"]}},"/search/{source_lang}":{"get":{"description":"\nUse this to retrieve possible [headword](documentation/glossary?term=headword) matches for a given string of text. The results are culculated using headword matching, fuzzy matching, and [lemmatization](documentation/glossary?term=lemma) \n\n <div id=\"search\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","hi","lv","sw","ta","gu"],"type":"string"}},{"description":"Search string","in":"query","name":"q","required":false,"schema":{"default":"eye","type":"string"}},{"description":"Set prefix to true if you'd like to get results only starting with search string.","in":"query","name":"prefix","required":false,"schema":{"default":"false","enum":["false","true"],"type":"boolean"}},{"description":"If searching in English, filter words with specific region(s) either 'us' or 'gb'.","in":"query","name":"regions","required":false,"schema":{"type":"string"}},{"description":"Limit the number of results per response. Default and maximum limit is 5000.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset the start number of the result.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wordlist"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_lang or filters are not recognized\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve possible matches to input","tags":["Search"]}},"/search/{source_search_language}/translations={target_search_language}":{"get":{"description":"\nUse this to find matches in our translation dictionaries.\n\n <div id=\"search_translation\"></div>\n","externalDocs":{"description":"find more info here","url":"https://helloreverb.com/about"},"parameters":[{"description":"IANA language code","in":"path","name":"source_search_language","required":true,"schema":{"enum":["en","es","nso","zu","ms","id","tn","ur","de","pt"],"type":"string"}},{"description":"IANA language code","in":"path","name":"target_search_language","required":true,"schema":{"enum":["es","nso","zu","ms","id","tn","ro","de","pt"],"type":"string"}},{"description":"Search string.","in":"query","name":"q","required":false,"schema":{"default":"eye","type":"string"}},{"description":"Set prefix to true if you'd like to get results only starting with search string.","in":"query","name":"prefix","required":false,"schema":{"default":"false","enum":["false","true"],"type":"boolean"}},{"description":"Filter words with specific region(s) E.g., regions=us. For now gb, us are available for en language.","in":"query","name":"regions","required":false,"schema":{"type":"string"}},{"description":"Limit the number of results per response. Default and maximum limit is 5000.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset the start number of the result.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wordlist"}}},"description":"Successful response."},"404":{"description":"No entry is found matching supplied id and source_lang or filters are not recognized\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve possible translation matches to input","tags":["Search"]}},"/stats/frequency/ngrams/{source_lang}/{corpus}/{ngram-size}/":{"get":{"description":"This endpoint returns frequencies of ngrams of size 1-4. That is the number of times a word (ngram size = 1) or words (ngram size > 1) appear in the corpus. Ngrams are case sensitive (\"I AM\" and \"I am\" will have different frequency) and frequencies are calculated per word (true case) so \"the book\" and \"the books\" are two different ngrams. The results can be filtered based on query parameters. <br> <br> Parameters can be provided in PATH, GET or POST (form or json). The parameters in PATH are overridden by parameters in GET, POST and json (in that order). In PATH, individual options are separated by semicolon and values are separated by commas (where multiple values can be used). <br> <br> Example for bigrams (ngram of size 2):\n* PATH: /tokens=a word,another word\n* GET: /?tokens=a word&tokens=another word\n* POST (json):\n\n ```javascript\n {\n \"tokens\": [\"a word\", \"another word\"]\n }\n ```\n\nEither \"tokens\" or \"contains\" has to be provided. <br> <br> Some queries with \"contains\" or \"sort\" can exceed the 30s timeout, in which case the API will return an error message with status code 503. You mitigate this by providing additional restrictions such as \"minFrequency\" and \"maxFrequency\". <br> <br> You can use the parameters \"offset\" and \"limit\" to paginate through large result sets. For convenience, the HTTP header \"Link\" is set on the response to provide links to \"first\", \"self\", \"next\", \"prev\" and \"last\" pages of results (depending on the context). For example, if the result set contains 50 results and the parameter \"limit\" is set to 25, the Links header will contain an URL for the first 25 results and the next 25 results. <br> <br> Some libraries such as python's `requests` can parse the header automatically and offer a convenient way of iterating through the results. For example:\n```python def get_all_results(url):\n while url:\n r = requests.get(url)\n r.raise_for_status()\n for item in r.json()['results']:\n yield item\n url = r.links.get('next', {}).get('url')\n```\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"default":"en","type":"string"}},{"description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com","in":"path","name":"corpus","required":true,"schema":{"default":"nmc","type":"string"}},{"description":"the size of ngrams requested (1-4)","in":"path","name":"ngram-size","required":true,"schema":{"default":2,"type":"string"}},{"description":"List of tokens to filter. The tokens are separated by spaces, the list items are separated by comma (e.g., for bigrams (n=2) tokens=this is,this was, this will)","in":"query","name":"tokens","required":false,"schema":{"default":"a word","type":"string"}},{"description":"Find ngrams containing the given token(s). Use comma or space as token separators; the order of tokens is irrelevant.","in":"query","name":"contains","required":false,"schema":{"type":"string"}},{"description":"Flag specifying whether to lookup ngrams that include punctuation or not (possible values are \"true\" and \"false\"; default is \"false\")","in":"query","name":"punctuation","required":false,"schema":{"type":"string"}},{"description":"Option specifying whether tokens should be returned as a single string (option \"google\") or as a list of strings (option \"oup\")","in":"query","name":"format","required":false,"schema":{"default":"oup","type":"string"}},{"description":"Restrict the query to entries with frequency of at least `minFrequency`","in":"query","name":"minFrequency","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Restrict the query to entries with frequency of at most `maxFrequency`","in":"query","name":"maxFrequency","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Restrict the query to entries that appear in at least `minDocumentFrequency` documents","in":"query","name":"minDocumentFrequency","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Restrict the query to entries that appera in at most `maxDocumentFrequency` documents","in":"query","name":"maxDocumentFrequency","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"collate the results by wordform, trueCase, lemma, lexicalCategory. Multiple values can be separated by commas (e.g., collate=trueCase,lemma,lexicalCategory).","in":"query","name":"collate","required":false,"schema":{"type":"string"}},{"description":"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency. Descending order is achieved by prepending the value with the minus sign ('-'). Multiple values can be separated by commas (e.g., sort=lexicalCategory,-frequency)","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"pagination - results offset","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int64","type":"integer"}},{"description":"pagination - results limit","in":"query","name":"limit","required":false,"schema":{"default":100,"format":"int64","type":"integer"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NgramsResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/NgramsResult"}}},"description":"Successful response."},"400":{"description":"Invalid option name...\n"},"404":{"description":"language is not in...\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve the frequency of ngrams (1-4) derived from a corpus","tags":["LexiStats"]}},"/stats/frequency/word/{source_lang}/":{"get":{"description":"This endpoint provides the frequency of a given word. When multiple database records match the query parameters, the returned frequency is the sum of the individual frequencies. For example, if the query parameters are lemma=test, the returned frequency will include the verb \"test\", the noun \"test\" and the adjective \"test\" in all forms (Test, tested, testing, etc.) <br> <br> If you are interested in the frequency of the word \"test\" but want to exclude other forms (e.g., tested) use the option trueCase=test. Normally, the word \"test\" will be spelt with a capital letter at the beginning of a sentence. The option trueCase will ignore this and it will count \"Test\" and \"test\" as the same token. If you are interested in frequencies of \"Test\" and \"test\", use the option wordform=test or wordform=Test. Note that trueCase is not just a lower case of the word as some words are genuinely spelt with a capital letter such as the word \"press\" in Oxford University Press. <br> <br> Parameters can be provided in PATH, GET or POST (form or json). The parameters in PATH are overriden by parameters in GET, POST and json (in that order). In PATH, individual options are separated by semicolon and values are separated by commas (where multiple values can be used). Examples:\n* PATH: /lemma=test;lexicalCategory=noun\n* GET: /?lemma=test&lexicalCategory=noun\n* POST (json):\n\n ```javascript\n {\n \"lemma\": \"test\",\n \"lexicalCategory\": \"noun\"\n }\n ```\n\n<br> One of the options wordform/trueCase/lemma/lexicalCategory has to be provided.\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"default":"en","type":"string"}},{"description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com","in":"query","name":"corpus","required":false,"schema":{"default":"nmc","type":"string"}},{"description":"The written form of the word to look up (preserving case e.g., Books vs books)","in":"query","name":"wordform","required":false,"schema":{"type":"string"}},{"description":"The written form of the word to look up with normalised case (Books --> books)","in":"query","name":"trueCase","required":false,"schema":{"type":"string"}},{"description":"The lemma of the word to look up (e.g., Book, booked, books all have the lemma \"book\")","in":"query","name":"lemma","required":false,"schema":{"default":"test","type":"string"}},{"description":"The lexical category of the word(s) to look up (e.g., noun or verb)","in":"query","name":"lexicalCategory","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsWordResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/StatsWordResult"}}},"description":"Successful response."},"400":{"description":"You need to specify at least one option. Try one of 'wordform, lemma, trueCase, lexicalCategory'.\n"},"404":{"description":"language is not in...\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve the frequency of a word derived from a corpus.","tags":["LexiStats"]}},"/stats/frequency/words/{source_lang}/":{"get":{"description":"This endpoint provides a list of frequencies for a given word or words. Unlike the /word/ endpoint, the results are split into the smallest units. <br> <br> To exclude a specific value, prepend it with the minus sign ('-'). For example, to get frequencies of the lemma 'happy' but exclude superlative forms (i.e., happiest) you could use options 'lemma=happy;grammaticalFeatures=-degreeType:superlative'. <br> <br> Parameters can be provided in PATH, GET or POST (form or json). The parameters in PATH are overridden by parameters in GET, POST and json (in that order). In PATH, individual options are separated by semicolon and values are separated by commas (where multiple values can be used). <br> <br> The parameters wordform/trueCase/lemma/lexicalCategory also exist in a plural form, taking a lists of items. Examples:\n* PATH: /wordforms=happy,happier,happiest\n* GET: /?wordforms=happy&wordforms=happier&wordforms=happiest\n* POST (json):\n```javascript\n {\n \"wordforms\": [\"happy\", \"happier\", \"happiest\"]\n }\n```\nA mor complex example of retrieving frequencies of multiple lemmas:\n```\n {\n \"lemmas\": [\"happy\", \"content\", \"cheerful\", \"cheery\", \"merry\", \"joyful\", \"ecstatic\"],\n \"grammaticalFeatures\": {\n \"adjectiveFunctionType\": \"predicative\"\n },\n \"lexicalCategory\": \"adjective\",\n \"sort\": [\"lemma\", \"-frequency\"]\n }\n```\nSome queries with \"collate\" or \"sort\" can exceed the 30s timeout, in which case the API will return an error message with status code 503. You mitigate this by providing additional restrictions such as \"minFrequency\" and \"maxFrequency\". <br> <br> You can use the parameters \"offset\" and \"limit\" to paginate through large result sets. For convenience, the HTTP header \"Link\" is set on the response to provide links to \"first\", \"self\", \"next\", \"prev\" and \"last\" pages of results (depending on the context). For example, if the result set contains 50 results and the parameter \"limit\" is set to 25, the Links header will contain an URL for the first 25 results and the next 25 results. <br> <br> Some libraries such as python's `requests` can parse the header automatically and offer a convenient way of iterating through the results. For example:\n```python def get_all_results(url):\n while url:\n r = requests.get(url)\n r.raise_for_status()\n for item in r.json()['results']:\n yield item\n url = r.links.get('next', {}).get('url')\n```\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"default":"en","type":"string"}},{"description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com","in":"query","name":"corpus","required":false,"schema":{"default":"nmc","type":"string"}},{"description":"The written form of the word to look up (preserving case e.g., Book vs book)","in":"query","name":"wordform","required":false,"schema":{"type":"string"}},{"description":"The written form of the word to look up with normalised case (Books --> books)","in":"query","name":"trueCase","required":false,"schema":{"type":"string"}},{"description":"The lemma of the word to look up (e.g., Book, booked, books all have the lemma \"book\")","in":"query","name":"lemma","required":false,"schema":{"default":"test","type":"string"}},{"description":"The lexical category of the word(s) to look up (e.g., adjective or noun)","in":"query","name":"lexicalCategory","required":false,"schema":{"type":"string"}},{"description":"The grammatical features of the word(s) to look up entered as a list of k:v (e.g., degree_type:comparative)","in":"query","name":"grammaticalFeatures","required":false,"schema":{"type":"string"}},{"description":"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency. Descending order is achieved by prepending the value with the minus sign ('-'). Multiple values can be separated by commas (e.g., sort=lexicalCategory,-frequency)","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"collate the results by wordform, trueCase, lemma, lexicalCategory. Multiple values can be separated by commas (e.g., collate=trueCase,lemma,lexicalCategory).","in":"query","name":"collate","required":false,"schema":{"type":"string"}},{"description":"Restrict the query to entries with frequency of at least `minFrequency`","in":"query","name":"minFrequency","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Restrict the query to entries with frequency of at most `maxFrequency`","in":"query","name":"maxFrequency","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Restrict the query to entries with frequency of at least `minNormalizedFrequency`","in":"query","name":"minNormalizedFrequency","required":false,"schema":{"format":"float","type":"number"}},{"description":"Restrict the query to entries with frequency of at most `maxNormalizedFrequency`","in":"query","name":"maxNormalizedFrequency","required":false,"schema":{"format":"float","type":"number"}},{"description":"pagination - results offset","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int64","type":"integer"}},{"description":"pagination - results limit","in":"query","name":"limit","required":false,"schema":{"default":100,"format":"int64","type":"integer"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsWordResultList"}},"text/csv":{"schema":{"$ref":"#/components/schemas/StatsWordResultList"}}},"description":"Successful response."},"400":{"description":"Invalid option name...; Option ... must have a value.; The option 'minFrequency' has to have an non-negative integer parameter.; The option 'maxFrequency' has to have an non-negative integer parameter.; The option 'limit' has to have an non-negative integer parameter.; The option 'offset' has to have an non-negative integer parameter."},"404":{"description":"language is not in...\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve a list of frequencies of a word/words derived from a corpus.","tags":["LexiStats"]}},"/wordlist/{source_lang}/{filters_advanced}":{"get":{"description":"Use this to apply more complex filters to the [list of words](documentation/glossary?term=wordlist). For example, you may only want to filter out words for which all [senses](documentation/glossary?term=sense) match the filter, or only its 'prime sense'. You can also filter by word length or match by substring (prefix). \n\n <div id=\"wordlist_advanced\"></div>\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","hi","lv","sw","ta","gu"],"type":"string"}},{"description":"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers. Parameters can take comma separated list of values. E.g., lexicalCategory=noun,adjective;domains=sport. Number of values limited to 5.","in":"path","name":"filters_advanced","required":true,"schema":{"default":"lexicalCategory=Noun;domains=sport","type":"string"}},{"description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes headwords that have any senses in specified exclusion attributes (lexical categories, domains, etc.) from results.","in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes only those senses of a particular headword that match specified exclusion attributes (lexical categories, domains, etc.) from results but includes the headword if it has other permitted senses.","in":"query","name":"exclude_senses","required":false,"schema":{"type":"string"}},{"description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes a headword only if the primary sense matches the specified exclusion attributes (registers, domains only).","in":"query","name":"exclude_prime_senses","required":false,"schema":{"type":"string"}},{"description":"Parameter to speficy the minimum (>), exact or maximum (<) length of the words required. E.g., >5 - more than 5 chars; <4 - less than 4 chars; >5<10 - from 5 to 10 chars; 3 - exactly 3 chars.","in":"query","name":"word_length","required":false,"schema":{"default":">5,<10","type":"string"}},{"description":"Filter words that start with prefix parameter","in":"query","name":"prefix","required":false,"schema":{"default":"goal","type":"string"}},{"description":"If exact=true wordlist returns a list of entries that exactly matches the search string. Otherwise wordlist lists entries that start with prefix string.","in":"query","name":"exact","required":false,"schema":{"default":"false","enum":["false","true"],"type":"boolean"}},{"description":"Limit the number of results per response. Default and maximum limit is 5000.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset the start number of the result.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wordlist"}}},"description":"Successful response."},"400":{"description":"disjoint sets of word_length values (eg <3>10); filter has no values; total number of filters > 20; filters and excludes values can not be the same; source_lang and translations can not be same; word_length conflicts with prefix length."},"404":{"description":"No entries is found matching supplied filters or lang or filters is not recognized.\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve list of words for category with advanced options","tags":["Wordlist"]}},"/wordlist/{source_lang}/{filters_basic}":{"get":{"description":"\nUse this to retrieve a [list of words](documentation/glossary?term=wordlist) for particular [domain](documentation/glossary?term=domain), [lexical category](documentation/glossary?term=lexicalcategory), [register](documentation/glossary?term=registers) and/or [region](documentation/glossary?term=regions). View the full list of possible filters using the filters Utility endpoint. The response only includes [headwords](documentation/glossary?term=headword), not all their possible [inflections](documentation/glossary?term=inflection). If you require a full [wordlist](documentation/glossary?term=wordlist) including [inflected forms](documentation/glossary?term=inflection), contact us and we can help.\n\n <div id=\"wordlist\"></div>\n","parameters":[{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","hi","lv","sw","ta","gu"],"type":"string"}},{"description":"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers. Parameters can take comma separated list of values. E.g., lexicalCategory=noun,adjective;domains=sport. Number of values limited to 5.","in":"path","name":"filters_basic","required":true,"schema":{"default":"registers=Rare;domains=Art","type":"string"}},{"description":"Limit the number of results per response. Default and maximum limit is 5000.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset the start number of the result","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wordlist"}}},"description":"Successful response."},"400":{"description":"filter has no values; total number of filters > 20."},"404":{"description":"No entries is found matching supplied filters or lang or filters is not recognized.\n"},"500":{"description":"Internal Error. An error occurred while processing the data.\n"}},"summary":"Retrieve a list of words in a category","tags":["Wordlist"]}}},"components":{"parameters":{"appId":{"description":"App ID Authentication Parameter","in":"header","name":"app_id","required":true,"schema":{"default":"5037d509","type":"string"},"x-data-threescale-name":"app_ids"},"appKey":{"description":"App Key Authentication Parameter","in":"header","name":"app_key","required":true,"schema":{"default":"4dc1aebaa63721f0f8e79a55e2514bc7","type":"string"},"x-data-threescale-name":"app_keys"},"entriesWordId":{"description":"An Entry identifier. Case-sensitive.","in":"path","name":"word_id","required":true,"schema":{"default":"ace","type":"string"}},"keyValFilters":{"description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive. To list multiple values in single condition divide them with comma.","in":"path","name":"filters","required":true,"schema":{"default":"grammaticalFeatures=singular,past;lexicalCategory=noun","items":{"pattern":"(lexicalCategory|grammaticalFeatures)=.+","type":"string"},"type":"string"},"style":"simple"},"monolingual-lemmatron-source_lang":{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","hi","nso","tn","zu","de","pt"],"type":"string"}},"monolingual-source_lang":{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","lv","hi","sw","ta","gu","fr"],"type":"string"}},"monolingual-wordlist-source_lang":{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en","es","hi","lv","sw","ta","gu"],"type":"string"}},"thesaurus-source_lang":{"description":"IANA language code","in":"path","name":"source_lang","required":true,"schema":{"enum":["en"],"type":"string"}}},"schemas":{"ArrayOfRelatedEntries":{"description":"A list of written or spoken words","items":{"additionalProperties":false,"properties":{"domains":{"$ref":"#/components/schemas/arrayofstrings"},"id":{"description":"The identifier of the word","type":"string"},"language":{"description":"IANA language code specifying the language of the word","type":"string"},"regions":{"$ref":"#/components/schemas/arrayofstrings"},"registers":{"$ref":"#/components/schemas/arrayofstrings"},"text":{"type":"string"}},"required":["text","id"],"type":"object"},"minItems":1,"type":"array"},"CategorizedTextList":{"