> ## Documentation Index
> Fetch the complete documentation index at: https://docs.x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ActivityClient

> Reference for the ActivityClient class in the X API TypeScript SDK. Methods, parameters, and return types for the X API v2 activity endpoints.

Client for activity operations

This client provides methods for interacting with the activity endpoints
of the X API. It handles authentication, request formatting, and response
parsing for all activity related operations.

## Constructors

### constructor

• **new ActivityClient**(`client`): [`ActivityClient`](/xdks/typescript/reference/classes/ActivityClient)

Creates a new activity client instance

#### Parameters

| Name     | Type                                                  | Description                    |
| :------- | :---------------------------------------------------- | :----------------------------- |
| `client` | [`Client`](/xdks/typescript/reference/classes/Client) | The main X API client instance |

#### Returns

[`ActivityClient`](/xdks/typescript/reference/classes/ActivityClient)

#### Defined in

[activity/client.ts:118](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L118)

## Methods

### getSubscriptions

▸ **getSubscriptions**(`options`): `Promise`\<`Response`>

Get X activity subscriptions
Get a list of active subscriptions for XAA

#### Parameters

| Name                         | Type     |
| :--------------------------- | :------- |
| `options`                    | `Object` |
| `options.requestOptions`     | `Object` |
| `options.requestOptions.raw` | `true`   |

#### Returns

`Promise`\<`Response`>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

#### Defined in

[activity/client.ts:159](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L159)

▸ **getSubscriptions**(): `Promise`\<[`ActivitySubscriptionGetResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionGetResponse)>

#### Returns

`Promise`\<[`ActivitySubscriptionGetResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionGetResponse)>

#### Defined in

[activity/client.ts:168](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L168)

***

### createSubscription

▸ **createSubscription**(`options`): `Promise`\<`Response`>

Create X activity subscription
Creates a subscription for an X activity event

#### Parameters

| Name      | Type                                                                      |
| :-------- | :------------------------------------------------------------------------ |
| `options` | `CreateSubscriptionOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Returns

`Promise`\<`Response`>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

#### Defined in

[activity/client.ts:237](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L237)

▸ **createSubscription**(`options?`): `Promise`\<[`ActivitySubscriptionCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionCreateResponse)>

#### Parameters

| Name       | Type                        |
| :--------- | :-------------------------- |
| `options?` | `CreateSubscriptionOptions` |

#### Returns

`Promise`\<[`ActivitySubscriptionCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionCreateResponse)>

#### Defined in

[activity/client.ts:246](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L246)

***

### stream

▸ **stream**(`options`): `Promise`\<`Response`>

Activity Stream
Stream of X Activities

#### Parameters

| Name      | Type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `StreamOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Returns

`Promise`\<`Response`>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

#### Defined in

[activity/client.ts:332](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L332)

▸ **stream**(`options?`): `Promise`\<[`ActivityStreamingResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivityStreamingResponse)>

#### Parameters

| Name       | Type            |
| :--------- | :-------------- |
| `options?` | `StreamOptions` |

#### Returns

`Promise`\<[`ActivityStreamingResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivityStreamingResponse)>

#### Defined in

[activity/client.ts:341](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L341)

***

### updateSubscription

▸ **updateSubscription**(`subscriptionId`, `options`): `Promise`\<`Response`>

Update X activity subscription
Updates a subscription for an X activity event

#### Parameters

| Name             | Type                                                                      | Description                           |
| :--------------- | :------------------------------------------------------------------------ | :------------------------------------ |
| `subscriptionId` | `string`                                                                  | The ID of the subscription to update. |
| `options`        | `UpdateSubscriptionOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                     |

#### Returns

`Promise`\<`Response`>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

#### Defined in

[activity/client.ts:487](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L487)

▸ **updateSubscription**(`subscriptionId`, `options?`): `Promise`\<[`ActivitySubscriptionUpdateResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionUpdateResponse)>

#### Parameters

| Name             | Type                        |
| :--------------- | :-------------------------- |
| `subscriptionId` | `string`                    |
| `options?`       | `UpdateSubscriptionOptions` |

#### Returns

`Promise`\<[`ActivitySubscriptionUpdateResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionUpdateResponse)>

#### Defined in

[activity/client.ts:500](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L500)

***

### deleteSubscription

▸ **deleteSubscription**(`subscriptionId`, `options`): `Promise`\<`Response`>

Deletes X activity subscription
Deletes a subscription for an X activity event

#### Parameters

| Name                         | Type     | Description                           |
| :--------------------------- | :------- | :------------------------------------ |
| `subscriptionId`             | `string` | The ID of the subscription to delete. |
| `options`                    | `Object` | -                                     |
| `options.requestOptions`     | `Object` | -                                     |
| `options.requestOptions.raw` | `true`   | -                                     |

#### Returns

`Promise`\<`Response`>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

#### Defined in

[activity/client.ts:602](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L602)

▸ **deleteSubscription**(`subscriptionId`): `Promise`\<[`ActivitySubscriptionDeleteResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionDeleteResponse)>

#### Parameters

| Name             | Type     |
| :--------------- | :------- |
| `subscriptionId` | `string` |

#### Returns

`Promise`\<[`ActivitySubscriptionDeleteResponse`](/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionDeleteResponse)>

#### Defined in

[activity/client.ts:615](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L615)