google-translate-api-axios v9.0.2

google-translate-api-axios DEPRECATED

Use google-translate-api-x

A free and unlimited API for Google Translate :dollar: :no_entry_sign: written with compatibility in mind, supported by Axios.

Features

• Auto language detection
• Spelling correction
• Language correction
• Fast and reliable – it uses the same servers that translate.google.com uses
• Wide compatibility through using Axios for requests

Why this fork?

This fork of a fork vitalets/google-translate-api contains several improvements with the primary change being it is written using Axios instead of Got, allowing for greater compatibility outside of Node.js. It also abandons the outdated querystring.

Install

npm install google-translate-api-axios

Usage

From automatic language detection to English:

const translate = require('google-translate-api-axios');

const res = await translate('Ik spreek Engels', {to: 'en'});

console.log(res.text); //=> I speak English
console.log(res.from.language.iso);  //=> nl

If server returns Response code 403 (Forbidden) try set option client=gtx:

const res = await translate('Ik spreek Engels', { to: 'en', client: 'gtx' }).then(res => { ... });

Please note that maximum text length for single translation call is 5000 characters. In case of longer text you should split it on chunks, see #20.

Autocorrect

From English to Dutch with a typo (autoCorrect):

const res = await translate('I spea Dutch!', { from: 'en', to: 'nl', autoCorrect: true });

console.log(res.from.text.didYouMean); // => true
console.log(res.from.text.value); // => 'I [speak] Dutch!'

const correctedText = res.from.text.value.replace(/\[([a-z]+)\]/ig, '$1'); // => 'I speak Dutch!'
const finalRes = await translate(correctedText, { from: 'en', to: 'nl' });

console.log(finalRes.text); // => 'Ik spreek Nederlands!'

You can also add languages in the code and use them in the translation:

translate = require('google-translate-api-axios');
translate.languages['sr-Latn'] = 'Serbian Latin';

translate('translator', {to: 'sr-Latn'}).then(res => ...);

Proxy

Google Translate has request limits. If too many requests are made, you can either end up with a 429 or a 503 error. You can use proxy to bypass them:

const tunnel = require('tunnel');
translate('Ik spreek Engels', {to: 'en'}, {
    agent: tunnel.httpsOverHttp({
    proxy: { 
      host: 'whateverhost',
      proxyAuth: 'user:pass',
      port: '8080',
      headers: {
        'User-Agent': 'Node'
      }
    }
  }
)}).then(res => {
    // do something
});

Does it work from web page context?

It can, sort of. https://translate.google.com does not provide CORS http headers allowing access from other domains. However, this fork is written using Axios, allowing contexts that don't request CORS access, such as a browser extension background script or React Native.

API

translate(text, options, axiosconfig)

text

Type: string

The text to be translated

options

Type: object

from

Type: string Default: auto

The text language. Must be auto or one of the codes/names (not case sensitive) contained in languages.js

to

Type: string Default: en

The language in which the text should be translated. Must be one of the codes/names (case sensitive!) contained in languages.js.

raw

Type: boolean Default: false

If true, the returned object will have a raw property with the raw response (string) from Google Translate.

client

Type: string Default: "t"

Query parameter client used in API calls. Can be t|gtx.

tld

Type: string Default: "com"

TLD for Google translate host to be used in API calls: https://translate.google.{tld}.

axiosconfig

Type: object

The axios request config: https://axios-http.com/docs/req_config

Returns an object:

• text (string) – The translated text.
• from (object)
  • language (object)
    • didYouMean (boolean) - true if the API suggest a correction in the source language
    • iso (string) - The code of the language that the API has recognized in the text
  • text (object)
    • autoCorrected (boolean) – true if the API has auto corrected the text
    • value (string) – The auto corrected text or the text with suggested corrections
    • didYouMean (boolean) – true if the API has suggested corrections to the text
• raw (string) - If options.raw is true, the raw response from Google Translate servers. Otherwise, ''.

Note that res.from.text will only be returned if from.text.autoCorrected or from.text.didYouMean equals to true. In this case, it will have the corrections delimited with brackets ([ ]):

translate('I spea Dutch').then(res => {
    console.log(res.from.text.value);
    //=> I [speak] Dutch
}).catch(err => {
    console.error(err);
});

Otherwise, it will be an empty string ('').

Related projects

• Translateer - uses Puppeteer to access Google Translate API.

License

MIT © Matheus Fernandes, forked and maintained by Aidan Welch.