# UnsubscribeRequest | xrpl
Documentation for xrpl

# Interface UnsubscribeRequest

The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions. Expects a response in the form of an UnsubscribeResponse.

#### Hierarchy

- BaseRequest
  - UnsubscribeRequest

- Defined in packages/xrpl/src/models/methods/unsubscribe.ts:18

#####
Index

### Properties

accounts?
accounts_proposed?
api_version?
books?
command
id?
streams?

## Properties

### `Optional` accounts

accounts?: string[]

Array of unique account addresses to stop receiving updates for, in the. XRP Ledger's base58 format.

- Defined in packages/xrpl/src/models/methods/unsubscribe.ts:29

### `Optional` accounts_proposed

accounts_proposed?: string[]

Like accounts, but for accounts_proposed subscriptions that included not-yet-validated transactions.

- Defined in packages/xrpl/src/models/methods/unsubscribe.ts:34

### `Optional` api_version

api_version?: number

The API version to use. If omitted, use version 1.

Inherited from BaseRequest.api_version

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

### `Optional` books

books?: Book[]

Array of objects defining order books to unsubscribe from, as explained below.

- Defined in packages/xrpl/src/models/methods/unsubscribe.ts:39

### command

command: "unsubscribe"

Overrides BaseRequest.command

- Defined in packages/xrpl/src/models/methods/unsubscribe.ts:19

### `Optional` id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Inherited from BaseRequest.id

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

### `Optional` streams

streams?: StreamType[]

Array of string names of generic streams to unsubscribe from, including. Ledger, server, transactions, and transactions_proposed.

- Defined in packages/xrpl/src/models/methods/unsubscribe.ts:24

Generated using TypeDoc