README.md

Reverso API

Translate, get context examples or synonyms of words - this and much more you can do with your text queries via this API wrapper.

Navigation

• Installing
• Usage
• Examples
  • getContext
  • getSpellCheck
  • getSynonyms
  • getTranslation
  • getConjugation
• Credits

Installing

$ npm i reverso-api

Usage

const Reverso = require('reverso-api')
const reverso = new Reverso()

Congrats! You can use all the available methods now.
Let's read through the README and find out how the things work.

You can pass either callback function...

reverso.getContext(...params, (err, response) => {
    ...
})

or use .then() function.

reverso.getContext(...params).then((response) => {
    ...
})

All the examples below are given using callback function.

Examples

getContext

reverso.getContext(
    'meet me half way',
    'english',
    'russian',
    (err, response) => {
        if (err) throw new Error(err.message)

        console.log(response)
    }
)

Response:

{
    ok: Boolean,
    text: String,
    source: String,
    target: String,
    translations: [String, ...],
    examples: [
        {
            id: Number,
            source: String,
            target: String
        },
        ...
    ]
}

Error:

{ ok: Boolean, message: String }

getSpellCheck

reverso.getSpellCheck('helo', 'english', (err, response) => {
    if (err) throw new Error(err.message)

    console.log(response)
})

Response:

{
    ok: Boolean,
    text: String,
    sentences: [ { startIndex: Number, endIndex: Number, status: String } ... ],
    stats: {
        textLength: Number,
        wordCount: Number,
        sentenceCount: Number,
        longestSentence: Number,
    },
    corrections: [
        {
            id: Number,
            text: String,
            type: String,
            explanation: String,
            corrected: String,
            suggestions: [
                {
                    text: String,
                    definition: String,
                    category: String,
                },
                ...
            ],
        },
    ]
}

Error:

{ ok: Boolean, message: String }

getSynonyms

reverso.getSynonyms('dzień dobry', 'polish', (err, response) => {
    if (err) throw new Error(err.message)

    console.log(response)
})

Response:

{
    ok: true,
    text: String,
    source: String,
    synonyms: [
        { id: Number, synonym: String },
        ...
    ]
}

Error:

{ ok: Boolean, message: String }

getTranslation

⚠️ WARNING: eventually, your server's IP address might get banned by Reverso moderators and you won't receive any data.

reverso.getTranslation(
    'how is going?',
    'english',
    'chinese',
    (err, response) => {
        if (err) throw new Error(err.message)

        console.log(response)
    }
)

Response:

{
    text: String,
    source: String,
    target: String,
    translations: [String, ...],
    context: {
        examples: [
            {
                source: String,
                target: String,
                source_phrases: [
                    {
                        phrase: String,
                        offset: Number,
                        length: Number
                    },
                    ...
                ],
                target_phrases: [
                    {
                        phrase: String,
                        offset: Number,
                        length: Number
                    },
                    ...
                ]
            },
            ...
        ],
        rude: Boolean
    }, // or null
    detected_language: String,
    voice: String // or null
}

Error:

{ ok: Boolean, message: String }

getConjugation

reverso.getConjugation('идти', 'russian', (err, response) => {
    if (err) throw new Error(err.message)

    console.log(response)
})

Response:

{
    ok: Boolean,
    infinitive: String,
    verbForms: [
        {
            id: Number,
            conjugation: String,
            verbs: [String, ...],
        },
        ...
    ]
}

Error:

{ ok: Boolean, message: String }

Credits

• All data is provided by reverso.net.
• Author on Telegram @vychs.
• Want to talk about the API? Join our Telegram chat.