Please consider that API 2.0 is now the preferred version to be used. The old API will remain fully functional until the end of 2021.
Crowdin provides RESTful API with XML or JSON over HTTP using GET or POST methods. Listed below are all the available API methods that allow you to create projects in Crowdin, add and update files, download translations or integrate localization with your development process.
To find your Account API key you have to login to your Crowdin account. Open Account Settings page and switch to API tab.
Please note that almost all API calls require the Project Identifier (ID). You can find your project identifier in the Project settings > API & Webhooks tab.
For every API request you make, you'll need to present the Account API key and username as main URI parameters to be authenticated. Keep your Account API key in secret! It should be guarded just as your regular account password.
Here's an example and principle of API request URI forming.
Typical API call URL looks like this: https://api.crowdin.com/api/project/. First placeholder (keyword in brackets) holds project identifier. Account API key and username are specified as a URI parameters.
The number of simultaneous API calls per account is 20 requests. If the limit is exceeded, 429 error code will show up with a message: “Maximum number of concurrent requests for this endpoint is reached. Please try again shortly.”
Postman is a tool that allows you to work with Crowdin API in a simple way.
All the available Crowdin API methods are already saved as a collection in Postman. Click Run in Postman to import and open this collection directly in your Postman app.
Add a new file to Crowdin project.
Upload the latest version of your source files (the ones, that should be localized) to your Crowdin project.
Delete file from Crowdin project. All the translations will be lost without ability to restore them.
Upload existing translations to your Crowdin project. Method is not working for Assets localization.
Track overall translation and proofreading progresses of each target language. Default response format is XML.
Get the detailed translation progress for specified language.
Get Crowdin Project details.
Get a list of issues reported in the Editor.
This method exports single translated files from Crowdin. Additionally, it can be applied to export XLIFF files for offline localization.
Build ZIP archive with the latest translations.
Get the status of translations export.
Download a ZIP file with translations. You can choose the language of translation you need or download all of them at once.
Pre-translate Crowdin project files.
Get projects list.
Create Crowdin project.
Edit Crowdin project.
Delete Crowdin project with all translations.
Add directory to Crowdin project.
Rename directory or modify its attributes. When renaming directory the path can not be changed (it means new_name parameter can not contain path, name only).
Delete Crowdin project directory. All nested files and directories will be deleted too.
Download Crowdin project glossaries as TBX, CSV, or XLSX file.
Upload your glossaries for Crowdin Project in TBX, CSV or XLS/XLSX file formats.
Download Crowdin project Translation Memory as TMX, CSV, or XLSX file.
Upload your Translation Memory for Crowdin Project in TMX, CSV or XLS/XLSX file format.
Get supported languages list with Crowdin codes mapped to locale name and standardized codes.
Generate pseudotranslation files for the whole project.
Download ZIP file with pseudo translations.
Generate Costs Estimation report to have an insight on how to plan the budget. This report allows you to calculate the approximate translation cost of currently untranslated strings in the project.
Download previously generated Costs Estimation report.
Generate Translation Costs report to calculate the real translation cost and know how much your translators and proofreaders should be paid.
Download previously generated Translation Costs report.
Generate Top Members report to know who contributed the most to your project's translation during the specified date range.
Download previously generated Top Members report.
Crowdin API Java SDK helps you smooth the work with all Crowdin API methods in your Java project, such as adding and updating files, downloading translations or integrating localization with your development process.