@bitget-ai/getagent-skill 0.2.1 → 0.3.0

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.
Files changed (38) hide show
  1. package/.claude-plugin/marketplace.json +15 -4
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/VERSION +1 -1
  4. package/package.json +1 -1
  5. package/skills/getagent/SKILL.md +169 -6
  6. package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
  7. package/skills/getagent/references/api/confirm.md +59 -0
  8. package/skills/getagent/references/api/index.md +9 -7
  9. package/skills/getagent/references/api/publish.md +13 -6
  10. package/skills/getagent/references/api/run.md +5 -5
  11. package/skills/getagent/references/api/upload.md +22 -4
  12. package/skills/getagent/references/backtest-engine.md +82 -152
  13. package/skills/getagent/references/package-schema.md +31 -8
  14. package/skills/getagent/references/sdk/backtest/catalog.md +17 -2
  15. package/skills/getagent/references/sdk/data/arxiv.md +8 -10
  16. package/skills/getagent/references/sdk/data/catalog.md +3 -8
  17. package/skills/getagent/references/sdk/data/commodity.md +71 -39
  18. package/skills/getagent/references/sdk/data/coverage.md +0 -3
  19. package/skills/getagent/references/sdk/data/crypto.md +1583 -402
  20. package/skills/getagent/references/sdk/data/currency.md +55 -15
  21. package/skills/getagent/references/sdk/data/derivatives.md +161 -50
  22. package/skills/getagent/references/sdk/data/economy.md +911 -259
  23. package/skills/getagent/references/sdk/data/equity.md +1719 -393
  24. package/skills/getagent/references/sdk/data/etf.md +550 -64
  25. package/skills/getagent/references/sdk/data/famafrench.md +38 -50
  26. package/skills/getagent/references/sdk/data/fixedincome.md +574 -139
  27. package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
  28. package/skills/getagent/references/sdk/data/index.md +18 -32
  29. package/skills/getagent/references/sdk/data/news.md +128 -58
  30. package/skills/getagent/references/sdk/data/regulators.md +108 -43
  31. package/skills/getagent/references/sdk/data/sentiment.md +188 -34
  32. package/skills/getagent/references/sdk/data/uscongress.md +13 -21
  33. package/skills/getagent/references/sdk/data/web_search.md +3 -7
  34. package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
  35. package/skills/getagent/references/sdk.md +14 -5
  36. package/skills/getagent/scripts/validate.py +109 -3
  37. package/skills/getagent/scripts/version_check.sh +13 -12
  38. package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9871
@@ -22,7 +22,7 @@ are callable through the DataSDK wrapper.
22
22
  ### `sentiment.followin_coin_news`
23
23
 
24
24
  ```python
25
- data.sentiment.followin_coin_news(symbol=..., limit=20, provider='followin')
25
+ data.sentiment.followin_coin_news(symbol=..., limit=20)
26
26
  ```
27
27
 
28
28
  Summary: Followin Coin News
@@ -32,7 +32,6 @@ Summary: Followin Coin News
32
32
  | Endpoint ID | `sentiment.followin_coin_news` |
33
33
  | HTTP | `GET` |
34
34
  | Path | `/inner/v1/agent-data/sentiment/followin_coin_news` |
35
- | Default provider | `followin` |
36
35
  | SDK | `supported` |
37
36
  | Host | `supported` |
38
37
  | Notes | - |
@@ -43,14 +42,25 @@ Summary: Followin Coin News
43
42
  |---|---|---|---|---|
44
43
  | `symbol` | `yes` | `string` | `-` | Coin/token symbol to fetch news for (e.g. 'BTC', 'ETH'). |
45
44
  | `limit` | `no` | `integer` | `20` | Maximum number of articles to return. Default 20. |
46
- | `provider` | `no` | `string` | `followin` | - |
45
+
46
+ #### Response fields
47
+
48
+ | Field | Type | Notes |
49
+ |---|---|---|
50
+ | `title` | `string` | Article title. |
51
+ | `link` | `string` | URL of the article. |
52
+ | `published` | `string` | Publication datetime (UTC). |
53
+ | `source` | `string` | Original news source name. |
54
+ | `summary` | `string` | Article summary or description. |
55
+ | `author` | `string` | Author or KOL name. |
56
+ | `symbol` | `string` | Related coin/token symbol if applicable. |
47
57
 
48
58
  ---
49
59
 
50
60
  ### `sentiment.followin_news`
51
61
 
52
62
  ```python
53
- data.sentiment.followin_news(news_type='trending', limit=20, provider='followin')
63
+ data.sentiment.followin_news(news_type='trending', limit=20)
54
64
  ```
55
65
 
56
66
  Summary: Followin News
@@ -60,7 +70,6 @@ Summary: Followin News
60
70
  | Endpoint ID | `sentiment.followin_news` |
61
71
  | HTTP | `GET` |
62
72
  | Path | `/inner/v1/agent-data/sentiment/followin_news` |
63
- | Default provider | `followin` |
64
73
  | SDK | `supported` |
65
74
  | Host | `supported` |
66
75
  | Notes | - |
@@ -71,14 +80,25 @@ Summary: Followin News
71
80
  |---|---|---|---|---|
72
81
  | `news_type` | `no` | `string` | `trending` | Type of news to fetch. 'trending' = hot news feed, 'flash' = flash/breaking news, 'kol_opinions' = KOL opinion articles. |
73
82
  | `limit` | `no` | `integer` | `20` | Maximum number of articles to return. Default 20. |
74
- | `provider` | `no` | `string` | `followin` | - |
83
+
84
+ #### Response fields
85
+
86
+ | Field | Type | Notes |
87
+ |---|---|---|
88
+ | `title` | `string` | Article title. |
89
+ | `link` | `string` | URL of the article. |
90
+ | `published` | `string` | Publication datetime (UTC). |
91
+ | `source` | `string` | Original news source name. |
92
+ | `summary` | `string` | Article summary or description. |
93
+ | `author` | `string` | Author or KOL name. |
94
+ | `symbol` | `string` | Related coin/token symbol if applicable. |
75
95
 
76
96
  ---
77
97
 
78
98
  ### `sentiment.followin_trending_topics`
79
99
 
80
100
  ```python
81
- data.sentiment.followin_trending_topics(limit=20, provider='followin')
101
+ data.sentiment.followin_trending_topics(limit=20)
82
102
  ```
83
103
 
84
104
  Summary: Followin Trending Topics
@@ -88,7 +108,6 @@ Summary: Followin Trending Topics
88
108
  | Endpoint ID | `sentiment.followin_trending_topics` |
89
109
  | HTTP | `GET` |
90
110
  | Path | `/inner/v1/agent-data/sentiment/followin_trending_topics` |
91
- | Default provider | `followin` |
92
111
  | SDK | `supported` |
93
112
  | Host | `supported` |
94
113
  | Notes | - |
@@ -98,14 +117,23 @@ Summary: Followin Trending Topics
98
117
  | Param | Required | Type | Default | Notes |
99
118
  |---|---|---|---|---|
100
119
  | `limit` | `no` | `integer` | `20` | Maximum number of topics to return. Default 20. |
101
- | `provider` | `no` | `string` | `followin` | - |
120
+
121
+ #### Response fields
122
+
123
+ | Field | Type | Notes |
124
+ |---|---|---|
125
+ | `rank` | `integer` | Topic rank. |
126
+ | `topic` | `string` | Trending topic name or keyword. |
127
+ | `heat` | `integer` | Heat/popularity score of the topic. |
128
+ | `article_count` | `integer` | Number of articles related to this topic. |
129
+ | `symbol` | `string` | Related coin/token symbol if applicable. |
102
130
 
103
131
  ---
104
132
 
105
133
  ### `sentiment.market_fear_greed`
106
134
 
107
135
  ```python
108
- data.sentiment.market_fear_greed(provider='feargreed')
136
+ data.sentiment.market_fear_greed()
109
137
  ```
110
138
 
111
139
  Summary: Market Fear Greed
@@ -115,7 +143,6 @@ Summary: Market Fear Greed
115
143
  | Endpoint ID | `sentiment.market_fear_greed` |
116
144
  | HTTP | `GET` |
117
145
  | Path | `/inner/v1/agent-data/sentiment/market_fear_greed` |
118
- | Default provider | `feargreed` |
119
146
  | SDK | `supported` |
120
147
  | Host | `supported` |
121
148
  | Notes | - |
@@ -124,14 +151,25 @@ Summary: Market Fear Greed
124
151
 
125
152
  | Param | Required | Type | Default | Notes |
126
153
  |---|---|---|---|---|
127
- | `provider` | `no` | `string` | `feargreed` | - |
154
+
155
+ #### Response fields
156
+
157
+ | Field | Type | Notes |
158
+ |---|---|---|
159
+ | `score` | `number` | Current Fear & Greed Index score (0-100). 0 = Extreme Fear, 50 = Neutral, 100 = Extreme Greed. |
160
+ | `rating` | `string` | Human-readable rating: 'Extreme Fear', 'Fear', 'Neutral', 'Greed', 'Extreme Greed'. |
161
+ | `timestamp` | `string` | Timestamp of the index reading. |
162
+ | `previous_close` | `number` | Previous close score. |
163
+ | `previous_1_week` | `number` | Score one week ago. |
164
+ | `previous_1_month` | `number` | Score one month ago. |
165
+ | `previous_1_year` | `number` | Score one year ago. |
128
166
 
129
167
  ---
130
168
 
131
169
  ### `sentiment.news`
132
170
 
133
171
  ```python
134
- data.sentiment.news(category='all', limit=20, provider='rssnews')
172
+ data.sentiment.news(category='all', limit=20)
135
173
  ```
136
174
 
137
175
  Summary: News
@@ -141,7 +179,6 @@ Summary: News
141
179
  | Endpoint ID | `sentiment.news` |
142
180
  | HTTP | `GET` |
143
181
  | Path | `/inner/v1/agent-data/sentiment/news` |
144
- | Default provider | `rssnews` |
145
182
  | SDK | `supported` |
146
183
  | Host | `supported` |
147
184
  | Notes | - |
@@ -152,14 +189,25 @@ Summary: News
152
189
  |---|---|---|---|---|
153
190
  | `category` | `no` | `string` | `all` | News category filter. 'all' fetches all 44 sources concurrently. Other options filter by source group: 'crypto_core' (7 sources), 'crypto_high_freq' (4), 'crypto_supplement' (6), 'macro' (4), 'kol' (4), 'tech_ai' (5), 'geopolitical' (5), 'reddit' (5), 'chinese_japanese' (2), 'other' (2). |
154
191
  | `limit` | `no` | `integer` | `20` | Maximum number of articles to return per source. Default 20. |
155
- | `provider` | `no` | `string` | `rssnews` | - |
192
+
193
+ #### Response fields
194
+
195
+ | Field | Type | Notes |
196
+ |---|---|---|
197
+ | `title` | `string` | Article title. |
198
+ | `link` | `string` | URL of the article. |
199
+ | `published` | `string` | Publication datetime (UTC). |
200
+ | `source` | `string` | Name of the news source. |
201
+ | `category` | `string` | Source category group. |
202
+ | `summary` | `string` | Article summary or description. |
203
+ | `author` | `string` | Article author. |
156
204
 
157
205
  ---
158
206
 
159
207
  ### `sentiment.trending`
160
208
 
161
209
  ```python
162
- data.sentiment.trending(filter='all-stocks', page=1, provider='apewisdom')
210
+ data.sentiment.trending(filter='all-stocks', page=1)
163
211
  ```
164
212
 
165
213
  Summary: Trending
@@ -169,7 +217,6 @@ Summary: Trending
169
217
  | Endpoint ID | `sentiment.trending` |
170
218
  | HTTP | `GET` |
171
219
  | Path | `/inner/v1/agent-data/sentiment/trending` |
172
- | Default provider | `apewisdom` |
173
220
  | SDK | `supported` |
174
221
  | Host | `supported` |
175
222
  | Notes | - |
@@ -178,16 +225,27 @@ Summary: Trending
178
225
 
179
226
  | Param | Required | Type | Default | Notes |
180
227
  |---|---|---|---|---|
181
- | `filter` | `no` | `string` | `all-stocks` | Category or subreddit filter for trending data.; The subreddit or category filter. 'all-stocks' aggregates all stock-related subreddits, 'all-crypto' aggregates all crypto-related subreddits, '4chan' is /biz/ board, or specific subreddits like 'wallstreetbets', 'stocks', 'investing', 'cryptocurrency'. (provider: apewisdom) |
228
+ | `filter` | `no` | `string` | `all-stocks` | Category or subreddit filter for trending data.; The subreddit or category filter. 'all-stocks' aggregates all stock-related subreddits, 'all-crypto' aggregates all crypto-related subreddits, '4chan' is /biz/ board, or specific subreddits like 'wallstreetbets', 'stocks', 'investing', 'cryptocurrency'. |
182
229
  | `page` | `no` | `integer` | `1` | Page number for pagination. |
183
- | `provider` | `no` | `string` | `apewisdom` | - |
230
+
231
+ #### Response fields
232
+
233
+ | Field | Type | Notes |
234
+ |---|---|---|
235
+ | `rank` | `integer` | Current rank by mention volume. |
236
+ | `ticker` | `string` | The ticker symbol. |
237
+ | `name` | `string` | Company or asset name. |
238
+ | `mentions` | `integer` | Number of mentions in the last 24 hours. |
239
+ | `upvotes` | `integer` | Total upvotes on posts mentioning this ticker. |
240
+ | `rank_24h_ago` | `integer` | Rank 24 hours ago. |
241
+ | `mentions_24h_ago` | `integer` | Number of mentions 24 hours ago. |
184
242
 
185
243
  ---
186
244
 
187
245
  ### `sentiment.twitter_list_timeline`
188
246
 
189
247
  ```python
190
- data.sentiment.twitter_list_timeline(list_id=..., count=20, cursor='', provider='twitter')
248
+ data.sentiment.twitter_list_timeline(list_id=..., count=20, cursor='')
191
249
  ```
192
250
 
193
251
  Summary: Twitter List Timeline
@@ -197,7 +255,6 @@ Summary: Twitter List Timeline
197
255
  | Endpoint ID | `sentiment.twitter_list_timeline` |
198
256
  | HTTP | `GET` |
199
257
  | Path | `/inner/v1/agent-data/sentiment/twitter_list_timeline` |
200
- | Default provider | `twitter` |
201
258
  | SDK | `supported` |
202
259
  | Host | `supported` |
203
260
  | Notes | - |
@@ -209,14 +266,33 @@ Summary: Twitter List Timeline
209
266
  | `list_id` | `yes` | `string` | `-` | Twitter List ID to fetch tweets from. |
210
267
  | `count` | `no` | `integer` | `20` | Number of tweets to return (max 100). |
211
268
  | `cursor` | `no` | `string` | `` | Pagination cursor for next page. Leave empty for first page. |
212
- | `provider` | `no` | `string` | `twitter` | - |
269
+
270
+ #### Response fields
271
+
272
+ | Field | Type | Notes |
273
+ |---|---|---|
274
+ | `tweet_id` | `string` | Unique tweet ID. |
275
+ | `text` | `string` | Full tweet text content. |
276
+ | `created_at` | `string` | Tweet creation timestamp. |
277
+ | `author_id` | `string` | Author's user ID. |
278
+ | `author_name` | `string` | Author's display name. |
279
+ | `author_username` | `string` | Author's screen name (@handle). |
280
+ | `reply_count` | `integer` | Number of replies. |
281
+ | `retweet_count` | `integer` | Number of retweets. |
282
+ | `like_count` | `integer` | Number of likes/favorites. |
283
+ | `quote_count` | `integer` | Number of quote tweets. |
284
+ | `bookmark_count` | `integer` | Number of bookmarks. |
285
+ | `lang` | `string` | Language code of the tweet. |
286
+ | `is_retweet` | `boolean` | Whether this tweet is a retweet. |
287
+ | `is_quote` | `boolean` | Whether this tweet is a quote tweet. |
288
+ | `next_cursor` | `string` | Cursor for fetching the next page of results. |
213
289
 
214
290
  ---
215
291
 
216
292
  ### `sentiment.twitter_search`
217
293
 
218
294
  ```python
219
- data.sentiment.twitter_search(query=..., count=20, cursor='', product='Latest', provider='twitter')
295
+ data.sentiment.twitter_search(query=..., count=20, cursor='', product='Latest')
220
296
  ```
221
297
 
222
298
  Summary: Twitter Search
@@ -226,7 +302,6 @@ Summary: Twitter Search
226
302
  | Endpoint ID | `sentiment.twitter_search` |
227
303
  | HTTP | `GET` |
228
304
  | Path | `/inner/v1/agent-data/sentiment/twitter_search` |
229
- | Default provider | `twitter` |
230
305
  | SDK | `supported` |
231
306
  | Host | `supported` |
232
307
  | Notes | - |
@@ -239,14 +314,33 @@ Summary: Twitter Search
239
314
  | `count` | `no` | `integer` | `20` | Number of tweets to return (max 40). |
240
315
  | `cursor` | `no` | `string` | `` | Pagination cursor for next page. Leave empty for first page. |
241
316
  | `product` | `no` | `string` | `Latest` | Timeline product type. One of 'Latest' or 'Top'. |
242
- | `provider` | `no` | `string` | `twitter` | - |
317
+
318
+ #### Response fields
319
+
320
+ | Field | Type | Notes |
321
+ |---|---|---|
322
+ | `tweet_id` | `string` | Unique tweet ID. |
323
+ | `text` | `string` | Full tweet text content. |
324
+ | `created_at` | `string` | Tweet creation timestamp. |
325
+ | `author_id` | `string` | Author's user ID. |
326
+ | `author_name` | `string` | Author's display name. |
327
+ | `author_username` | `string` | Author's screen name (@handle). |
328
+ | `reply_count` | `integer` | Number of replies. |
329
+ | `retweet_count` | `integer` | Number of retweets. |
330
+ | `like_count` | `integer` | Number of likes/favorites. |
331
+ | `quote_count` | `integer` | Number of quote tweets. |
332
+ | `bookmark_count` | `integer` | Number of bookmarks. |
333
+ | `lang` | `string` | Language code of the tweet. |
334
+ | `is_retweet` | `boolean` | Whether this tweet is a retweet. |
335
+ | `is_quote` | `boolean` | Whether this tweet is a quote tweet. |
336
+ | `next_cursor` | `string` | Cursor for fetching the next page of results. |
243
337
 
244
338
  ---
245
339
 
246
340
  ### `sentiment.twitter_tweet_detail`
247
341
 
248
342
  ```python
249
- data.sentiment.twitter_tweet_detail(tweet_id=..., provider='twitter')
343
+ data.sentiment.twitter_tweet_detail(tweet_id=...)
250
344
  ```
251
345
 
252
346
  Summary: Twitter Tweet Detail
@@ -256,7 +350,6 @@ Summary: Twitter Tweet Detail
256
350
  | Endpoint ID | `sentiment.twitter_tweet_detail` |
257
351
  | HTTP | `GET` |
258
352
  | Path | `/inner/v1/agent-data/sentiment/twitter_tweet_detail` |
259
- | Default provider | `twitter` |
260
353
  | SDK | `supported` |
261
354
  | Host | `supported` |
262
355
  | Notes | - |
@@ -266,14 +359,37 @@ Summary: Twitter Tweet Detail
266
359
  | Param | Required | Type | Default | Notes |
267
360
  |---|---|---|---|---|
268
361
  | `tweet_id` | `yes` | `string` | `-` | The focal tweet ID to fetch details for. |
269
- | `provider` | `no` | `string` | `twitter` | - |
362
+
363
+ #### Response fields
364
+
365
+ | Field | Type | Notes |
366
+ |---|---|---|
367
+ | `tweet_id` | `string` | Unique tweet ID. |
368
+ | `text` | `string` | Full tweet text content. |
369
+ | `created_at` | `string` | Tweet creation timestamp. |
370
+ | `author_id` | `string` | Author's user ID. |
371
+ | `author_name` | `string` | Author's display name. |
372
+ | `author_username` | `string` | Author's screen name (@handle). |
373
+ | `reply_count` | `integer` | Number of replies. |
374
+ | `retweet_count` | `integer` | Number of retweets. |
375
+ | `like_count` | `integer` | Number of likes/favorites. |
376
+ | `quote_count` | `integer` | Number of quote tweets. |
377
+ | `bookmark_count` | `integer` | Number of bookmarks. |
378
+ | `view_count` | `integer` | Number of views/impressions. |
379
+ | `lang` | `string` | Language code of the tweet. |
380
+ | `conversation_id` | `string` | Root conversation thread ID. |
381
+ | `in_reply_to_user_id` | `string` | User ID of the account being replied to. |
382
+ | `is_retweet` | `boolean` | Whether this tweet is a retweet. |
383
+ | `is_quote` | `boolean` | Whether this tweet is a quote tweet. |
384
+ | `quoted_tweet_id` | `string` | ID of the quoted tweet, if any. |
385
+ | `media_urls` | `array` | List of media URLs attached to the tweet. |
270
386
 
271
387
  ---
272
388
 
273
389
  ### `sentiment.twitter_user_by_id`
274
390
 
275
391
  ```python
276
- data.sentiment.twitter_user_by_id(user_id=..., provider='twitter')
392
+ data.sentiment.twitter_user_by_id(user_id=...)
277
393
  ```
278
394
 
279
395
  Summary: Twitter User By Id
@@ -283,7 +399,6 @@ Summary: Twitter User By Id
283
399
  | Endpoint ID | `sentiment.twitter_user_by_id` |
284
400
  | HTTP | `GET` |
285
401
  | Path | `/inner/v1/agent-data/sentiment/twitter_user_by_id` |
286
- | Default provider | `twitter` |
287
402
  | SDK | `supported` |
288
403
  | Host | `supported` |
289
404
  | Notes | - |
@@ -293,14 +408,34 @@ Summary: Twitter User By Id
293
408
  | Param | Required | Type | Default | Notes |
294
409
  |---|---|---|---|---|
295
410
  | `user_id` | `yes` | `string` | `-` | Twitter user ID (numeric string). |
296
- | `provider` | `no` | `string` | `twitter` | - |
411
+
412
+ #### Response fields
413
+
414
+ | Field | Type | Notes |
415
+ |---|---|---|
416
+ | `user_id` | `string` | Unique numeric user ID. |
417
+ | `name` | `string` | Display name. |
418
+ | `username` | `string` | Screen name (@handle, without @). |
419
+ | `description` | `string` | Profile bio/description. |
420
+ | `created_at` | `string` | Account creation timestamp. |
421
+ | `followers_count` | `integer` | Number of followers. |
422
+ | `following_count` | `integer` | Number of accounts followed. |
423
+ | `tweet_count` | `integer` | Total number of tweets. |
424
+ | `listed_count` | `integer` | Number of public lists the user is in. |
425
+ | `verified` | `boolean` | Whether the account is legacy verified. |
426
+ | `is_blue_verified` | `boolean` | Whether the account has Twitter Blue verification. |
427
+ | `profile_image_url` | `string` | URL of the profile image. |
428
+ | `profile_banner_url` | `string` | URL of the profile banner image. |
429
+ | `location` | `string` | User-specified location. |
430
+ | `url` | `string` | User's website URL. |
431
+ | `pinned_tweet_id` | `string` | ID of the user's pinned tweet. |
297
432
 
298
433
  ---
299
434
 
300
435
  ### `sentiment.twitter_user_by_name`
301
436
 
302
437
  ```python
303
- data.sentiment.twitter_user_by_name(screen_name=..., provider='twitter')
438
+ data.sentiment.twitter_user_by_name(screen_name=...)
304
439
  ```
305
440
 
306
441
  Summary: Twitter User By Name
@@ -310,7 +445,6 @@ Summary: Twitter User By Name
310
445
  | Endpoint ID | `sentiment.twitter_user_by_name` |
311
446
  | HTTP | `GET` |
312
447
  | Path | `/inner/v1/agent-data/sentiment/twitter_user_by_name` |
313
- | Default provider | `twitter` |
314
448
  | SDK | `supported` |
315
449
  | Host | `supported` |
316
450
  | Notes | - |
@@ -320,4 +454,24 @@ Summary: Twitter User By Name
320
454
  | Param | Required | Type | Default | Notes |
321
455
  |---|---|---|---|---|
322
456
  | `screen_name` | `yes` | `string` | `-` | Twitter screen name / @handle (without @). |
323
- | `provider` | `no` | `string` | `twitter` | - |
457
+
458
+ #### Response fields
459
+
460
+ | Field | Type | Notes |
461
+ |---|---|---|
462
+ | `user_id` | `string` | Unique numeric user ID. |
463
+ | `name` | `string` | Display name. |
464
+ | `username` | `string` | Screen name (@handle, without @). |
465
+ | `description` | `string` | Profile bio/description. |
466
+ | `created_at` | `string` | Account creation timestamp. |
467
+ | `followers_count` | `integer` | Number of followers. |
468
+ | `following_count` | `integer` | Number of accounts followed. |
469
+ | `tweet_count` | `integer` | Total number of tweets. |
470
+ | `listed_count` | `integer` | Number of public lists the user is in. |
471
+ | `verified` | `boolean` | Whether the account is legacy verified. |
472
+ | `is_blue_verified` | `boolean` | Whether the account has Twitter Blue verification. |
473
+ | `profile_image_url` | `string` | URL of the profile image. |
474
+ | `profile_banner_url` | `string` | URL of the profile banner image. |
475
+ | `location` | `string` | User-specified location. |
476
+ | `url` | `string` | User's website URL. |
477
+ | `pinned_tweet_id` | `string` | ID of the user's pinned tweet. |
@@ -15,7 +15,7 @@ are callable through the DataSDK wrapper.
15
15
  ### `uscongress.bill_info`
16
16
 
17
17
  ```python
18
- data.uscongress.bill_info(bill_url=None, provider='congress_gov')
18
+ data.uscongress.bill_info(bill_url=None)
19
19
  ```
20
20
 
21
21
  Summary: Bill Info
@@ -25,7 +25,6 @@ Summary: Bill Info
25
25
  | Endpoint ID | `uscongress.bill_info` |
26
26
  | HTTP | `GET` |
27
27
  | Path | `/inner/v1/agent-data/uscongress/bill_info` |
28
- | Default provider | `congress_gov` |
29
28
  | SDK | `supported` |
30
29
  | Host | `supported` |
31
30
  | Notes | - |
@@ -34,15 +33,14 @@ Summary: Bill Info
34
33
 
35
34
  | Param | Required | Type | Default | Notes |
36
35
  |---|---|---|---|---|
37
- | `bill_url` | `no` | `string | null` | `-` | Enter a base URL of a bill (e.g., 'https://api.congress.gov/v3/bill/119/s/1947?format=json'). Alternatively, you can enter a bill number (e.g., '119/s/1947'). (provider: congress_gov) |
38
- | `provider` | `no` | `string` | `congress_gov` | - |
36
+ | `bill_url` | `no` | `string | null` | `-` | Enter a base URL of a bill (e.g., 'https://api.congress.gov/v3/bill/119/s/1947?format=json'). Alternatively, you can enter a bill number (e.g., '119/s/1947'). |
39
37
 
40
38
  ---
41
39
 
42
40
  ### `uscongress.bill_text`
43
41
 
44
42
  ```python
45
- data.uscongress.bill_text(provider='congress_gov', body=...)
43
+ data.uscongress.bill_text(, body=...)
46
44
  ```
47
45
 
48
46
  Summary: Bill Text
@@ -52,7 +50,6 @@ Summary: Bill Text
52
50
  | Endpoint ID | `uscongress.bill_text` |
53
51
  | HTTP | `POST` |
54
52
  | Path | `/inner/v1/agent-data/uscongress/bill_text` |
55
- | Default provider | `congress_gov` |
56
53
  | SDK | `supported` |
57
54
  | Host | `supported` |
58
55
  | Notes | - |
@@ -61,15 +58,14 @@ Summary: Bill Text
61
58
 
62
59
  | Param | Required | Type | Default | Notes |
63
60
  |---|---|---|---|---|
64
- | `provider` | `no` | `string` | `congress_gov` | - |
65
- | `body` | `no` | `string | array | object | null` | `-` | List of direct bill URLs to download. Multiple comma separated items allowed. (provider: congress_gov) |
61
+ | `body` | `no` | `string | array | object | null` | `-` | List of direct bill URLs to download. Multiple comma separated items allowed. |
66
62
 
67
63
  ---
68
64
 
69
65
  ### `uscongress.bill_text_urls`
70
66
 
71
67
  ```python
72
- data.uscongress.bill_text_urls(bill_url=..., is_workspace=False, provider='congress_gov')
68
+ data.uscongress.bill_text_urls(bill_url=..., is_workspace=False)
73
69
  ```
74
70
 
75
71
  Summary: Bill Text Urls
@@ -79,7 +75,6 @@ Summary: Bill Text Urls
79
75
  | Endpoint ID | `uscongress.bill_text_urls` |
80
76
  | HTTP | `GET` |
81
77
  | Path | `/inner/v1/agent-data/uscongress/bill_text_urls` |
82
- | Default provider | `congress_gov` |
83
78
  | SDK | `supported` |
84
79
  | Host | `supported` |
85
80
  | Notes | - |
@@ -90,14 +85,13 @@ Summary: Bill Text Urls
90
85
  |---|---|---|---|---|
91
86
  | `bill_url` | `yes` | `string` | `-` | - |
92
87
  | `is_workspace` | `no` | `boolean` | `false` | - |
93
- | `provider` | `no` | `string` | `congress_gov` | - |
94
88
 
95
89
  ---
96
90
 
97
91
  ### `uscongress.bills`
98
92
 
99
93
  ```python
100
- data.uscongress.bills(congress=None, bill_type=None, start_date=None, end_date=None, limit=None, offset=None, sort_by='desc', provider='congress_gov')
94
+ data.uscongress.bills(congress=None, bill_type=None, start_date=None, end_date=None, limit=None, offset=None, sort_by='desc')
101
95
  ```
102
96
 
103
97
  Summary: Bills
@@ -107,7 +101,6 @@ Summary: Bills
107
101
  | Endpoint ID | `uscongress.bills` |
108
102
  | HTTP | `GET` |
109
103
  | Path | `/inner/v1/agent-data/uscongress/bills` |
110
- | Default provider | `congress_gov` |
111
104
  | SDK | `supported` |
112
105
  | Host | `supported` |
113
106
  | Notes | - |
@@ -116,11 +109,10 @@ Summary: Bills
116
109
 
117
110
  | Param | Required | Type | Default | Notes |
118
111
  |---|---|---|---|---|
119
- | `congress` | `no` | `integer | null` | `-` | Congress number (e.g., 118 for the 118th Congress). The 103rd Congress started in 1993, which is the earliest date supporting full text versions. Each Congress spans two years, starting in odd-numbered years. (provider: congress_gov) |
120
- | `bill_type` | `no` | `string | null` | `-` | Bill type (e.g., "hr" for House bills). Must be one of: hr, s, hjres, sjres, hconres, sconres, hres, sres. Bills ----- A bill is the form used for most legislation, whether permanent or temporary, general or special, public or private. A bill originating in the House of Representatives is designated by the letters “H.R.”, signifying “House of Representatives”, followed by a number that it retains throughout all its parliamentary stages. Bills are presented to the President for action when approved in identical form by both the House of Representatives and the Senate. Joint Resolutions ----------------- Joint resolutions may originate either in the House of Representatives or in the Senate. There is little practical difference between a bill and a joint resolution. Both are subject to the same procedure, except for a joint resolution proposing an amendment to the Constitution. On approval of such a resolution by two-thirds of both the House and Senate, it is sent directly to the Administrator of General Services for submission to the individual states for ratification. It is not presented to the President for approval. A joint resolution originating in the House of Representatives is designated “H.J.Res.” followed by its individual number. Joint resolutions become law in the same manner as bills. Concurrent Resolutions ---------------------- Matters affecting the operations of both the House of Representatives and Senate are usually initiated by means of concurrent resolutions. A concurrent resolution originating in the House of Representatives is designated “H.Con.Res.” followed by its individual number. On approval by both the House of Representatives and Senate, they are signed by the Clerk of the House and the Secretary of the Senate. They are not presented to the President for action. Simple Resolutions ------------------ A matter concerning the operation of either the House of Representatives or Senate alone is initiated by a simple resolution. A resolution affecting the House of Representatives is designated “H.Res.” followed by its number. They are not presented to the President for action. (provider: congress_gov) |
121
- | `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Filters bills by the last updated date. (provider: congress_gov) |
122
- | `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Filters bills by the last updated date. (provider: congress_gov) |
123
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. When None, default sets to 100 (max 250). Set to 0 for no limit (must be used with 'bill_type' and 'congress'). Setting to 0 will nullify the start_date, end_date, and offset parameters. (provider: congress_gov) |
124
- | `offset` | `no` | `integer | null` | `-` | The starting record returned. 0 is the first record. (provider: congress_gov) |
125
- | `sort_by` | `no` | `string` | `desc` | Sort by update date. Default is latest first. (provider: congress_gov) |
126
- | `provider` | `no` | `string` | `congress_gov` | - |
112
+ | `congress` | `no` | `integer | null` | `-` | Congress number (e.g., 118 for the 118th Congress). The 103rd Congress started in 1993, which is the earliest date supporting full text versions. Each Congress spans two years, starting in odd-numbered years. |
113
+ | `bill_type` | `no` | `string | null` | `-` | Bill type (e.g., "hr" for House bills). Must be one of: hr, s, hjres, sjres, hconres, sconres, hres, sres. Bills ----- A bill is the form used for most legislation, whether permanent or temporary, general or special, public or private. A bill originating in the House of Representatives is designated by the letters “H.R.”, signifying “House of Representatives”, followed by a number that it retains throughout all its parliamentary stages. Bills are presented to the President for action when approved in identical form by both the House of Representatives and the Senate. Joint Resolutions ----------------- Joint resolutions may originate either in the House of Representatives or in the Senate. There is little practical difference between a bill and a joint resolution. Both are subject to the same procedure, except for a joint resolution proposing an amendment to the Constitution. On approval of such a resolution by two-thirds of both the House and Senate, it is sent directly to the Administrator of General Services for submission to the individual states for ratification. It is not presented to the President for approval. A joint resolution originating in the House of Representatives is designated “H.J.Res.” followed by its individual number. Joint resolutions become law in the same manner as bills. Concurrent Resolutions ---------------------- Matters affecting the operations of both the House of Representatives and Senate are usually initiated by means of concurrent resolutions. A concurrent resolution originating in the House of Representatives is designated “H.Con.Res.” followed by its individual number. On approval by both the House of Representatives and Senate, they are signed by the Clerk of the House and the Secretary of the Senate. They are not presented to the President for action. Simple Resolutions ------------------ A matter concerning the operation of either the House of Representatives or Senate alone is initiated by a simple resolution. A resolution affecting the House of Representatives is designated “H.Res.” followed by its number. They are not presented to the President for action. |
114
+ | `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Filters bills by the last updated date. |
115
+ | `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Filters bills by the last updated date. |
116
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. When None, default sets to 100 (max 250). Set to 0 for no limit (must be used with 'bill_type' and 'congress'). Setting to 0 will nullify the start_date, end_date, and offset parameters. |
117
+ | `offset` | `no` | `integer | null` | `-` | The starting record returned. 0 is the first record. |
118
+ | `sort_by` | `no` | `string` | `desc` | Sort by update date. Default is latest first. |
@@ -13,7 +13,7 @@ are callable through the DataSDK wrapper.
13
13
  ### `web_search.news`
14
14
 
15
15
  ```python
16
- data.web_search.news(query=..., max_results=10, page=1, provider='bravesearch')
16
+ data.web_search.news(query=..., max_results=10, page=1)
17
17
  ```
18
18
 
19
19
  Summary: News
@@ -23,7 +23,6 @@ Summary: News
23
23
  | Endpoint ID | `web_search.news` |
24
24
  | HTTP | `GET` |
25
25
  | Path | `/inner/v1/agent-data/web_search/news` |
26
- | Default provider | `bravesearch` |
27
26
  | SDK | `supported` |
28
27
  | Host | `supported` |
29
28
  | Notes | - |
@@ -35,14 +34,13 @@ Summary: News
35
34
  | `query` | `yes` | `string` | `-` | Search query string. |
36
35
  | `max_results` | `no` | `integer` | `10` | Maximum number of news results to return. |
37
36
  | `page` | `no` | `integer` | `1` | Page number for pagination, starting at 1. |
38
- | `provider` | `no` | `string` | `bravesearch` | - |
39
37
 
40
38
  ---
41
39
 
42
40
  ### `web_search.web`
43
41
 
44
42
  ```python
45
- data.web_search.web(query=..., max_results=10, page=1, backend='auto', provider=...)
43
+ data.web_search.web(query=..., max_results=10, page=1, backend='auto')
46
44
  ```
47
45
 
48
46
  Summary: Web
@@ -52,7 +50,6 @@ Summary: Web
52
50
  | Endpoint ID | `web_search.web` |
53
51
  | HTTP | `GET` |
54
52
  | Path | `/inner/v1/agent-data/web_search/web` |
55
- | Default provider | - |
56
53
  | SDK | `supported` |
57
54
  | Host | `supported` |
58
55
  | Notes | - |
@@ -64,5 +61,4 @@ Summary: Web
64
61
  | `query` | `yes` | `string` | `-` | Search query string. |
65
62
  | `max_results` | `no` | `integer` | `10` | Maximum number of results to return. |
66
63
  | `page` | `no` | `integer` | `1` | Page number for pagination, starting at 1. |
67
- | `backend` | `no` | `string` | `auto` | enum: auto, duckduckgo, google, bing, brave, yandex, yahoo, wikipedia, grokipedia, mojeek Search engine backend. 'auto' queries multiple engines with automatic fallback for resilience. (provider: ddgs) |
68
- | `provider` | `yes` | `string` | `-` | enum: bravesearch, ddgs |
64
+ | `backend` | `no` | `string` | `auto` | enum: auto, duckduckgo, google, bing, brave, yandex, yahoo, wikipedia, grokipedia, mojeek Search engine backend. 'auto' queries multiple engines with automatic fallback for resilience. |
@@ -14,7 +14,7 @@ are callable through the DataSDK wrapper.
14
14
  ### `wikipedia.content`
15
15
 
16
16
  ```python
17
- data.wikipedia.content(title=None, lang='en', intro_only=False, provider='wikipedia')
17
+ data.wikipedia.content(title=None, lang='en', intro_only=False)
18
18
  ```
19
19
 
20
20
  Summary: Content
@@ -24,7 +24,6 @@ Summary: Content
24
24
  | Endpoint ID | `wikipedia.content` |
25
25
  | HTTP | `GET` |
26
26
  | Path | `/inner/v1/agent-data/wikipedia/content` |
27
- | Default provider | `wikipedia` |
28
27
  | SDK | `supported` |
29
28
  | Host | `supported` |
30
29
  | Notes | - |
@@ -33,17 +32,16 @@ Summary: Content
33
32
 
34
33
  | Param | Required | Type | Default | Notes |
35
34
  |---|---|---|---|---|
36
- | `title` | `no` | `string | null` | `-` | Wikipedia article title to retrieve. (provider: wikipedia) |
37
- | `lang` | `no` | `string` | `en` | Wikipedia language edition. (provider: wikipedia) |
38
- | `intro_only` | `no` | `boolean` | `false` | Return only the introductory section instead of the full article. (provider: wikipedia) |
39
- | `provider` | `no` | `string` | `wikipedia` | - |
35
+ | `title` | `no` | `string | null` | `-` | Wikipedia article title to retrieve. |
36
+ | `lang` | `no` | `string` | `en` | Wikipedia language edition. |
37
+ | `intro_only` | `no` | `boolean` | `false` | Return only the introductory section instead of the full article. |
40
38
 
41
39
  ---
42
40
 
43
41
  ### `wikipedia.search`
44
42
 
45
43
  ```python
46
- data.wikipedia.search(query=None, max_results=10, page=1, lang='en', provider='wikipedia')
44
+ data.wikipedia.search(query=None, max_results=10, page=1, lang='en')
47
45
  ```
48
46
 
49
47
  Summary: Search
@@ -53,7 +51,6 @@ Summary: Search
53
51
  | Endpoint ID | `wikipedia.search` |
54
52
  | HTTP | `GET` |
55
53
  | Path | `/inner/v1/agent-data/wikipedia/search` |
56
- | Default provider | `wikipedia` |
57
54
  | SDK | `supported` |
58
55
  | Host | `supported` |
59
56
  | Notes | - |
@@ -62,18 +59,17 @@ Summary: Search
62
59
 
63
60
  | Param | Required | Type | Default | Notes |
64
61
  |---|---|---|---|---|
65
- | `query` | `no` | `string | null` | `-` | Search query string. (provider: wikipedia) |
66
- | `max_results` | `no` | `integer` | `10` | Maximum number of results. (provider: wikipedia) |
67
- | `page` | `no` | `integer` | `1` | Page number, starting at 1. (provider: wikipedia) |
68
- | `lang` | `no` | `string` | `en` | Wikipedia language edition. (provider: wikipedia) |
69
- | `provider` | `no` | `string` | `wikipedia` | - |
62
+ | `query` | `no` | `string | null` | `-` | Search query string. |
63
+ | `max_results` | `no` | `integer` | `10` | Maximum number of results. |
64
+ | `page` | `no` | `integer` | `1` | Page number, starting at 1. |
65
+ | `lang` | `no` | `string` | `en` | Wikipedia language edition. |
70
66
 
71
67
  ---
72
68
 
73
69
  ### `wikipedia.summary`
74
70
 
75
71
  ```python
76
- data.wikipedia.summary(title=None, lang='en', provider='wikipedia')
72
+ data.wikipedia.summary(title=None, lang='en')
77
73
  ```
78
74
 
79
75
  Summary: Summary
@@ -83,7 +79,6 @@ Summary: Summary
83
79
  | Endpoint ID | `wikipedia.summary` |
84
80
  | HTTP | `GET` |
85
81
  | Path | `/inner/v1/agent-data/wikipedia/summary` |
86
- | Default provider | `wikipedia` |
87
82
  | SDK | `supported` |
88
83
  | Host | `supported` |
89
84
  | Notes | - |
@@ -92,6 +87,5 @@ Summary: Summary
92
87
 
93
88
  | Param | Required | Type | Default | Notes |
94
89
  |---|---|---|---|---|
95
- | `title` | `no` | `string | null` | `-` | Wikipedia article title to retrieve. (provider: wikipedia) |
96
- | `lang` | `no` | `string` | `en` | Wikipedia language edition. (provider: wikipedia) |
97
- | `provider` | `no` | `string` | `wikipedia` | - |
90
+ | `title` | `no` | `string | null` | `-` | Wikipedia article title to retrieve. |
91
+ | `lang` | `no` | `string` | `en` | Wikipedia language edition. |