{"id":13602528,"url":"https://github.com/crowdin-node/crowdin-node","last_synced_at":"2025-04-11T08:32:55.820Z","repository":{"id":57210785,"uuid":"198720925","full_name":"crowdin-node/crowdin-node","owner":"crowdin-node","description":"A Node.js client for the v1 and v2 Crowdin APIs","archived":false,"fork":false,"pushed_at":"2020-04-19T05:39:29.000Z","size":167,"stargazers_count":7,"open_issues_count":6,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-02T21:12:41.022Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crowdin-node.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-24T23:07:25.000Z","updated_at":"2024-09-29T10:09:46.000Z","dependencies_parsed_at":"2022-08-31T05:02:22.765Z","dependency_job_id":null,"html_url":"https://github.com/crowdin-node/crowdin-node","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin-node%2Fcrowdin-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin-node%2Fcrowdin-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin-node%2Fcrowdin-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin-node%2Fcrowdin-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crowdin-node","download_url":"https://codeload.github.com/crowdin-node/crowdin-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247735506,"owners_count":20987458,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T18:01:26.399Z","updated_at":"2025-04-11T08:32:50.809Z","avatar_url":"https://github.com/crowdin-node.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Crowdin API Client\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)\n\nA Node.js client for the \n[v1](https://support.crowdin.com/api/api-integration-setup/) and \n[v2](https://support.crowdin.com/enterprise/api/) Crowdin APIs\n\n🚧 This is still a work in progress. To see what remains to be implemented, check out the [open issues](https://github.com/crowdin-node/crowdin-node/issues). 🚧\n\n## Installation\n\n```sh\nnpm install crowdin\n```\n\n## Basic Usage\n\n```js\nconst crowdin = require('crowdin')({\n  key: process.env.CROWDIN_KEY,\n  schemaVersion: 'v2'\n})\n\nconst projects = await crowdin.projects.getMany()\n```\n\n## Examples\n\nTo try out some examples, clone the repo and install dependencies:\n\n```sh\ngit clone https://github.com/aletrejo/crowdin-wrapper\ncd crowdin-wrapper\nnpm install\n```\n\nThen you can run the examples:\n\n```js\nnode examples/v1-get-project-details.js\nnode examples/v2-add-files.js\n```\n\n## API\n\nThis module exports a single [factory function](https://www.youtube.com/watch?v=ImwrezYhw4w) \nthat returns a Crowdin client:\n\n### `createClient([options])`\n\n- `options` Object\n  - `key` String - Your Crowdin API key. Required.\n  - `schemaVersion` String (optional) - Çan be `v1` or `v2`. Defaults to `v2`.\n  - `hostname` String (optional) - Defaults to `api.crowdin.com`\n\nThe returned client is an object of deeply nested API operations like \n`crowdin.projects.files.getMany` and `crowdin.projects.branches.languages.progress.getMany`. \nEach of these operations returns a Promise to a [got](https://ghub.io/got) response object. \n\nSee [docs/v1.md](docs/v1.md) and [docs/v2.md](docs/v2.md) for reference.\n\n## Thanks\n\nSpecial thanks to :sparkles:[Paul Le Cam](https://www.npmjs.com/~paul_lecam):sparkles: for donating the `crowdin` npm package name. \n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/aletrejo\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/15284993?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAlejandra Trejo\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/crowdin-node/crowdin-node/commits?author=aletrejo\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/crowdin-node/crowdin-node/commits?author=aletrejo\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/crowdin-node/crowdin-node/commits?author=aletrejo\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"https://github.com/crowdin-node/crowdin-node/pulls?q=is%3Apr+reviewed-by%3Aaletrejo\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://zeke.sikelianos.com\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/2289?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eZeke Sikelianos\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/crowdin-node/crowdin-node/commits?author=zeke\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#design-zeke\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-zeke\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/crowdin-node/crowdin-node/commits?author=zeke\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/TomPradat\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/16164512?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTomPradat\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/crowdin-node/crowdin-node/commits?author=TomPradat\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdin-node%2Fcrowdin-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowdin-node%2Fcrowdin-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdin-node%2Fcrowdin-node/lists"}