Main menu

Export all locales to a zip archive

GET https://localise.biz/api/export/archive/{ext}.zip 

Export all translations from your project to an archive of individual locale files. You can also specify .tar instead of .zip.
If you're exporting to a format that supports multiple locales per file, you can use the /export/all method instead.

URI parameters

ext

Target file type specified as a file extension. See available options.

string required
format

More specific format of file type. e.g. symfony applies to php, xlf & yml

string optional
filter

Filter assets by comma-separated tag names. Match any tag with * and negate tags by prefixing with !

string optional
index

Override default lookup key for the file format: "id", "text" or a custom alias

string optional
source

Specify alternative source locale instead of project default

string optional
namespace

Override the project name for some language packs that use it as a key prefix

string optional
fallback

Fallback locale for untranslated assets, specified as short code. e.g. en or en_GB

string optional
order

Export translations according to asset order

created | id optional
status

Export translations with a specific status or flag. Negate values by prefixing with !. e.g. "translated", or "!fuzzy".

string optional
path

Custom pattern for file paths. See syntax

string optional
printf

Force alternative "printf" style. See string formatting

php | java | objc | icu | python optional
charset

Specify preferred character encoding. Alternative to Accept-Charset header but accepts a single value which must be valid.

string optional
breaks

Force platform-specific line-endings. Default is Unix (LF) breaks.

Unix | DOS | Mac optional
no-comments

Disable rendering of redundant inline comments including the Loco banner.

boolean optional
no-expand

Protect dot notation in keys so that foo.bar is not expanded to an object.

boolean optional
collisions

Override the default strategy for handling conflicting keys. See key collisions.

overwrite | ignore | fail | auto | legacy optional
no-folding

DEPRECATED: alias of no-expand for backward compatibility.

boolean optional
key

API key - required if not sent in Authorization header

string optional

Request headers

Authorization

API key sent as "Loco <key>" or "Basic <encoded>". See Authentication.

string required if not in query

Response

Raw string data

Try it

Open in test console »


« /api/export