x-twitter-scraper 0.8.4 → 0.11.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 (147) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +1 -3
  3. package/package.json +1 -1
  4. package/resources/credits.d.mts +5 -5
  5. package/resources/credits.d.ts +5 -5
  6. package/resources/credits.js +2 -2
  7. package/resources/credits.mjs +2 -2
  8. package/resources/draws.d.mts +3 -2
  9. package/resources/draws.d.mts.map +1 -1
  10. package/resources/draws.d.ts +3 -2
  11. package/resources/draws.d.ts.map +1 -1
  12. package/resources/events.d.mts +6 -2
  13. package/resources/events.d.mts.map +1 -1
  14. package/resources/events.d.ts +6 -2
  15. package/resources/events.d.ts.map +1 -1
  16. package/resources/extractions.d.mts +672 -91
  17. package/resources/extractions.d.mts.map +1 -1
  18. package/resources/extractions.d.ts +672 -91
  19. package/resources/extractions.d.ts.map +1 -1
  20. package/resources/extractions.js +3 -2
  21. package/resources/extractions.js.map +1 -1
  22. package/resources/extractions.mjs +3 -2
  23. package/resources/extractions.mjs.map +1 -1
  24. package/resources/guest-wallets.d.mts +20 -18
  25. package/resources/guest-wallets.d.mts.map +1 -1
  26. package/resources/guest-wallets.d.ts +20 -18
  27. package/resources/guest-wallets.d.ts.map +1 -1
  28. package/resources/guest-wallets.js +9 -13
  29. package/resources/guest-wallets.js.map +1 -1
  30. package/resources/guest-wallets.mjs +9 -13
  31. package/resources/guest-wallets.mjs.map +1 -1
  32. package/resources/monitors/monitors.d.mts +8 -0
  33. package/resources/monitors/monitors.d.mts.map +1 -1
  34. package/resources/monitors/monitors.d.ts +8 -0
  35. package/resources/monitors/monitors.d.ts.map +1 -1
  36. package/resources/monitors/monitors.js.map +1 -1
  37. package/resources/monitors/monitors.mjs.map +1 -1
  38. package/resources/shared.d.mts +11 -11
  39. package/resources/shared.d.mts.map +1 -1
  40. package/resources/shared.d.ts +11 -11
  41. package/resources/shared.d.ts.map +1 -1
  42. package/resources/support/attachments.d.mts +33 -0
  43. package/resources/support/attachments.d.mts.map +1 -0
  44. package/resources/support/attachments.d.ts +33 -0
  45. package/resources/support/attachments.d.ts.map +1 -0
  46. package/resources/support/attachments.js +42 -0
  47. package/resources/support/attachments.js.map +1 -0
  48. package/resources/support/attachments.mjs +38 -0
  49. package/resources/support/attachments.mjs.map +1 -0
  50. package/resources/support/index.d.mts +1 -0
  51. package/resources/support/index.d.mts.map +1 -1
  52. package/resources/support/index.d.ts +1 -0
  53. package/resources/support/index.d.ts.map +1 -1
  54. package/resources/support/index.js +3 -1
  55. package/resources/support/index.js.map +1 -1
  56. package/resources/support/index.mjs +1 -0
  57. package/resources/support/index.mjs.map +1 -1
  58. package/resources/support/support.d.mts +4 -0
  59. package/resources/support/support.d.mts.map +1 -1
  60. package/resources/support/support.d.ts +4 -0
  61. package/resources/support/support.d.ts.map +1 -1
  62. package/resources/support/support.js +4 -0
  63. package/resources/support/support.js.map +1 -1
  64. package/resources/support/support.mjs +4 -0
  65. package/resources/support/support.mjs.map +1 -1
  66. package/resources/x/accounts.d.mts +3 -5
  67. package/resources/x/accounts.d.mts.map +1 -1
  68. package/resources/x/accounts.d.ts +3 -5
  69. package/resources/x/accounts.d.ts.map +1 -1
  70. package/resources/x/communities/communities.d.mts +112 -0
  71. package/resources/x/communities/communities.d.mts.map +1 -1
  72. package/resources/x/communities/communities.d.ts +112 -0
  73. package/resources/x/communities/communities.d.ts.map +1 -1
  74. package/resources/x/communities/communities.js.map +1 -1
  75. package/resources/x/communities/communities.mjs.map +1 -1
  76. package/resources/x/index.d.mts +2 -2
  77. package/resources/x/index.d.mts.map +1 -1
  78. package/resources/x/index.d.ts +2 -2
  79. package/resources/x/index.d.ts.map +1 -1
  80. package/resources/x/index.js.map +1 -1
  81. package/resources/x/index.mjs.map +1 -1
  82. package/resources/x/lists.d.mts +115 -4
  83. package/resources/x/lists.d.mts.map +1 -1
  84. package/resources/x/lists.d.ts +115 -4
  85. package/resources/x/lists.d.ts.map +1 -1
  86. package/resources/x/tweets/index.d.mts +1 -1
  87. package/resources/x/tweets/index.d.mts.map +1 -1
  88. package/resources/x/tweets/index.d.ts +1 -1
  89. package/resources/x/tweets/index.d.ts.map +1 -1
  90. package/resources/x/tweets/index.js.map +1 -1
  91. package/resources/x/tweets/index.mjs.map +1 -1
  92. package/resources/x/tweets/tweets.d.mts +482 -38
  93. package/resources/x/tweets/tweets.d.mts.map +1 -1
  94. package/resources/x/tweets/tweets.d.ts +482 -38
  95. package/resources/x/tweets/tweets.d.ts.map +1 -1
  96. package/resources/x/tweets/tweets.js +5 -8
  97. package/resources/x/tweets/tweets.js.map +1 -1
  98. package/resources/x/tweets/tweets.mjs +5 -8
  99. package/resources/x/tweets/tweets.mjs.map +1 -1
  100. package/resources/x/users/index.d.mts +1 -1
  101. package/resources/x/users/index.d.mts.map +1 -1
  102. package/resources/x/users/index.d.ts +1 -1
  103. package/resources/x/users/index.d.ts.map +1 -1
  104. package/resources/x/users/index.js.map +1 -1
  105. package/resources/x/users/index.mjs.map +1 -1
  106. package/resources/x/users/users.d.mts +910 -40
  107. package/resources/x/users/users.d.mts.map +1 -1
  108. package/resources/x/users/users.d.ts +910 -40
  109. package/resources/x/users/users.d.ts.map +1 -1
  110. package/resources/x/users/users.js +12 -7
  111. package/resources/x/users/users.js.map +1 -1
  112. package/resources/x/users/users.mjs +12 -7
  113. package/resources/x/users/users.mjs.map +1 -1
  114. package/resources/x/x.d.mts +4 -4
  115. package/resources/x/x.d.mts.map +1 -1
  116. package/resources/x/x.d.ts +4 -4
  117. package/resources/x/x.d.ts.map +1 -1
  118. package/resources/x/x.js.map +1 -1
  119. package/resources/x/x.mjs.map +1 -1
  120. package/src/resources/credits.ts +5 -5
  121. package/src/resources/draws.ts +3 -2
  122. package/src/resources/events.ts +7 -2
  123. package/src/resources/extractions.ts +929 -185
  124. package/src/resources/guest-wallets.ts +20 -18
  125. package/src/resources/monitors/monitors.ts +10 -0
  126. package/src/resources/shared.ts +17 -9
  127. package/src/resources/support/attachments.ts +57 -0
  128. package/src/resources/support/index.ts +1 -0
  129. package/src/resources/support/support.ts +6 -0
  130. package/src/resources/x/accounts.ts +3 -5
  131. package/src/resources/x/communities/communities.ts +140 -0
  132. package/src/resources/x/index.ts +4 -0
  133. package/src/resources/x/lists.ts +143 -4
  134. package/src/resources/x/tweets/index.ts +1 -0
  135. package/src/resources/x/tweets/tweets.ts +610 -37
  136. package/src/resources/x/users/index.ts +3 -0
  137. package/src/resources/x/users/users.ts +1363 -221
  138. package/src/resources/x/x.ts +8 -0
  139. package/src/version.ts +1 -1
  140. package/version.d.mts +1 -1
  141. package/version.d.mts.map +1 -1
  142. package/version.d.ts +1 -1
  143. package/version.d.ts.map +1 -1
  144. package/version.js +1 -1
  145. package/version.js.map +1 -1
  146. package/version.mjs +1 -1
  147. package/version.mjs.map +1 -1
@@ -43,11 +43,12 @@ export declare class Users extends APIResource {
43
43
  *
44
44
  * @example
45
45
  * ```ts
46
- * const paginatedUsers =
47
- * await client.x.users.retrieveFollowers('id');
46
+ * const response = await client.x.users.retrieveFollowers(
47
+ * 'id',
48
+ * );
48
49
  * ```
49
50
  */
50
- retrieveFollowers(id: string, query?: UserRetrieveFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
51
+ retrieveFollowers(id: string, query?: UserRetrieveFollowersParams | null | undefined, options?: RequestOptions): APIPromise<UserRetrieveFollowersResponse>;
51
52
  /**
52
53
  * List mutual followers between you and a user
53
54
  *
@@ -63,11 +64,12 @@ export declare class Users extends APIResource {
63
64
  *
64
65
  * @example
65
66
  * ```ts
66
- * const paginatedUsers =
67
- * await client.x.users.retrieveFollowing('id');
67
+ * const response = await client.x.users.retrieveFollowing(
68
+ * 'id',
69
+ * );
68
70
  * ```
69
71
  */
70
- retrieveFollowing(id: string, query?: UserRetrieveFollowingParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
72
+ retrieveFollowing(id: string, query?: UserRetrieveFollowingParams | null | undefined, options?: RequestOptions): APIPromise<UserRetrieveFollowingResponse>;
71
73
  /**
72
74
  * List tweets liked by a user
73
75
  *
@@ -101,7 +103,9 @@ export declare class Users extends APIResource {
101
103
  */
102
104
  retrieveMentions(id: string, query?: UserRetrieveMentionsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
103
105
  /**
104
- * Returns the user's timeline with replies included by default.
106
+ * Returns target-authored posts and replies. Omit mode for automatic maximum
107
+ * coverage. Pass next_cursor unchanged. Unprefixed cursors stay legacy. Excludes
108
+ * other-author context.
105
109
  *
106
110
  * @example
107
111
  * ```ts
@@ -122,7 +126,8 @@ export declare class Users extends APIResource {
122
126
  */
123
127
  retrieveSearch(query: UserRetrieveSearchParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
124
128
  /**
125
- * List recent tweets posted by a user
129
+ * Omit mode for automatic maximum coverage. Pass next_cursor unchanged. Unprefixed
130
+ * cursors use legacy pagination. Shape and billing stay the same.
126
131
  *
127
132
  * @example
128
133
  * ```ts
@@ -137,11 +142,11 @@ export declare class Users extends APIResource {
137
142
  *
138
143
  * @example
139
144
  * ```ts
140
- * const paginatedUsers =
145
+ * const response =
141
146
  * await client.x.users.retrieveVerifiedFollowers('id');
142
147
  * ```
143
148
  */
144
- retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
149
+ retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<UserRetrieveVerifiedFollowersResponse>;
145
150
  }
146
151
  /**
147
152
  * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
@@ -352,6 +357,189 @@ export interface UserRetrieveBatchResponse {
352
357
  unprocessed_ids: Array<string>;
353
358
  users: Array<Shared.UserProfile>;
354
359
  }
360
+ /**
361
+ * Paginated user profiles. No-mode follower, following, and verified follower
362
+ * requests merge independent views automatically. Response fields, page size,
363
+ * aliases, filters, and per-returned-profile billing stay unchanged. Existing
364
+ * unprefixed cursors retain legacy behavior. Follow next_cursor while
365
+ * has_next_page is true.
366
+ */
367
+ export type UserRetrieveFollowersResponse = Shared.PaginatedUsers | UserRetrieveFollowersResponse.UserListCoverageResponse;
368
+ export declare namespace UserRetrieveFollowersResponse {
369
+ /**
370
+ * Paginated user profiles. No-mode follower, following, and verified follower
371
+ * requests merge independent views automatically. Response fields, page size,
372
+ * aliases, filters, and per-returned-profile billing stay unchanged. Existing
373
+ * unprefixed cursors retain legacy behavior. Follow next_cursor while
374
+ * has_next_page is true.
375
+ */
376
+ interface UserListCoverageResponse extends Omit<Shared.PaginatedUsers, 'has_next_page' | 'next_cursor'> {
377
+ /**
378
+ * Coverage evidence across parallel relationship strategies.
379
+ */
380
+ diagnostic: UserListCoverageResponse.Diagnostic;
381
+ has_next_page?: false;
382
+ next_cursor?: '';
383
+ }
384
+ namespace UserListCoverageResponse {
385
+ /**
386
+ * Coverage evidence across parallel relationship strategies.
387
+ */
388
+ interface Diagnostic {
389
+ /**
390
+ * True when every strategy exhausted its source.
391
+ */
392
+ complete: boolean;
393
+ cursorFailureCount: number;
394
+ deadlineReached: boolean;
395
+ duplicateCount: number;
396
+ failedStrategyCount: number;
397
+ malformedCount: number;
398
+ pagesFetched: number;
399
+ /**
400
+ * Whether credits or the requested limit reduced output.
401
+ */
402
+ responseTruncated: boolean;
403
+ resultLimitReached: boolean;
404
+ returnedUsers: number;
405
+ stalledStrategyCount: number;
406
+ strategies: Array<Diagnostic.Strategy>;
407
+ strategyCount: number;
408
+ uniqueUsers: number;
409
+ }
410
+ namespace Diagnostic {
411
+ interface Strategy {
412
+ duplicateCount: number;
413
+ pagesFetched: number;
414
+ stopReason: 'cursor_failure' | 'deadline' | 'exhausted' | 'failed' | 'page_limit' | 'result_limit' | 'stalled';
415
+ strategy: number;
416
+ uniqueAdded: number;
417
+ }
418
+ }
419
+ }
420
+ }
421
+ /**
422
+ * Paginated user profiles. No-mode follower, following, and verified follower
423
+ * requests merge independent views automatically. Response fields, page size,
424
+ * aliases, filters, and per-returned-profile billing stay unchanged. Existing
425
+ * unprefixed cursors retain legacy behavior. Follow next_cursor while
426
+ * has_next_page is true.
427
+ */
428
+ export type UserRetrieveFollowingResponse = Shared.PaginatedUsers | UserRetrieveFollowingResponse.UserListCoverageResponse;
429
+ export declare namespace UserRetrieveFollowingResponse {
430
+ /**
431
+ * Paginated user profiles. No-mode follower, following, and verified follower
432
+ * requests merge independent views automatically. Response fields, page size,
433
+ * aliases, filters, and per-returned-profile billing stay unchanged. Existing
434
+ * unprefixed cursors retain legacy behavior. Follow next_cursor while
435
+ * has_next_page is true.
436
+ */
437
+ interface UserListCoverageResponse extends Omit<Shared.PaginatedUsers, 'has_next_page' | 'next_cursor'> {
438
+ /**
439
+ * Coverage evidence across parallel relationship strategies.
440
+ */
441
+ diagnostic: UserListCoverageResponse.Diagnostic;
442
+ has_next_page?: false;
443
+ next_cursor?: '';
444
+ }
445
+ namespace UserListCoverageResponse {
446
+ /**
447
+ * Coverage evidence across parallel relationship strategies.
448
+ */
449
+ interface Diagnostic {
450
+ /**
451
+ * True when every strategy exhausted its source.
452
+ */
453
+ complete: boolean;
454
+ cursorFailureCount: number;
455
+ deadlineReached: boolean;
456
+ duplicateCount: number;
457
+ failedStrategyCount: number;
458
+ malformedCount: number;
459
+ pagesFetched: number;
460
+ /**
461
+ * Whether credits or the requested limit reduced output.
462
+ */
463
+ responseTruncated: boolean;
464
+ resultLimitReached: boolean;
465
+ returnedUsers: number;
466
+ stalledStrategyCount: number;
467
+ strategies: Array<Diagnostic.Strategy>;
468
+ strategyCount: number;
469
+ uniqueUsers: number;
470
+ }
471
+ namespace Diagnostic {
472
+ interface Strategy {
473
+ duplicateCount: number;
474
+ pagesFetched: number;
475
+ stopReason: 'cursor_failure' | 'deadline' | 'exhausted' | 'failed' | 'page_limit' | 'result_limit' | 'stalled';
476
+ strategy: number;
477
+ uniqueAdded: number;
478
+ }
479
+ }
480
+ }
481
+ }
482
+ /**
483
+ * Paginated user profiles. No-mode follower, following, and verified follower
484
+ * requests merge independent views automatically. Response fields, page size,
485
+ * aliases, filters, and per-returned-profile billing stay unchanged. Existing
486
+ * unprefixed cursors retain legacy behavior. Follow next_cursor while
487
+ * has_next_page is true.
488
+ */
489
+ export type UserRetrieveVerifiedFollowersResponse = Shared.PaginatedUsers | UserRetrieveVerifiedFollowersResponse.UserListCoverageResponse;
490
+ export declare namespace UserRetrieveVerifiedFollowersResponse {
491
+ /**
492
+ * Paginated user profiles. No-mode follower, following, and verified follower
493
+ * requests merge independent views automatically. Response fields, page size,
494
+ * aliases, filters, and per-returned-profile billing stay unchanged. Existing
495
+ * unprefixed cursors retain legacy behavior. Follow next_cursor while
496
+ * has_next_page is true.
497
+ */
498
+ interface UserListCoverageResponse extends Omit<Shared.PaginatedUsers, 'has_next_page' | 'next_cursor'> {
499
+ /**
500
+ * Coverage evidence across parallel relationship strategies.
501
+ */
502
+ diagnostic: UserListCoverageResponse.Diagnostic;
503
+ has_next_page?: false;
504
+ next_cursor?: '';
505
+ }
506
+ namespace UserListCoverageResponse {
507
+ /**
508
+ * Coverage evidence across parallel relationship strategies.
509
+ */
510
+ interface Diagnostic {
511
+ /**
512
+ * True when every strategy exhausted its source.
513
+ */
514
+ complete: boolean;
515
+ cursorFailureCount: number;
516
+ deadlineReached: boolean;
517
+ duplicateCount: number;
518
+ failedStrategyCount: number;
519
+ malformedCount: number;
520
+ pagesFetched: number;
521
+ /**
522
+ * Whether credits or the requested limit reduced output.
523
+ */
524
+ responseTruncated: boolean;
525
+ resultLimitReached: boolean;
526
+ returnedUsers: number;
527
+ stalledStrategyCount: number;
528
+ strategies: Array<Diagnostic.Strategy>;
529
+ strategyCount: number;
530
+ uniqueUsers: number;
531
+ }
532
+ namespace Diagnostic {
533
+ interface Strategy {
534
+ duplicateCount: number;
535
+ pagesFetched: number;
536
+ stopReason: 'cursor_failure' | 'deadline' | 'exhausted' | 'failed' | 'page_limit' | 'result_limit' | 'stalled';
537
+ strategy: number;
538
+ uniqueAdded: number;
539
+ }
540
+ }
541
+ }
542
+ }
355
543
  export interface UserRemoveFollowerParams {
356
544
  /**
357
545
  * Body param: X account identifier (@username or account ID)
@@ -378,33 +566,149 @@ export interface UserRetrieveFollowersParams {
378
566
  */
379
567
  after?: string;
380
568
  /**
381
- * Pagination cursor for followers list
569
+ * Match any comma-separated or line-separated bio term, ignoring case.
570
+ */
571
+ bioContains?: string;
572
+ /**
573
+ * Cursor from the previous response. Xquik cursors resume automatic coverage.
574
+ * Existing unprefixed cursors keep legacy standard behavior.
382
575
  */
383
576
  cursor?: string;
384
577
  /**
385
- * Legacy integer page size alias for following lists. Prefer pageSize.
578
+ * Only return profiles with a location.
579
+ */
580
+ hasLocation?: boolean;
581
+ /**
582
+ * Only return profiles with a website.
583
+ */
584
+ hasWebsite?: boolean;
585
+ /**
586
+ * Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
587
+ * Prefer pageSize.
386
588
  */
387
589
  limit?: number;
388
590
  /**
389
- * Maximum user profiles requested from this page (20-200, default 200). The
390
- * response can contain fewer profiles because the source returned fewer or
391
- * the available usage balance covers fewer results. Keep requesting next_cursor while
392
- * has_next_page is true. The deprecated limit and count aliases remain accepted.
591
+ * Match a location substring, ignoring case.
592
+ */
593
+ locationContains?: string;
594
+ /**
595
+ * Maximum follower count. Missing counts pass this maximum.
596
+ */
597
+ maxFollowers?: number;
598
+ /**
599
+ * Maximum following count.
600
+ */
601
+ maxFollowing?: number;
602
+ /**
603
+ * Maximum post count. maxPosts is also accepted.
604
+ */
605
+ maxStatuses?: number;
606
+ /**
607
+ * Minimum account age in whole days.
608
+ */
609
+ minAccountAgeDays?: number;
610
+ /**
611
+ * Minimum follower count. Filtering happens before billing.
612
+ */
613
+ minFollowers?: number;
614
+ /**
615
+ * Minimum following count.
616
+ */
617
+ minFollowing?: number;
618
+ /**
619
+ * Minimum post count. minPosts is also accepted.
620
+ */
621
+ minStatuses?: number;
622
+ /**
623
+ * Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
624
+ * Coverage returns diagnostics once and rejects cursors.
625
+ */
626
+ mode?: 'standard' | 'coverage';
627
+ /**
628
+ * Maximum user profiles: automatic 300; standard 200. Sources return fewer
629
+ * profiles. Continue with has_next_page.
393
630
  */
394
631
  pageSize?: number;
632
+ /**
633
+ * Match a username substring, ignoring case.
634
+ */
635
+ usernameContains?: string;
636
+ /**
637
+ * Only return verified profiles.
638
+ */
639
+ verifiedOnly?: boolean;
640
+ /**
641
+ * Match the verification type exactly, ignoring case.
642
+ */
643
+ verifiedType?: string;
395
644
  }
396
645
  export interface UserRetrieveFollowersYouKnowParams {
646
+ /**
647
+ * Match any comma-separated or line-separated bio term, ignoring case.
648
+ */
649
+ bioContains?: string;
397
650
  /**
398
651
  * Pagination cursor for followers-you-know
399
652
  */
400
653
  cursor?: string;
401
654
  /**
402
- * Maximum user profiles requested from this page (20-200, default 200). The
403
- * response can contain fewer profiles because the source returned fewer or
404
- * the available usage balance covers fewer results. Keep requesting next_cursor while
405
- * has_next_page is true. The deprecated limit and count aliases remain accepted.
655
+ * Only return profiles with a location.
656
+ */
657
+ hasLocation?: boolean;
658
+ /**
659
+ * Only return profiles with a website.
660
+ */
661
+ hasWebsite?: boolean;
662
+ /**
663
+ * Match a location substring, ignoring case.
664
+ */
665
+ locationContains?: string;
666
+ /**
667
+ * Maximum follower count. Missing counts pass this maximum.
668
+ */
669
+ maxFollowers?: number;
670
+ /**
671
+ * Maximum following count.
672
+ */
673
+ maxFollowing?: number;
674
+ /**
675
+ * Maximum post count. maxPosts is also accepted.
676
+ */
677
+ maxStatuses?: number;
678
+ /**
679
+ * Minimum account age in whole days.
680
+ */
681
+ minAccountAgeDays?: number;
682
+ /**
683
+ * Minimum follower count. Filtering happens before billing.
684
+ */
685
+ minFollowers?: number;
686
+ /**
687
+ * Minimum following count.
688
+ */
689
+ minFollowing?: number;
690
+ /**
691
+ * Minimum post count. minPosts is also accepted.
692
+ */
693
+ minStatuses?: number;
694
+ /**
695
+ * Maximum user profiles requested from this page (20-200, default 200). Source,
696
+ * filters, or credits can return fewer profiles. Keep requesting next_cursor while
697
+ * has_next_page is true. Deprecated aliases remain accepted.
406
698
  */
407
699
  pageSize?: number;
700
+ /**
701
+ * Match a username substring, ignoring case.
702
+ */
703
+ usernameContains?: string;
704
+ /**
705
+ * Only return verified profiles.
706
+ */
707
+ verifiedOnly?: boolean;
708
+ /**
709
+ * Match the verification type exactly, ignoring case.
710
+ */
711
+ verifiedType?: string;
408
712
  }
409
713
  export interface UserRetrieveFollowingParams {
410
714
  /**
@@ -412,20 +716,81 @@ export interface UserRetrieveFollowingParams {
412
716
  */
413
717
  after?: string;
414
718
  /**
415
- * Pagination cursor for following list
719
+ * Match any comma-separated or line-separated bio term, ignoring case.
720
+ */
721
+ bioContains?: string;
722
+ /**
723
+ * Cursor from the previous response. Xquik cursors resume automatic coverage.
724
+ * Existing unprefixed cursors keep legacy standard behavior.
416
725
  */
417
726
  cursor?: string;
418
727
  /**
419
- * Legacy page size alias. Prefer pageSize.
728
+ * Only return profiles with a location.
729
+ */
730
+ hasLocation?: boolean;
731
+ /**
732
+ * Only return profiles with a website.
733
+ */
734
+ hasWebsite?: boolean;
735
+ /**
736
+ * Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
737
+ * Prefer pageSize.
420
738
  */
421
739
  limit?: number;
422
740
  /**
423
- * Maximum user profiles requested from this page (20-200, default 200). The
424
- * response can contain fewer profiles because the source returned fewer or
425
- * the available usage balance covers fewer results. Keep requesting next_cursor while
426
- * has_next_page is true. The deprecated limit and count aliases remain accepted.
741
+ * Match a location substring, ignoring case.
742
+ */
743
+ locationContains?: string;
744
+ /**
745
+ * Maximum follower count. Missing counts pass this maximum.
746
+ */
747
+ maxFollowers?: number;
748
+ /**
749
+ * Maximum following count.
750
+ */
751
+ maxFollowing?: number;
752
+ /**
753
+ * Maximum post count. maxPosts is also accepted.
754
+ */
755
+ maxStatuses?: number;
756
+ /**
757
+ * Minimum account age in whole days.
758
+ */
759
+ minAccountAgeDays?: number;
760
+ /**
761
+ * Minimum follower count. Filtering happens before billing.
762
+ */
763
+ minFollowers?: number;
764
+ /**
765
+ * Minimum following count.
766
+ */
767
+ minFollowing?: number;
768
+ /**
769
+ * Minimum post count. minPosts is also accepted.
770
+ */
771
+ minStatuses?: number;
772
+ /**
773
+ * Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
774
+ * Coverage returns diagnostics once and rejects cursors.
775
+ */
776
+ mode?: 'standard' | 'coverage';
777
+ /**
778
+ * Maximum user profiles: automatic 300; standard 200. Sources return fewer
779
+ * profiles. Continue with has_next_page.
427
780
  */
428
781
  pageSize?: number;
782
+ /**
783
+ * Match a username substring, ignoring case.
784
+ */
785
+ usernameContains?: string;
786
+ /**
787
+ * Only return verified profiles.
788
+ */
789
+ verifiedOnly?: boolean;
790
+ /**
791
+ * Match the verification type exactly, ignoring case.
792
+ */
793
+ verifiedType?: string;
429
794
  }
430
795
  export interface UserRetrieveLikesParams {
431
796
  /**
@@ -433,6 +798,14 @@ export interface UserRetrieveLikesParams {
433
798
  * or lines.
434
799
  */
435
800
  anyWords?: string;
801
+ /**
802
+ * Only return tweets from Blue-verified authors.
803
+ */
804
+ blueVerifiedOnly?: boolean;
805
+ /**
806
+ * Match the Tweet card name.
807
+ */
808
+ cardName?: string;
436
809
  /**
437
810
  * Cashtags separated by spaces, commas, or lines.
438
811
  */
@@ -449,6 +822,10 @@ export interface UserRetrieveLikesParams {
449
822
  * Exact phrase to match.
450
823
  */
451
824
  exactPhrase?: string;
825
+ /**
826
+ * Exclude a source application.
827
+ */
828
+ excludeSource?: string;
452
829
  /**
453
830
  * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
454
831
  */
@@ -457,6 +834,10 @@ export interface UserRetrieveLikesParams {
457
834
  * Filter by author username.
458
835
  */
459
836
  fromUser?: string;
837
+ /**
838
+ * Match latitude, longitude, and radius.
839
+ */
840
+ geocode?: string;
460
841
  /**
461
842
  * Hashtags separated by spaces, commas, or lines.
462
843
  */
@@ -469,6 +850,26 @@ export interface UserRetrieveLikesParams {
469
850
  * Language code filter, e.g. en or tr.
470
851
  */
471
852
  language?: string;
853
+ /**
854
+ * Maximum likes threshold. maxLikes is also accepted.
855
+ */
856
+ maxFaves?: number;
857
+ /**
858
+ * Return Tweets older than this Tweet ID.
859
+ */
860
+ maxId?: string;
861
+ /**
862
+ * Maximum quotes threshold.
863
+ */
864
+ maxQuotes?: number;
865
+ /**
866
+ * Maximum replies threshold.
867
+ */
868
+ maxReplies?: number;
869
+ /**
870
+ * Maximum retweets threshold.
871
+ */
872
+ maxRetweets?: number;
472
873
  /**
473
874
  * Filter by media type.
474
875
  */
@@ -477,6 +878,10 @@ export interface UserRetrieveLikesParams {
477
878
  * Filter tweets mentioning a username.
478
879
  */
479
880
  mentioning?: string;
881
+ /**
882
+ * Minimum bookmark count threshold.
883
+ */
884
+ minBookmarks?: number;
480
885
  /**
481
886
  * Minimum likes threshold.
482
887
  */
@@ -493,6 +898,22 @@ export interface UserRetrieveLikesParams {
493
898
  * Minimum retweets threshold.
494
899
  */
495
900
  minRetweets?: number;
901
+ /**
902
+ * Minimum view count threshold.
903
+ */
904
+ minViews?: number;
905
+ /**
906
+ * Only return native reposts.
907
+ */
908
+ nativeRetweets?: boolean;
909
+ /**
910
+ * Match a place name.
911
+ */
912
+ near?: string;
913
+ /**
914
+ * Only return news results.
915
+ */
916
+ news?: boolean;
496
917
  /**
497
918
  * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
498
919
  * results. Continue while has_next_page is true. Deprecated limit and count
@@ -519,10 +940,22 @@ export interface UserRetrieveLikesParams {
519
940
  * Only retweets of this tweet ID.
520
941
  */
521
942
  retweetsOfTweetId?: string;
943
+ /**
944
+ * Enable the safe-search filter.
945
+ */
946
+ safe?: boolean;
522
947
  /**
523
948
  * Start date in YYYY-MM-DD format.
524
949
  */
525
950
  sinceDate?: string;
951
+ /**
952
+ * Return Tweets newer than this Tweet ID.
953
+ */
954
+ sinceId?: string;
955
+ /**
956
+ * Match the source application.
957
+ */
958
+ source?: string;
526
959
  /**
527
960
  * Filter replies sent to a username.
528
961
  */
@@ -539,6 +972,14 @@ export interface UserRetrieveLikesParams {
539
972
  * Only return tweets from verified authors.
540
973
  */
541
974
  verifiedOnly?: boolean;
975
+ /**
976
+ * Set the radius for the near filter.
977
+ */
978
+ within?: string;
979
+ /**
980
+ * Match Tweets inside a recent time window.
981
+ */
982
+ withinTime?: string;
542
983
  }
543
984
  export interface UserRetrieveMediaParams {
544
985
  /**
@@ -546,6 +987,14 @@ export interface UserRetrieveMediaParams {
546
987
  * or lines.
547
988
  */
548
989
  anyWords?: string;
990
+ /**
991
+ * Only return tweets from Blue-verified authors.
992
+ */
993
+ blueVerifiedOnly?: boolean;
994
+ /**
995
+ * Match the Tweet card name.
996
+ */
997
+ cardName?: string;
549
998
  /**
550
999
  * Cashtags separated by spaces, commas, or lines.
551
1000
  */
@@ -562,6 +1011,10 @@ export interface UserRetrieveMediaParams {
562
1011
  * Exact phrase to match.
563
1012
  */
564
1013
  exactPhrase?: string;
1014
+ /**
1015
+ * Exclude a source application.
1016
+ */
1017
+ excludeSource?: string;
565
1018
  /**
566
1019
  * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
567
1020
  */
@@ -570,6 +1023,10 @@ export interface UserRetrieveMediaParams {
570
1023
  * Filter by author username.
571
1024
  */
572
1025
  fromUser?: string;
1026
+ /**
1027
+ * Match latitude, longitude, and radius.
1028
+ */
1029
+ geocode?: string;
573
1030
  /**
574
1031
  * Hashtags separated by spaces, commas, or lines.
575
1032
  */
@@ -582,6 +1039,26 @@ export interface UserRetrieveMediaParams {
582
1039
  * Language code filter, e.g. en or tr.
583
1040
  */
584
1041
  language?: string;
1042
+ /**
1043
+ * Maximum likes threshold. maxLikes is also accepted.
1044
+ */
1045
+ maxFaves?: number;
1046
+ /**
1047
+ * Return Tweets older than this Tweet ID.
1048
+ */
1049
+ maxId?: string;
1050
+ /**
1051
+ * Maximum quotes threshold.
1052
+ */
1053
+ maxQuotes?: number;
1054
+ /**
1055
+ * Maximum replies threshold.
1056
+ */
1057
+ maxReplies?: number;
1058
+ /**
1059
+ * Maximum retweets threshold.
1060
+ */
1061
+ maxRetweets?: number;
585
1062
  /**
586
1063
  * Filter by media type.
587
1064
  */
@@ -590,6 +1067,10 @@ export interface UserRetrieveMediaParams {
590
1067
  * Filter tweets mentioning a username.
591
1068
  */
592
1069
  mentioning?: string;
1070
+ /**
1071
+ * Minimum bookmark count threshold.
1072
+ */
1073
+ minBookmarks?: number;
593
1074
  /**
594
1075
  * Minimum likes threshold.
595
1076
  */
@@ -606,6 +1087,22 @@ export interface UserRetrieveMediaParams {
606
1087
  * Minimum retweets threshold.
607
1088
  */
608
1089
  minRetweets?: number;
1090
+ /**
1091
+ * Minimum view count threshold.
1092
+ */
1093
+ minViews?: number;
1094
+ /**
1095
+ * Only return native reposts.
1096
+ */
1097
+ nativeRetweets?: boolean;
1098
+ /**
1099
+ * Match a place name.
1100
+ */
1101
+ near?: string;
1102
+ /**
1103
+ * Only return news results.
1104
+ */
1105
+ news?: boolean;
609
1106
  /**
610
1107
  * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
611
1108
  * results. Continue while has_next_page is true. Deprecated limit and count
@@ -632,10 +1129,22 @@ export interface UserRetrieveMediaParams {
632
1129
  * Only retweets of this tweet ID.
633
1130
  */
634
1131
  retweetsOfTweetId?: string;
1132
+ /**
1133
+ * Enable the safe-search filter.
1134
+ */
1135
+ safe?: boolean;
635
1136
  /**
636
1137
  * Start date in YYYY-MM-DD format.
637
1138
  */
638
1139
  sinceDate?: string;
1140
+ /**
1141
+ * Return Tweets newer than this Tweet ID.
1142
+ */
1143
+ sinceId?: string;
1144
+ /**
1145
+ * Match the source application.
1146
+ */
1147
+ source?: string;
639
1148
  /**
640
1149
  * Filter replies sent to a username.
641
1150
  */
@@ -652,6 +1161,14 @@ export interface UserRetrieveMediaParams {
652
1161
  * Only return tweets from verified authors.
653
1162
  */
654
1163
  verifiedOnly?: boolean;
1164
+ /**
1165
+ * Set the radius for the near filter.
1166
+ */
1167
+ within?: string;
1168
+ /**
1169
+ * Match Tweets inside a recent time window.
1170
+ */
1171
+ withinTime?: string;
655
1172
  }
656
1173
  export interface UserRetrieveMentionsParams {
657
1174
  /**
@@ -659,6 +1176,14 @@ export interface UserRetrieveMentionsParams {
659
1176
  * or lines.
660
1177
  */
661
1178
  anyWords?: string;
1179
+ /**
1180
+ * Only return tweets from Blue-verified authors.
1181
+ */
1182
+ blueVerifiedOnly?: boolean;
1183
+ /**
1184
+ * Match the Tweet card name.
1185
+ */
1186
+ cardName?: string;
662
1187
  /**
663
1188
  * Cashtags separated by spaces, commas, or lines.
664
1189
  */
@@ -675,6 +1200,10 @@ export interface UserRetrieveMentionsParams {
675
1200
  * Exact phrase to match.
676
1201
  */
677
1202
  exactPhrase?: string;
1203
+ /**
1204
+ * Exclude a source application.
1205
+ */
1206
+ excludeSource?: string;
678
1207
  /**
679
1208
  * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
680
1209
  */
@@ -683,6 +1212,10 @@ export interface UserRetrieveMentionsParams {
683
1212
  * Filter by author username.
684
1213
  */
685
1214
  fromUser?: string;
1215
+ /**
1216
+ * Match latitude, longitude, and radius.
1217
+ */
1218
+ geocode?: string;
686
1219
  /**
687
1220
  * Hashtags separated by spaces, commas, or lines.
688
1221
  */
@@ -695,6 +1228,26 @@ export interface UserRetrieveMentionsParams {
695
1228
  * Language code filter, e.g. en or tr.
696
1229
  */
697
1230
  language?: string;
1231
+ /**
1232
+ * Maximum likes threshold. maxLikes is also accepted.
1233
+ */
1234
+ maxFaves?: number;
1235
+ /**
1236
+ * Return Tweets older than this Tweet ID.
1237
+ */
1238
+ maxId?: string;
1239
+ /**
1240
+ * Maximum quotes threshold.
1241
+ */
1242
+ maxQuotes?: number;
1243
+ /**
1244
+ * Maximum replies threshold.
1245
+ */
1246
+ maxReplies?: number;
1247
+ /**
1248
+ * Maximum retweets threshold.
1249
+ */
1250
+ maxRetweets?: number;
698
1251
  /**
699
1252
  * Filter by media type.
700
1253
  */
@@ -703,6 +1256,10 @@ export interface UserRetrieveMentionsParams {
703
1256
  * Filter tweets mentioning a username.
704
1257
  */
705
1258
  mentioning?: string;
1259
+ /**
1260
+ * Minimum bookmark count threshold.
1261
+ */
1262
+ minBookmarks?: number;
706
1263
  /**
707
1264
  * Minimum likes threshold.
708
1265
  */
@@ -719,6 +1276,22 @@ export interface UserRetrieveMentionsParams {
719
1276
  * Minimum retweets threshold.
720
1277
  */
721
1278
  minRetweets?: number;
1279
+ /**
1280
+ * Minimum view count threshold.
1281
+ */
1282
+ minViews?: number;
1283
+ /**
1284
+ * Only return native reposts.
1285
+ */
1286
+ nativeRetweets?: boolean;
1287
+ /**
1288
+ * Match a place name.
1289
+ */
1290
+ near?: string;
1291
+ /**
1292
+ * Only return news results.
1293
+ */
1294
+ news?: boolean;
722
1295
  /**
723
1296
  * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
724
1297
  * results. Continue while has_next_page is true. Deprecated limit and count
@@ -745,14 +1318,26 @@ export interface UserRetrieveMentionsParams {
745
1318
  * Only retweets of this tweet ID.
746
1319
  */
747
1320
  retweetsOfTweetId?: string;
1321
+ /**
1322
+ * Enable the safe-search filter.
1323
+ */
1324
+ safe?: boolean;
748
1325
  /**
749
1326
  * Start date in YYYY-MM-DD format.
750
1327
  */
751
1328
  sinceDate?: string;
1329
+ /**
1330
+ * Return Tweets newer than this Tweet ID.
1331
+ */
1332
+ sinceId?: string;
752
1333
  /**
753
1334
  * Unix timestamp - return mentions after this time
754
1335
  */
755
1336
  sinceTime?: string;
1337
+ /**
1338
+ * Match the source application.
1339
+ */
1340
+ source?: string;
756
1341
  /**
757
1342
  * Filter replies sent to a username.
758
1343
  */
@@ -773,6 +1358,14 @@ export interface UserRetrieveMentionsParams {
773
1358
  * Only return tweets from verified authors.
774
1359
  */
775
1360
  verifiedOnly?: boolean;
1361
+ /**
1362
+ * Set the radius for the near filter.
1363
+ */
1364
+ within?: string;
1365
+ /**
1366
+ * Match Tweets inside a recent time window.
1367
+ */
1368
+ withinTime?: string;
776
1369
  }
777
1370
  export interface UserRetrieveRepliesParams {
778
1371
  /**
@@ -780,6 +1373,14 @@ export interface UserRetrieveRepliesParams {
780
1373
  * or lines.
781
1374
  */
782
1375
  anyWords?: string;
1376
+ /**
1377
+ * Only return tweets from Blue-verified authors.
1378
+ */
1379
+ blueVerifiedOnly?: boolean;
1380
+ /**
1381
+ * Match the Tweet card name.
1382
+ */
1383
+ cardName?: string;
783
1384
  /**
784
1385
  * Cashtags separated by spaces, commas, or lines.
785
1386
  */
@@ -789,13 +1390,18 @@ export interface UserRetrieveRepliesParams {
789
1390
  */
790
1391
  conversationId?: string;
791
1392
  /**
792
- * Pagination cursor for user replies
1393
+ * Cursor from the previous response. Xquik cursors resume automatic coverage.
1394
+ * Existing unprefixed cursors keep legacy standard behavior.
793
1395
  */
794
1396
  cursor?: string;
795
1397
  /**
796
1398
  * Exact phrase to match.
797
1399
  */
798
1400
  exactPhrase?: string;
1401
+ /**
1402
+ * Exclude a source application.
1403
+ */
1404
+ excludeSource?: string;
799
1405
  /**
800
1406
  * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
801
1407
  */
@@ -804,6 +1410,10 @@ export interface UserRetrieveRepliesParams {
804
1410
  * Filter by author username.
805
1411
  */
806
1412
  fromUser?: string;
1413
+ /**
1414
+ * Match latitude, longitude, and radius.
1415
+ */
1416
+ geocode?: string;
807
1417
  /**
808
1418
  * Hashtags separated by spaces, commas, or lines.
809
1419
  */
@@ -820,6 +1430,26 @@ export interface UserRetrieveRepliesParams {
820
1430
  * Language code filter, e.g. en or tr.
821
1431
  */
822
1432
  language?: string;
1433
+ /**
1434
+ * Maximum likes threshold. maxLikes is also accepted.
1435
+ */
1436
+ maxFaves?: number;
1437
+ /**
1438
+ * Return Tweets older than this Tweet ID.
1439
+ */
1440
+ maxId?: string;
1441
+ /**
1442
+ * Maximum quotes threshold.
1443
+ */
1444
+ maxQuotes?: number;
1445
+ /**
1446
+ * Maximum replies threshold.
1447
+ */
1448
+ maxReplies?: number;
1449
+ /**
1450
+ * Maximum retweets threshold.
1451
+ */
1452
+ maxRetweets?: number;
823
1453
  /**
824
1454
  * Filter by media type.
825
1455
  */
@@ -828,6 +1458,10 @@ export interface UserRetrieveRepliesParams {
828
1458
  * Filter tweets mentioning a username.
829
1459
  */
830
1460
  mentioning?: string;
1461
+ /**
1462
+ * Minimum bookmark count threshold.
1463
+ */
1464
+ minBookmarks?: number;
831
1465
  /**
832
1466
  * Minimum likes threshold.
833
1467
  */
@@ -845,9 +1479,24 @@ export interface UserRetrieveRepliesParams {
845
1479
  */
846
1480
  minRetweets?: number;
847
1481
  /**
848
- * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
849
- * results. Continue while has_next_page is true. Deprecated limit and count
850
- * aliases remain accepted.
1482
+ * Minimum view count threshold.
1483
+ */
1484
+ minViews?: number;
1485
+ /**
1486
+ * Only return native reposts.
1487
+ */
1488
+ nativeRetweets?: boolean;
1489
+ /**
1490
+ * Match a place name.
1491
+ */
1492
+ near?: string;
1493
+ /**
1494
+ * Only return news results.
1495
+ */
1496
+ news?: boolean;
1497
+ /**
1498
+ * Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20.
1499
+ * Continue while has_next_page is true. Deprecated aliases remain accepted.
851
1500
  */
852
1501
  pageSize?: number;
853
1502
  /**
@@ -870,10 +1519,22 @@ export interface UserRetrieveRepliesParams {
870
1519
  * Only retweets of this tweet ID.
871
1520
  */
872
1521
  retweetsOfTweetId?: string;
1522
+ /**
1523
+ * Enable the safe-search filter.
1524
+ */
1525
+ safe?: boolean;
873
1526
  /**
874
1527
  * Start date in YYYY-MM-DD format.
875
1528
  */
876
1529
  sinceDate?: string;
1530
+ /**
1531
+ * Return Tweets newer than this Tweet ID.
1532
+ */
1533
+ sinceId?: string;
1534
+ /**
1535
+ * Match the source application.
1536
+ */
1537
+ source?: string;
877
1538
  /**
878
1539
  * Filter replies sent to a username.
879
1540
  */
@@ -890,16 +1551,80 @@ export interface UserRetrieveRepliesParams {
890
1551
  * Only return tweets from verified authors.
891
1552
  */
892
1553
  verifiedOnly?: boolean;
1554
+ /**
1555
+ * Set the radius for the near filter.
1556
+ */
1557
+ within?: string;
1558
+ /**
1559
+ * Match Tweets inside a recent time window.
1560
+ */
1561
+ withinTime?: string;
893
1562
  }
894
1563
  export interface UserRetrieveSearchParams {
895
1564
  /**
896
1565
  * User search query
897
1566
  */
898
1567
  q: string;
1568
+ /**
1569
+ * Match any comma-separated or line-separated bio term, ignoring case.
1570
+ */
1571
+ bioContains?: string;
899
1572
  /**
900
1573
  * Pagination cursor for user search
901
1574
  */
902
1575
  cursor?: string;
1576
+ /**
1577
+ * Only return profiles with a location.
1578
+ */
1579
+ hasLocation?: boolean;
1580
+ /**
1581
+ * Only return profiles with a website.
1582
+ */
1583
+ hasWebsite?: boolean;
1584
+ /**
1585
+ * Match a location substring, ignoring case.
1586
+ */
1587
+ locationContains?: string;
1588
+ /**
1589
+ * Maximum follower count. Missing counts pass this maximum.
1590
+ */
1591
+ maxFollowers?: number;
1592
+ /**
1593
+ * Maximum following count.
1594
+ */
1595
+ maxFollowing?: number;
1596
+ /**
1597
+ * Maximum post count. maxPosts is also accepted.
1598
+ */
1599
+ maxStatuses?: number;
1600
+ /**
1601
+ * Minimum account age in whole days.
1602
+ */
1603
+ minAccountAgeDays?: number;
1604
+ /**
1605
+ * Minimum follower count. Filtering happens before billing.
1606
+ */
1607
+ minFollowers?: number;
1608
+ /**
1609
+ * Minimum following count.
1610
+ */
1611
+ minFollowing?: number;
1612
+ /**
1613
+ * Minimum post count. minPosts is also accepted.
1614
+ */
1615
+ minStatuses?: number;
1616
+ /**
1617
+ * Match a username substring, ignoring case.
1618
+ */
1619
+ usernameContains?: string;
1620
+ /**
1621
+ * Only return verified profiles.
1622
+ */
1623
+ verifiedOnly?: boolean;
1624
+ /**
1625
+ * Match the verification type exactly, ignoring case.
1626
+ */
1627
+ verifiedType?: string;
903
1628
  }
904
1629
  export interface UserRetrieveTweetsParams {
905
1630
  /**
@@ -907,6 +1632,14 @@ export interface UserRetrieveTweetsParams {
907
1632
  * or lines.
908
1633
  */
909
1634
  anyWords?: string;
1635
+ /**
1636
+ * Only return tweets from Blue-verified authors.
1637
+ */
1638
+ blueVerifiedOnly?: boolean;
1639
+ /**
1640
+ * Match the Tweet card name.
1641
+ */
1642
+ cardName?: string;
910
1643
  /**
911
1644
  * Cashtags separated by spaces, commas, or lines.
912
1645
  */
@@ -916,13 +1649,18 @@ export interface UserRetrieveTweetsParams {
916
1649
  */
917
1650
  conversationId?: string;
918
1651
  /**
919
- * Pagination cursor for user tweets
1652
+ * Cursor from the previous response. Xquik cursors resume automatic coverage.
1653
+ * Existing unprefixed cursors keep legacy standard behavior.
920
1654
  */
921
1655
  cursor?: string;
922
1656
  /**
923
1657
  * Exact phrase to match.
924
1658
  */
925
1659
  exactPhrase?: string;
1660
+ /**
1661
+ * Exclude a source application.
1662
+ */
1663
+ excludeSource?: string;
926
1664
  /**
927
1665
  * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
928
1666
  */
@@ -931,6 +1669,10 @@ export interface UserRetrieveTweetsParams {
931
1669
  * Filter by author username.
932
1670
  */
933
1671
  fromUser?: string;
1672
+ /**
1673
+ * Match latitude, longitude, and radius.
1674
+ */
1675
+ geocode?: string;
934
1676
  /**
935
1677
  * Hashtags separated by spaces, commas, or lines.
936
1678
  */
@@ -951,6 +1693,26 @@ export interface UserRetrieveTweetsParams {
951
1693
  * Language code filter, e.g. en or tr.
952
1694
  */
953
1695
  language?: string;
1696
+ /**
1697
+ * Maximum likes threshold. maxLikes is also accepted.
1698
+ */
1699
+ maxFaves?: number;
1700
+ /**
1701
+ * Return Tweets older than this Tweet ID.
1702
+ */
1703
+ maxId?: string;
1704
+ /**
1705
+ * Maximum quotes threshold.
1706
+ */
1707
+ maxQuotes?: number;
1708
+ /**
1709
+ * Maximum replies threshold.
1710
+ */
1711
+ maxReplies?: number;
1712
+ /**
1713
+ * Maximum retweets threshold.
1714
+ */
1715
+ maxRetweets?: number;
954
1716
  /**
955
1717
  * Filter by media type.
956
1718
  */
@@ -959,6 +1721,10 @@ export interface UserRetrieveTweetsParams {
959
1721
  * Filter tweets mentioning a username.
960
1722
  */
961
1723
  mentioning?: string;
1724
+ /**
1725
+ * Minimum bookmark count threshold.
1726
+ */
1727
+ minBookmarks?: number;
962
1728
  /**
963
1729
  * Minimum likes threshold.
964
1730
  */
@@ -976,9 +1742,24 @@ export interface UserRetrieveTweetsParams {
976
1742
  */
977
1743
  minRetweets?: number;
978
1744
  /**
979
- * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
980
- * results. Continue while has_next_page is true. Deprecated limit and count
981
- * aliases remain accepted.
1745
+ * Minimum view count threshold.
1746
+ */
1747
+ minViews?: number;
1748
+ /**
1749
+ * Only return native reposts.
1750
+ */
1751
+ nativeRetweets?: boolean;
1752
+ /**
1753
+ * Match a place name.
1754
+ */
1755
+ near?: string;
1756
+ /**
1757
+ * Only return news results.
1758
+ */
1759
+ news?: boolean;
1760
+ /**
1761
+ * Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20.
1762
+ * Continue while has_next_page is true. Deprecated aliases remain accepted.
982
1763
  */
983
1764
  pageSize?: number;
984
1765
  /**
@@ -1001,10 +1782,22 @@ export interface UserRetrieveTweetsParams {
1001
1782
  * Only retweets of this tweet ID.
1002
1783
  */
1003
1784
  retweetsOfTweetId?: string;
1785
+ /**
1786
+ * Enable the safe-search filter.
1787
+ */
1788
+ safe?: boolean;
1004
1789
  /**
1005
1790
  * Start date in YYYY-MM-DD format.
1006
1791
  */
1007
1792
  sinceDate?: string;
1793
+ /**
1794
+ * Return Tweets newer than this Tweet ID.
1795
+ */
1796
+ sinceId?: string;
1797
+ /**
1798
+ * Match the source application.
1799
+ */
1800
+ source?: string;
1008
1801
  /**
1009
1802
  * Filter replies sent to a username.
1010
1803
  */
@@ -1021,22 +1814,99 @@ export interface UserRetrieveTweetsParams {
1021
1814
  * Only return tweets from verified authors.
1022
1815
  */
1023
1816
  verifiedOnly?: boolean;
1817
+ /**
1818
+ * Set the radius for the near filter.
1819
+ */
1820
+ within?: string;
1821
+ /**
1822
+ * Match Tweets inside a recent time window.
1823
+ */
1824
+ withinTime?: string;
1024
1825
  }
1025
1826
  export interface UserRetrieveVerifiedFollowersParams {
1026
1827
  /**
1027
- * Pagination cursor for verified followers
1828
+ * Legacy cursor alias. Prefer cursor.
1829
+ */
1830
+ after?: string;
1831
+ /**
1832
+ * Match any comma-separated or line-separated bio term, ignoring case.
1833
+ */
1834
+ bioContains?: string;
1835
+ /**
1836
+ * Cursor from the previous response. Xquik cursors resume automatic coverage.
1837
+ * Existing unprefixed cursors keep legacy standard behavior.
1028
1838
  */
1029
1839
  cursor?: string;
1030
1840
  /**
1031
- * Maximum user profiles requested from this page (20-200, default 200). The
1032
- * response can contain fewer profiles because the source returned fewer or
1033
- * the available usage balance covers fewer results. Keep requesting next_cursor while
1034
- * has_next_page is true. The deprecated limit and count aliases remain accepted.
1841
+ * Only return profiles with a location.
1842
+ */
1843
+ hasLocation?: boolean;
1844
+ /**
1845
+ * Only return profiles with a website.
1846
+ */
1847
+ hasWebsite?: boolean;
1848
+ /**
1849
+ * Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
1850
+ * Prefer pageSize.
1851
+ */
1852
+ limit?: number;
1853
+ /**
1854
+ * Match a location substring, ignoring case.
1855
+ */
1856
+ locationContains?: string;
1857
+ /**
1858
+ * Maximum follower count. Missing counts pass this maximum.
1859
+ */
1860
+ maxFollowers?: number;
1861
+ /**
1862
+ * Maximum following count.
1863
+ */
1864
+ maxFollowing?: number;
1865
+ /**
1866
+ * Maximum post count. maxPosts is also accepted.
1867
+ */
1868
+ maxStatuses?: number;
1869
+ /**
1870
+ * Minimum account age in whole days.
1871
+ */
1872
+ minAccountAgeDays?: number;
1873
+ /**
1874
+ * Minimum follower count. Filtering happens before billing.
1875
+ */
1876
+ minFollowers?: number;
1877
+ /**
1878
+ * Minimum following count.
1879
+ */
1880
+ minFollowing?: number;
1881
+ /**
1882
+ * Minimum post count. minPosts is also accepted.
1883
+ */
1884
+ minStatuses?: number;
1885
+ /**
1886
+ * Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
1887
+ * Coverage returns diagnostics once and rejects cursors.
1888
+ */
1889
+ mode?: 'standard' | 'coverage';
1890
+ /**
1891
+ * Maximum user profiles: automatic 300; standard 200. Sources return fewer
1892
+ * profiles. Continue with has_next_page.
1035
1893
  */
1036
1894
  pageSize?: number;
1895
+ /**
1896
+ * Match a username substring, ignoring case.
1897
+ */
1898
+ usernameContains?: string;
1899
+ /**
1900
+ * Only return verified profiles.
1901
+ */
1902
+ verifiedOnly?: boolean;
1903
+ /**
1904
+ * Match the verification type exactly, ignoring case.
1905
+ */
1906
+ verifiedType?: string;
1037
1907
  }
1038
1908
  export declare namespace Users {
1039
- export { type UserRemoveFollowerResponse as UserRemoveFollowerResponse, type UserRetrieveBatchResponse as UserRetrieveBatchResponse, type UserRemoveFollowerParams as UserRemoveFollowerParams, type UserRetrieveBatchParams as UserRetrieveBatchParams, type UserRetrieveFollowersParams as UserRetrieveFollowersParams, type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams, type UserRetrieveFollowingParams as UserRetrieveFollowingParams, type UserRetrieveLikesParams as UserRetrieveLikesParams, type UserRetrieveMediaParams as UserRetrieveMediaParams, type UserRetrieveMentionsParams as UserRetrieveMentionsParams, type UserRetrieveRepliesParams as UserRetrieveRepliesParams, type UserRetrieveSearchParams as UserRetrieveSearchParams, type UserRetrieveTweetsParams as UserRetrieveTweetsParams, type UserRetrieveVerifiedFollowersParams as UserRetrieveVerifiedFollowersParams, };
1909
+ export { type UserRemoveFollowerResponse as UserRemoveFollowerResponse, type UserRetrieveBatchResponse as UserRetrieveBatchResponse, type UserRetrieveFollowersResponse as UserRetrieveFollowersResponse, type UserRetrieveFollowingResponse as UserRetrieveFollowingResponse, type UserRetrieveVerifiedFollowersResponse as UserRetrieveVerifiedFollowersResponse, type UserRemoveFollowerParams as UserRemoveFollowerParams, type UserRetrieveBatchParams as UserRetrieveBatchParams, type UserRetrieveFollowersParams as UserRetrieveFollowersParams, type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams, type UserRetrieveFollowingParams as UserRetrieveFollowingParams, type UserRetrieveLikesParams as UserRetrieveLikesParams, type UserRetrieveMediaParams as UserRetrieveMediaParams, type UserRetrieveMentionsParams as UserRetrieveMentionsParams, type UserRetrieveRepliesParams as UserRetrieveRepliesParams, type UserRetrieveSearchParams as UserRetrieveSearchParams, type UserRetrieveTweetsParams as UserRetrieveTweetsParams, type UserRetrieveVerifiedFollowersParams as UserRetrieveVerifiedFollowersParams, };
1040
1910
  export { Follow as Follow, type FollowCreateResponse as FollowCreateResponse, type FollowDeleteAllResponse as FollowDeleteAllResponse, type FollowCreateParams as FollowCreateParams, type FollowDeleteAllParams as FollowDeleteAllParams, };
1041
1911
  }
1042
1912
  //# sourceMappingURL=users.d.mts.map