{"id":18163009,"url":"https://github.com/lucasvtiradentes/ticktick-api-lvt","last_synced_at":"2025-07-16T19:34:43.707Z","repository":{"id":64118563,"uuid":"573580843","full_name":"lucasvtiradentes/ticktick-api-lvt","owner":"lucasvtiradentes","description":"📅 a ticktick api wrapper package to be used in node based projects.","archived":false,"fork":false,"pushed_at":"2024-03-30T16:04:09.000Z","size":737,"stargazers_count":16,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-03T09:08:11.751Z","etag":null,"topics":["api-wrapper","nodejs","ticktick","ticktick-api","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ticktick-api-lvt","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lucasvtiradentes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"lucasvtiradentes","ko_fi":"lucasvtiradentes","patreon":"lucasvtiradentes"}},"created_at":"2022-12-02T20:15:44.000Z","updated_at":"2025-06-26T14:36:10.000Z","dependencies_parsed_at":"2023-11-14T01:27:40.669Z","dependency_job_id":"2cfb92f3-07d2-462a-b6ed-038d1742b1e8","html_url":"https://github.com/lucasvtiradentes/ticktick-api-lvt","commit_stats":{"total_commits":11,"total_committers":2,"mean_commits":5.5,"dds":0.09090909090909094,"last_synced_commit":"a7cbbcdb17e37deacc2eb67a6a09caeea6818284"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/lucasvtiradentes/ticktick-api-lvt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasvtiradentes%2Fticktick-api-lvt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasvtiradentes%2Fticktick-api-lvt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasvtiradentes%2Fticktick-api-lvt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasvtiradentes%2Fticktick-api-lvt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucasvtiradentes","download_url":"https://codeload.github.com/lucasvtiradentes/ticktick-api-lvt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasvtiradentes%2Fticktick-api-lvt/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265534790,"owners_count":23783887,"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":["api-wrapper","nodejs","ticktick","ticktick-api","typescript"],"created_at":"2024-11-02T10:05:49.574Z","updated_at":"2025-07-16T19:34:43.690Z","avatar_url":"https://github.com/lucasvtiradentes.png","language":"TypeScript","funding_links":["https://github.com/sponsors/lucasvtiradentes","https://ko-fi.com/lucasvtiradentes","https://patreon.com/lucasvtiradentes"],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"TOC\"\u003e\u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003e\n  TICKTICK API WRAPPER\n\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ticktick-api-lvt\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/ticktick-api-lvt.svg?style=flat\" alt=\"npm version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://nodejs.org/en/\"\u003e\u003cimg src=\"https://img.shields.io/badge/made%20with-node-1f425f?logo=node.js\u0026.svg\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/lucasvtiradentes/ticktick-api-lvt#contributing\"\u003e\u003cimg src=\"https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat\" alt=\"contributions\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#dart-features\"\u003eFeatures\u003c/a\u003e • \u003ca href=\"#warning-requirements\"\u003eRequirements\u003c/a\u003e • \u003ca href=\"#bulb-usage\"\u003eUsage\u003c/a\u003e • \u003ca href=\"#wrench-development\"\u003eDevelopment\u003c/a\u003e • \u003ca href=\"#books-about\"\u003eAbout\u003c/a\u003e • \u003ca href=\"#family-community\"\u003eCommunity\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cdetails\u003e\n  \u003csummary align=\"center\"\u003e\u003cspan\u003esee \u003cb\u003etable of content\u003c/b\u003e\u003c/span\u003e\u003c/summary\u003e\n  \u003cp align=\"center\"\u003e\n    \u003cul\u003e\n      \u003cli\u003e\u003ca href=\"#dart-features\"\u003eFeatures\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#warning-requirements\"\u003eRequirements\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#bulb-usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\n        \u003ca href=\"#wrench-development\"\u003eDevelopment\u003c/a\u003e\n        \u003cul\u003e\n          \u003cli\u003e\u003ca href=\"#development-setup\"\u003eDevelopment setup\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#used-technologies\"\u003eUsed technologies\u003c/a\u003e\u003c/li\u003e\n        \u003c/ul\u003e\n      \u003c/li\u003e\n      \u003cli\u003e\n        \u003ca href=\"#books-about\"\u003eAbout\u003c/a\u003e\n        \u003cul\u003e\n          \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n        \u003c/ul\u003e\n      \u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/p\u003e\n\u003c/details\u003e\n\n\u003ca href=\"#\"\u003e\u003cimg src=\"./.github/images/divider.png\" /\u003e\u003c/a\u003e\n\n## :trumpet: Overview\n\nThis is a [ticktick](ticktick.com) api wrapper developed to be used on [Node.js](https://nodejs.org/en) based projects.\n\n\u003e :warning: **warning**: As of Jan 2024 Ticktick requires a captcha token in order to authenticate user on login. I'm working in order to implement it on this package, but have not yet succeeded. More details on [this issue](https://github.com/lucasvtiradentes/ticktick-api-lvt/issues/13).\n\n## :dart: Features\u003ca href=\"#TOC\"\u003e\u003cimg align=\"right\" src=\"./.github/images/up_arrow.png\" width=\"22\"\u003e\u003c/a\u003e\n\n\u0026nbsp;\u0026nbsp;\u0026nbsp;✔️ type safe api methods by using [zod](https://github.com/colinhacks/zod) validation;\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;✔️ methods for common actions, find more [here](./src/routes/);\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;✔️ support to china [api version](https://api.dida365.com) [thanks to [@quanru](https://github.com/quanru)];\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;✔️ custom headers required in order to make api calls [thanks to [@thesamim](https://github.com/thesamim)].\u003cbr\u003e\n\n## :warning: Requirements\u003ca href=\"#TOC\"\u003e\u003cimg align=\"right\" src=\"./.github/images/up_arrow.png\" width=\"22\"\u003e\u003c/a\u003e\n\nIn order to use this project in your computer, you need to have the following items:\n\n- [npm](https://www.npmjs.com/): To install the package. Npm is installed alongside nodejs;\n- [nodejs](https://nodejs.org/en/): To actually run the package.\n\n## :bulb: Usage\u003ca href=\"#TOC\"\u003e\u003cimg align=\"right\" src=\"./.github/images/up_arrow.png\" width=\"22\"\u003e\u003c/a\u003e\n\nTo use it from the registry, first install the npm package:\n\n```bash\n# Install the package\nnpm install ticktick-api-lvt\n```\n\nAnd you can normally use it in your code as it follows:\n\n```typescript\nimport { Tick } from 'ticktick-api-lvt';\n\nasync function main() {\n  const username = 'your_username';\n  const password = 'your_password';\n\n  const tickInstance = new Ticktick({ username, password });\n\n  // LOGIN =====================================================================\n\n  await tickInstance.auth.login();\n\n  // METHODS ===================================================================\n\n  console.log(await tickInstance.user.getUserInformation());\n  console.log(await tickInstance.user.getUserDailyReminder());\n  console.log(await tickInstance.user.getUserSettings());\n  console.log(await tickInstance.tags.getTags());\n  console.log(await tickInstance.tasks.getCompletedTasks());\n\n}\n\nmain();\n```\n\nTo see further usage, check out the provided [example](./examples/dev-example.ts).\n\n## :wrench: Development\u003ca href=\"#TOC\"\u003e\u003cimg align=\"right\" src=\"./.github/images/up_arrow.png\" width=\"22\"\u003e\u003c/a\u003e\n\n### Development setup\n\nTo setup this project in your computer, download it in this link or run the following commands:\n\n```bash\n# Clone this repository\n$ git clone https://github.com/lucasvtiradentes/ticktick-api-lvt\n\n# Go into the repository\n$ cd ticktick-api-lvt\n```\n\nAfter download it, go to the project folder and run these commands:\n\n```bash\n# Install dependencies using npm\n$ npm install\n\n# Run the typescript code in development mode\n$ npm run dev\n```\n\nIf you want to contribute to the project, after you make the necessary changes, run these commands to check if everything is working fine:\n\n```bash\n# Compile the code into javascript\n$ npm run build\n\n# Run the compiled code in production mode\n$ npm run start\n```\n\n### Used technologies\n\nThis project uses the following thechnologies:\n\n\u003cdiv align=\"center\"\u003e\n  \u003ctable\u003e\n    \u003ctr\u003e\n      \u003cth\u003eScope\u003c/th\u003e\n      \u003cth\u003eSubject\u003c/th\u003e\n      \u003cth\u003eTechnologies\u003c/th\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd rowspan=\"1\"\u003eProject\u003c/td\u003e\n      \u003ctd\u003eMain\u003c/td\u003e\n      \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://nodejs.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Node.js-339933?logo=nodedotjs\u0026logoColor=white\"\u003e\u003c/a\u003e\n        \u003ca target=\"_blank\" href=\"https://www.typescriptlang.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/typescript-%23007ACC.svg?logo=typescript\u0026logoColor=white\"\u003e\u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd rowspan=\"3\"\u003eSetup\u003c/td\u003e\n      \u003ctd\u003eCode linting\u003c/td\u003e\n      \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/prettier/prettier\"\u003e\u003cimg src=\"https://img.shields.io/badge/prettier-1A2C34?logo=prettier\u0026logoColor=F7BA3E\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/eslint/eslint\"\u003e\u003cimg src=\"https://img.shields.io/badge/eslint-3A33D1?logo=eslint\u0026logoColor=white\"\u003e\u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003c!-- \u003ctd rowspan=\"3\"\u003eSetup\u003c/td\u003e --\u003e\n      \u003ctd\u003eCommit linting\u003c/td\u003e\n      \u003ctd align=\"center\"\u003e\n      \u003ca target=\"_blank\" href=\"https://github.com/conventional-changelog/commitlint\"\u003e\u003cimg src=\"https://img.shields.io/badge/commitlint-red?logo=commitlint\u0026logoColor=white\"\u003e\u003c/a\u003e\n      \u003ca target=\"_blank\" href=\"https://github.com/commitizen/cz-cli\"\u003e\u003cimg src=\"https://img.shields.io/badge/commitizen-pink?logo=conventionalcommits\u0026logoColor=white\"\u003e\u003c/a\u003e\n      \u003c!-- \u003ca href=\"https://gitmoji.dev\"\u003e\u003cimg src=\"https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square\" alt=\"Gitmoji\"/\u003e\u003c/a\u003e --\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003c!-- \u003ctd rowspan=\"1\"\u003eSetup\u003c/td\u003e --\u003e\n      \u003ctd\u003eOther\u003c/td\u003e\n      \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://editorconfig.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Editor%20Config-E0EFEF?logo=editorconfig\u0026logoColor=000\"\u003e\u003c/a\u003e\n        \u003ca target=\"_blank\" href=\"https://github.com/typicode/husky\"\u003e\u003cimg src=\"https://img.shields.io/badge/🐶%20husky-green?logo=husky\u0026logoColor=white\"\u003e\u003c/a\u003e\n        \u003c!-- \u003ca target=\"_blank\" href=\"https://github.com/okonet/lint-staged\"\u003e\u003cimg src=\"https://img.shields.io/badge/🚫%20lint%20staged-yellow?\u0026logoColor=white\"\u003e\u003c/a\u003e --\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\u003c/div\u003e\n\n\u003ca href=\"#\"\u003e\u003cimg src=\"./.github/images/divider.png\" /\u003e\u003c/a\u003e\n\n## :books: About\u003ca href=\"#TOC\"\u003e\u003cimg align=\"right\" src=\"./.github/images/up_arrow.png\" width=\"22\"\u003e\u003c/a\u003e\n\n## License\n\nThis project is distributed under the terms of the MIT License Version 2.0. A complete version of the license is available in the [LICENSE](LICENSE) file in this repository. Any contribution made to this project will be licensed under the MIT License Version 2.0.\n\n\u003ca href=\"#\"\u003e\u003cimg src=\"./.github/images/divider.png\" /\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\n    \u003ca target=\"_blank\" href=\"https://www.linkedin.com/in/lucasvtiradentes/\"\u003e\u003cimg src=\"https://img.shields.io/badge/-linkedin-blue?logo=Linkedin\u0026logoColor=white\" alt=\"LinkedIn\"\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"mailto:lucasvtiradentes@gmail.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/gmail-red?logo=gmail\u0026logoColor=white\" alt=\"Gmail\"\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://discord.com/users/262326726892191744\"\u003e\u003cimg src=\"https://img.shields.io/badge/discord-5865F2?logo=discord\u0026logoColor=white\" alt=\"Discord\"\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://github.com/lucasvtiradentes/\"\u003e\u003cimg src=\"https://img.shields.io/badge/github-gray?logo=github\u0026logoColor=white\" alt=\"Github\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n  \u003cp\u003eMade with ❤️ by \u003cstrong\u003eLucas Vieira\u003c/strong\u003e\u003c/p\u003e\n  \u003cp\u003e👉 See also all \u003ca href=\"https://github.com/lucasvtiradentes/lucasvtiradentes/blob/master/portfolio/PROJECTS.md#TOC\"\u003emy projects\u003c/a\u003e\u003c/p\u003e\n  \u003cp\u003e👉 See also all \u003ca href=\"https://github.com/lucasvtiradentes/my-tutorials#readme\"\u003emy articles\u003c/a\u003e\u003c/p\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasvtiradentes%2Fticktick-api-lvt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucasvtiradentes%2Fticktick-api-lvt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasvtiradentes%2Fticktick-api-lvt/lists"}