<!-- Public documentation export; not library implementation source. -->
# IWatchListApi

[Integration guide](https://docs.lumencharts.com/charting-library/reference/compatibility) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

## defaultList {#defaultlist}

```ts
defaultList(): string[];
```

Use the type signature above and the integration guide for the owning capability.

## getList {#getlist}

```ts
getList(id?: string): string[] | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | No |

## getAllLists {#getalllists}

```ts
getAllLists(): WatchListSymbolListMap | null;
```

Use the type signature above and the integration guide for the owning capability.

## setActiveList {#setactivelist}

```ts
setActiveList(id: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |

## getActiveListId {#getactivelistid}

```ts
getActiveListId(): string | null;
```

Use the type signature above and the integration guide for the owning capability.

## setList {#setlist}

```ts
setList(symbols: string[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbols` | `string[]` | Yes |

## updateList {#updatelist}

```ts
updateList(listId: string, symbols: string[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |
| `symbols` | `string[]` | Yes |

## renameList {#renamelist}

```ts
renameList(listId: string, newName: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |
| `newName` | `string` | Yes |

## createList {#createlist}

```ts
createList(listName?: string, symbols?: string[]): WatchListSymbolList | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listName` | `string` | No |
| `symbols` | `string[]` | No |

## saveList {#savelist}

```ts
saveList(list: WatchListSymbolList): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `list` | `WatchListSymbolList` | Yes |

## deleteList {#deletelist}

```ts
deleteList(listId: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |

## onListChanged {#onlistchanged}

```ts
onListChanged(): ISubscription<WatchListSymbolListChangedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onActiveListChanged {#onactivelistchanged}

```ts
onActiveListChanged(): ISubscription<EmptyCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onListAdded {#onlistadded}

```ts
onListAdded(): ISubscription<WatchListSymbolListAddedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onListRemoved {#onlistremoved}

```ts
onListRemoved(): ISubscription<WatchListSymbolListRemovedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onListRenamed {#onlistrenamed}

```ts
onListRenamed(): ISubscription<WatchListSymbolListRenamedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [WatchListSymbolListMap](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListMap)
- [WatchListSymbolList](https://docs.lumencharts.com/charting-library/api/WatchListSymbolList)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)
- [WatchListSymbolListChangedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListChangedCallback)
- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)
- [WatchListSymbolListAddedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListAddedCallback)
- [WatchListSymbolListRemovedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRemovedCallback)
- [WatchListSymbolListRenamedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRenamedCallback)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IWatchListApi