API: Export translations

Last modified: October 12, 2021Author: Jakub Pomykała

Export translations to downloadable file. Using this endpoint requires authorization.

GET Endpoint

https://api.simplelocalize.io/api/v3/export

Example cURL

Download all translations into one file

curl
  --request GET \
  --url https://api.simplelocalize.io/api/v3/export?downloadFormat=multi-language-json \
  --header 'x-simplelocalize-token: <API_KEY>'

Learn more about multi-language-json.

Download translations for one language

curl
  --request GET \
  --url https://api.simplelocalize.io/api/v3/export?downloadFormat=single-language-json&languageKey=en \
  --header 'x-simplelocalize-token: <API_KEY>'

Learn more about single-language-json.

Query parameters

Parameter Description
downloadFormat (required) Set the download format. See table below.
languageKey (optional) Set the language key if you want to export translations just for one language
customerId (optional) Set the customer id if you want to export translations just customer translations

Available downloadFile values

downloadFormat Description
multi-language-json JSON file with all translations
single-language-json JSON file with one language (use languageKey param to specify language)
excel Microsoft Excel spreadsheet in *.xlsx format
yaml yaml file format
android XML Resource Strings file
localizable-strings Localizable.strings file format
java-properties Java properties file
po-pot PO/POT files
php-array PHP Array file
module-exports module.exports file

Example response

{
    "msg": "OK",
    "status": 200,
    "data": {
        "url": "https://cdn.simplelocalize.io/29fdc3462/snapshot_2021-10-12_13-01-25_063/translations.json"
    }
}

Deprecated APIs below

GET Deprecated endpoint

https://api.simplelocalize.io/api/v2/export

Deprecated export file formats

exportType Description
FORMAT_JS format used by FormatJS library
JEKYLL format used by Jekyll plugin
SPRING format used by Java and Spring applications (messages_xx.properties)
ANDROID format used by standard Android library
IOS_MACOS format used by standard iOS library
EXCEL Microsoft Excel spreadsheet in *.xlsx format