{"id":29019450,"url":"https://github.com/xct007/tiktok-scraper","last_synced_at":"2025-06-26T00:30:33.640Z","repository":{"id":62101670,"uuid":"557802245","full_name":"xct007/tiktok-scraper","owner":"xct007","description":"Simple Tiktok Api wraper","archived":false,"fork":false,"pushed_at":"2025-03-27T08:24:27.000Z","size":1155,"stargazers_count":21,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-27T19:18:47.204Z","etag":null,"topics":["api","scraper","sraper","tiktok","tiktok-api","tiktok-downloader","tiktok-scraper"],"latest_commit_sha":null,"homepage":"","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/xct007.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2022-10-26T10:32:25.000Z","updated_at":"2025-04-23T04:43:49.000Z","dependencies_parsed_at":"2024-11-08T04:26:04.626Z","dependency_job_id":"07362876-d579-4a49-bd32-c7ee1661fd05","html_url":"https://github.com/xct007/tiktok-scraper","commit_stats":{"total_commits":24,"total_committers":3,"mean_commits":8.0,"dds":0.08333333333333337,"last_synced_commit":"5093be41da372683a6b6bac841e5a5fc719379ee"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/xct007/tiktok-scraper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xct007%2Ftiktok-scraper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xct007%2Ftiktok-scraper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xct007%2Ftiktok-scraper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xct007%2Ftiktok-scraper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xct007","download_url":"https://codeload.github.com/xct007/tiktok-scraper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xct007%2Ftiktok-scraper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261976538,"owners_count":23239147,"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","scraper","sraper","tiktok","tiktok-api","tiktok-downloader","tiktok-scraper"],"created_at":"2025-06-26T00:30:26.471Z","updated_at":"2025-06-26T00:30:33.523Z","avatar_url":"https://github.com/xct007.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\n\n# Tiktok Video Fetcher\n\nThis project provides a TypeScript module for fetching and parsing TikTok videos and user profiles. The module allows you to fetch raw data from TikTok and optionally parse the data into a structured format, including the ability to dynamically add specific properties from the fetched data to the parsed result.\n\n## Features\n\n- **Fetch TikTok Data**: Retrieve raw data for TikTok videos and user profiles.\n- **Parse Data**: Optionally parse the fetched data into a structured format.\n- **Dynamic Key Inclusion**: Add specific properties from the fetched data to the parsed result.\n\n## Installation\n\nTo install the dependencies and use the module, run:\n\n```bash\nnpm install @xct007/tiktok-scraper\n```\n\n## Usage\n\nHere’s how you can use the module to fetch and parse TikTok video data:\n\n### Fetch Raw Data\n\n```typescript\nimport Tiktok from \"@xct007/tiktok-scraper\";\n\nTiktok(\"https://vt.tiktok.com/ZGJBtcsDq/\", {\n\t// Without parse option\n\t// The raw data will be returned\n\tparse: false,\n})\n\t.then((data) =\u003e {\n\t\tconsole.log(\"Aweme List:\", data);\n\t})\n\t.catch((error) =\u003e {\n\t\tconsole.error(error);\n\t});\n```\n\n### Parse Data with Specific Keys\n\nYou can specify the keys you want to include in the parsed result:\n\n```typescript\nimport Tiktok from \"@xct007/tiktok-scraper\";\n\nTiktok(\"https://vt.tiktok.com/ZGJBtcsDq/\", {\n\tparse: true,\n\tkeys: [\"desc_language\"],\n})\n\t.then((data) =\u003e {\n\t\t// The desc_language key\n\t\t// will be included in the parsed result\n\t\tconsole.log(\"Parsed Data:\", data.desc_language);\n\t})\n\t.catch((error) =\u003e {\n\t\tconsole.error(error);\n\t});\n```\n\n## API\n\n### `Tiktok(url: string, options?: ITiktokOptions): Promise\u003cAweme[] | IParsed | Partial\u003cIParsed\u003e\u003e`\n\nFetches TikTok video or user profile data based on the provided URL.\n\n- **url**: The URL of the TikTok video or user profile.\n- **options**: Optional configuration options:\n  - **parse**: `boolean` - If `true`, the data will be parsed, otherwise the raw data will be returned.\n  - **keys**: `Array\u003ckeyof Aweme\u003e` - Specify the keys to include in the parsed result.\n\nReturns a `Promise` that resolves to either an array of `Aweme` objects, a full `IParsed` object, or a `Partial\u003cIParsed\u003e` object if keys are specified.\n\n### `IParsed`\n\nAn interface that defines the structure of the parsed TikTok data. This structure can be extended dynamically based on the specified keys.\n\n## Contributing\n\nIf you’d like to contribute to this project, feel free to submit a pull request or open an issue.\n\n## Credits\n\nThis project was developed by **FrierenDv**.\n\n## License\n\nThis project is licensed under the MIT License.\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxct007%2Ftiktok-scraper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxct007%2Ftiktok-scraper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxct007%2Ftiktok-scraper/lists"}