Documentation

Introduction

This document provides information about all available API methods. To use translation methods you have to get auth token for your application.

Try it with Postman:

Authenticate

Controller for API client apps authentication.

API	Description
POST api/v1/authenticate	Obsolete. Please use the new method /api/v1.1/authenticate. Responds to POST request containing "Authorization: Basic {ApiKey}" header. Your can get API key for your app (ApiKey) on your app page.
POST api/v1.1/authenticate	Responds to POST request containing "Authorization: Basic {ApiKey}" header. Your can get API key for your app (ApiKey) on your app page.

Api

Exposes translation methods.

API	Description
GET api/v1/Translation?text={text}&srcLang={srcLang}&dstLang={dstLang}&isCaseSensitive={isCaseSensitive}	Translation for the word or phrase. Searches only in specified direction. Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/WordList?prefix={prefix}&srcLang={srcLang}&dstLang={dstLang}&pageSize={pageSize}&startPos={startPos}	Part of the word list for available dictionaries. Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/Minicard?text={text}&srcLang={srcLang}&dstLang={dstLang}	Minicard (short translation for word or phrase). Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/Search?text={text}&srcLang={srcLang}&dstLang={dstLang}&searchZone={searchZone}&startIndex={startIndex}&pageSize={pageSize}	Fulltext search among articles from available dictionaries. Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/Article?heading={heading}&dict={dict}&srcLang={srcLang}&dstLang={dstLang}	Exact article from specified Lingvo dictionary. Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/Suggests?text={text}&srcLang={srcLang}&dstLang={dstLang}	Suggests / spelling for given word or phrase. Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/WordForms?text={text}&lang={lang}	Word forms (paradigms). Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.
GET api/v1/Sound?dictionaryName={dictionaryName}&fileName={fileName}	Returns sound file. All input parameters can be found in Lingvo articles (e. g. /Translation, /Minicard, etc.). Requires Authorization HTTP-header with auth token: "Authorization: Bearer {token}". See /api/v1/authenticate method description for details.