Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion doc/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -1059,14 +1059,28 @@ await client.v2.createMediaMetadata(mediaId, { alt_text: { text: 'Hello, world!'

**Right level**: `Read-only`

**Scope**: App-only (no user OAuth scope required)

**Arguments**:
- `options: TweetUsageV2Params`

`usage.fields` values: `cap_reset_day`, `daily_client_app_usage`, `daily_project_usage`, `project_cap`, `project_id`, `project_usage`.

**Returns**: `TweetV2UsageResult`

**Example**
```ts
const usage = await client.v2.usage({ 'usage.fields': ['daily_project_usage'] });
const usage = await client.v2.usage({ 'usage.fields': ['project_usage', 'project_cap'] });
```

**Example result**
```json
{
"data": {
"project_usage": "123",
"project_cap": "1000"
}
}
```

## Lists
Expand Down
2 changes: 1 addition & 1 deletion src/types/v2/community.v2.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ export interface CommunitySearchV2Params {
max_results?: number;
next_token?: string;
pagination_token?: string;
}
}
2 changes: 1 addition & 1 deletion src/v2/client.v2.read.ts
Original file line number Diff line number Diff line change
Expand Up @@ -873,7 +873,7 @@ export default class TwitterApiv2ReadOnly extends TwitterApiSubClient {

/**
* Allows you to retrieve your project usage.
*
*
* https://developer.x.com/en/docs/x-api/usage/tweets/introduction
*/
public async usage(options: Partial<TweetUsageV2Params> = {}) {
Expand Down