@xpoz/xpoz 0.6.6 → 0.6.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -79,6 +79,35 @@ const client = new XpozClient({ apiKey: "your-api-key", serverUrl: "https://xpoz
|
|
|
79
79
|
const client = new XpozClient({ apiKey: "your-api-key", timeoutMs: 600_000 });
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
+
### Trial Access (No Sign-Up Required)
|
|
83
|
+
|
|
84
|
+
Want to try the SDK before signing up? Mint a free trial token (no account needed, valid for 5 days):
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
curl -X POST https://api.xpoz.ai/api/trial/token
|
|
88
|
+
# -> { "success": true, "data": { "accessKey": "TRIAL...", "expiresInSeconds": 432000 }, ... }
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Then use the returned token (it starts with `TRIAL`) as your API key:
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
// Optional: try without your own account
|
|
95
|
+
const client = new XpozClient({
|
|
96
|
+
apiKey: "TRIAL...", // the token from the curl response above
|
|
97
|
+
});
|
|
98
|
+
await client.connect();
|
|
99
|
+
|
|
100
|
+
const user = await client.twitter.getUser("elonmusk");
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
The trial token is rate-limited and intentionally restricted:
|
|
104
|
+
|
|
105
|
+
- **Read-only data tools only** — search and lookup methods across Twitter, Instagram, Reddit, and TikTok. Account, tracking, and operation-management methods are not available and return an upgrade prompt.
|
|
106
|
+
- **Up to 5 results per call** — every response is capped at 5 items. `responseType` is forced to `ResponseType.FAST`, so pagination (`PAGING`) and CSV export (`CSV`) are unavailable.
|
|
107
|
+
- **Cached data only** — trial reads from the database and does not trigger live on-demand crawling, so the very latest posts may not appear.
|
|
108
|
+
|
|
109
|
+
For full result limits, pagination, CSV export, and live data, [get your own API key](https://xpoz.ai/get-token).
|
|
110
|
+
|
|
82
111
|
## Async Disposal
|
|
83
112
|
|
|
84
113
|
```typescript
|
package/dist/index.cjs
CHANGED
package/dist/index.d.cts
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED