Skip to content

Commit afb72a5

Browse files
committed
feat: bump to SDK 0.3 with canonical response shapes (breaking)
1 parent c559e52 commit afb72a5

3 files changed

Lines changed: 40 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
## 0.3.0
4+
5+
**Breaking changes.**
6+
7+
- Bumped `@creatorcrawl/sdk` to `^0.3.0`, which switches every endpoint to the new unified `{ data, page?, meta }` envelope.
8+
- All platforms (TikTok, Instagram, Twitter/X, YouTube, Reddit, LinkedIn) now return canonical `Creator` / `Post` / `Comment` shapes with snake_case fields and ISO 8601 dates.
9+
- CLI surface is unchanged: command names, arguments, and flags are identical to 0.2. Only the shape of the JSON printed to stdout has changed.
10+
- README examples updated to reflect the new envelope (e.g. `.data.handle` / `.data.follower_count` instead of `.user.uniqueId` / `.stats.followerCount`).
11+
12+
See the [`@creatorcrawl/sdk` changelog](https://www.npmjs.com/package/@creatorcrawl/sdk) for the full type-level migration.
13+
14+
## 0.2.0
15+
16+
- Initial public release.

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# creatorcrawl CLI
22

3+
> **0.3 returns the new canonical response shape — see the SDK changelog for details.**
4+
35
Official command-line interface for [CreatorCrawl](https://creatorcrawl.com). Scrape **TikTok, Instagram, YouTube, LinkedIn, Twitter/X, and Reddit** from your terminal or shell scripts.
46

57
```bash
@@ -58,8 +60,26 @@ Run `creatorcrawl <platform> --help` for subcommand details.
5860

5961
Default: compact JSON (greppable, pipeable).
6062

63+
All responses use a unified envelope: `{ data, page?, meta }`. `data` holds the canonical record (`Creator`, `Post`, `Comment`, or a list of these). `meta` always includes `platform` and `fetched_at`.
64+
6165
```bash
62-
creatorcrawl tiktok profile khaby.lame | jq '.user.uniqueId, .stats.followerCount'
66+
creatorcrawl tiktok profile khaby.lame | jq '.data.handle, .data.follower_count'
67+
```
68+
69+
Sample response:
70+
71+
```json
72+
{
73+
"data": {
74+
"handle": "khaby.lame",
75+
"follower_count": 162000000,
76+
"platform": "tiktok"
77+
},
78+
"meta": {
79+
"platform": "tiktok",
80+
"fetched_at": "2026-05-15T10:00:00Z"
81+
}
82+
}
6383
```
6484

6585
Pretty-print:
@@ -78,7 +98,7 @@ creatorcrawl tiktok profile stoolpresidente
7898
creatorcrawl youtube transcript https://youtu.be/dQw4w9WgXcQ > transcript.json
7999

80100
# Search and extract top-5 channels
81-
creatorcrawl youtube search "ai tools" | jq '.items[:5]'
101+
creatorcrawl youtube search "ai tools" | jq '.data[:5]'
82102

83103
# LinkedIn ad library lookup
84104
creatorcrawl linkedin ads stripe

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "creatorcrawl",
3-
"version": "0.2.0",
3+
"version": "0.3.0",
44
"description": "Official CLI for CreatorCrawl. Scrape TikTok, Instagram, YouTube, LinkedIn, Twitter/X, and Reddit profiles, posts, comments, transcripts, ads, and trending data from your terminal or shell scripts.",
55
"license": "MIT",
66
"author": "CreatorCrawl <support@creatorcrawl.com>",
@@ -45,7 +45,7 @@
4545
"node": ">=18"
4646
},
4747
"dependencies": {
48-
"@creatorcrawl/sdk": "^0.2.0",
48+
"@creatorcrawl/sdk": "^0.3.0",
4949
"commander": "^12.1.0"
5050
},
5151
"devDependencies": {

0 commit comments

Comments
 (0)