# Authentication (/avanza-ts/docs/sdk/authentication)



## Getting a TOTP secret [#getting-a-totp-secret]

1. Sign in to Avanza and go to **Profil → Inställningar → Sajtinställningar → Inloggning och utloggning → Användarnamn → Tvåfaktorsinloggning**.
2. Choose **Aktivera** to set up two-factor login. If it is already enabled, choose **Återaktivera** instead.
3. Select **Annan app för tvåfaktorsinloggning**.
4. Select **Kan du inte scanna QR-koden?** to reveal the TOTP secret. Add that secret to your authenticator app.
5. Enter the six-digit code from the authenticator app on Avanza to complete setup.

Reactivating TOTP can invalidate an existing authenticator setup. Keep the revealed secret private; pass it as `totpSecret` or supply a current `totpCode` instead.

## TOTP login [#totp-login]

Provide credentials from your own secure configuration. The returned session is also installed on the client:

```ts
import { AvanzaClient } from 'avanza-ts';

const client = new AvanzaClient();
const session = await client.auth.loginWithTotp({
  username: process.env.AVANZA_USERNAME!,
  password: process.env.AVANZA_PASSWORD!,
  totpSecret: process.env.AVANZA_TOTP_SECRET!,
  maxInactiveMinutes: 60,
});
```

You may provide `totpCode` in place of `totpSecret` when generating the code yourself. `maxInactiveMinutes` controls the requested inactivity timeout for TOTP login (30–1,440 minutes; defaults to 1,440). Store the session in a suitable credential store; do not log or commit it.

## BankID [#bankid]

`startBankId()` returns an attempt whose `challenge.qrPayload` is text to render as a QR code. Poll and rerender the challenge while the status is `pending`:

```ts
const attempt = await client.auth.startBankId();
renderQr(attempt.challenge.qrPayload);

while (true) {
  await new Promise((resolve) => setTimeout(resolve, attempt.challenge.refreshAfterMs));
  const result = await attempt.poll();
  if (result.status !== 'pending') break;
  renderQr(result.challenge.qrPayload);
}
```

Call `attempt.cancel()` when abandoning an active login. The SDK supplies the QR payload and optional `bankid://` autostart URL; your application chooses the renderer.


# Getting started (/avanza-ts/docs/sdk/getting-started)



Install the package in a Node.js 22.12+ application:

```sh
pnpm add avanza-ts
```

Create a client and make a public request:

```ts
import { AvanzaClient } from 'avanza-ts';

const client = new AvanzaClient();
const results = await client.market.search('volvo');
console.log(results);
```

Public market and instrument requests work without logging in. For account-specific operations, see [authentication](/avanza-ts/docs/sdk/authentication).


# avanza-ts SDK (/avanza-ts/docs/sdk)



`avanza-ts` is an ESM-first TypeScript SDK for Avanza. It owns the HTTP transport and an in-memory session; your application decides how to store credentials and present results.

Start with [installation and your first request](/avanza-ts/docs/sdk/getting-started), then read [how to get a TOTP secret](/avanza-ts/docs/sdk/authentication#getting-a-totp-secret) and [session duration](/avanza-ts/docs/sdk/sessions#session-duration). Browse the [public API](/avanza-ts/docs/sdk/reference) and its [generated signatures](/avanza-ts/docs/sdk/reference/generated). See [For AI agents](#for-ai-agents) for Markdown versions of these docs.

## For AI agents [#for-ai-agents]

Use the [documentation index](https://antewall.github.io/avanza-ts/llms.txt) to find individual Markdown pages, or [read all docs as Markdown](https://antewall.github.io/avanza-ts/llms-full.txt). You can also copy or view the Markdown from any page using the controls above.

## Disclaimer [#disclaimer]

This is an unofficial TypeScript SDK for Avanza's API. It is not affiliated with Avanza Bank AB. The underlying API can be taken down or changed without warning at any point in time.

The author of this software is not responsible for any indirect damages (foreseeable or unforeseeable), such as, if necessary, loss or alteration of or fraudulent access to data, accidental transmission of viruses or of any other harmful element, loss of profits or opportunities, the cost of replacement goods and services or the attitude and behavior of a third party.


# Sessions (/avanza-ts/docs/sdk/sessions)



The SDK keeps its session in memory. Persisting it is the application's responsibility.

```ts
import { AvanzaClient } from 'avanza-ts';

const client = new AvanzaClient({ session: restoredSession });
const valid = await client.auth.validateSession();

if (valid) {
  const accounts = await client.accounts.list();
}

client.clearSession();
```

You can also replace a session with `client.setSession(session)` or call `client.auth.logout()` to log out remotely and clear it locally. Authentication-required requests fail before making a network call when no session is available. TOTP sessions carry authentication headers; BankID sessions contain a serializable cookie snapshot.

## Session duration [#session-duration]

Avanza lets you choose how long you stay logged in—from 30 minutes to 24 hours—in your account's website settings. This applies to biometric, username/password, and BankID logins. See Avanza's [session-duration instructions](https://www.avanza.se/kundservice.html/5121/hur-lange-kan-jag-vara-inloggad-pa-mitt-konto-utan-att-loggas-ut).

Separately, `loginWithTotp()` sends `maxInactiveMinutes` with its login request (30–1,440 minutes; default 1,440). See [TOTP login](/avanza-ts/docs/sdk/authentication#totp-login) for an example. The SDK has no equivalent setting for BankID login. Avanza determines when any session actually expires, so validate a restored session before using it. The 120-second BankID *login attempt* timeout is unrelated to session lifetime.


# Authentication (/avanza-ts/docs/cli/authentication)



## Getting a TOTP secret [#getting-a-totp-secret]

1. Sign in to Avanza and go to **Profil → Inställningar → Sajtinställningar → Inloggning och utloggning → Användarnamn → Tvåfaktorsinloggning**.
2. Choose **Aktivera** to set up two-factor login. If it is already enabled, choose **Återaktivera** instead.
3. Select **Annan app för tvåfaktorsinloggning**.
4. Select **Kan du inte scanna QR-koden?** to reveal the TOTP secret. Add that secret to your authenticator app.
5. Enter the six-digit code from the authenticator app on Avanza to complete setup.

Reactivation may invalidate a previous authenticator setup. Do not share or commit the secret.

## TOTP login [#totp-login]

```sh
avanza auth totp
```

The CLI prompts for missing credentials and masks passwords and TOTP codes. For non-interactive use, set `AVANZA_USERNAME` and `AVANZA_PASSWORD`, plus exactly one of `AVANZA_TOTP_CODE` or `AVANZA_TOTP_SECRET`. Credentials used to authenticate are not stored; only the resulting session is saved.

## BankID [#bankid]

```sh
avanza auth bankid
```

BankID requires an interactive terminal. The CLI displays and refreshes a QR code until the attempt finishes or is cancelled.

Check or clear the session with `avanza auth session` and `avanza auth logout`. See [session storage](/avanza-ts/docs/cli/sessions) for details.


# Getting started (/avanza-ts/docs/cli/getting-started)



Install [Node.js 22.12 or newer](https://nodejs.org/en/download) first. The package is `avanza-tools` and the command is `avanza`.

## macOS, Linux, and Windows [#macos-linux-and-windows]

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```sh
    npm install --global avanza-tools
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```sh
    pnpm add --global avanza-tools
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```sh
    bun add --global avanza-tools
    ```
  </CodeBlockTab>
</CodeBlockTabs>

On macOS or Linux, Homebrew is also available:

```sh
brew install AnteWall/tap/avanza-tools
```

Verify the installation with `avanza --help`.

On Linux, signing in requires a running Secret Service provider; see [session storage](/avanza-ts/docs/cli/sessions).

Get help for any command and try a public market query without signing in:

```sh
avanza market search --help
avanza market search --query volvo --limit 5
```

For private data, [authenticate](/avanza-ts/docs/cli/authentication) first. See the [command reference](/avanza-ts/docs/cli/reference) for all topics and available flags. AI agent users can also [install the Avanza CLI skill](/avanza-ts/docs/cli/skills).


# avanza-cli (/avanza-ts/docs/cli)



`avanza-tools` is an oclif-based terminal interface built on `avanza-ts` (command: `avanza`). [Install it](/avanza-ts/docs/cli/getting-started), [get a TOTP secret](/avanza-ts/docs/cli/authentication#getting-a-totp-secret), and read about [session duration](/avanza-ts/docs/cli/sessions#session-duration). Browse the [generated command reference](/avanza-ts/docs/cli/reference) for commands and flags sourced from oclif help metadata. See [For AI agents](#for-ai-agents) for the agent skill and Markdown docs.

## For AI agents [#for-ai-agents]

[Install the Avanza CLI skill](/avanza-ts/docs/cli/skills), or share the [Markdown index](https://antewall.github.io/avanza-ts/llms.txt) or [full Markdown docs](https://antewall.github.io/avanza-ts/llms-full.txt) with an agent. You can also copy or view the Markdown from any page using the controls above.

## Disclaimer [#disclaimer]

This is an unofficial CLI for Avanza's API. It is not affiliated with Avanza Bank AB. The underlying API can be taken down or changed without warning at any point in time.

The author of this software is not responsible for any indirect damages (foreseeable or unforeseeable), such as, if necessary, loss or alteration of or fraudulent access to data, accidental transmission of viruses or of any other harmful element, loss of profits or opportunities, the cost of replacement goods and services or the attitude and behavior of a third party.


# Output formats (/avanza-ts/docs/cli/output)



Commands supporting structured output accept `--json`. Add `--fields` to select comma-separated paths, including nested fields:

```sh
avanza market search --query volvo --json
avanza auth session --json --fields user.greetingName,user.loggedIn
```

Unknown fields are rejected. `--json` without `--fields` returns the complete redacted response.

`--fixture` prints the raw HTTP request and response. To write it to a **new** temporary file, pass `--fixture --output <path>`; the CLI will not overwrite an existing file. `--json` and `--fixture` cannot be combined. Fixture output may contain personal information: keep captures private, anonymize them before tracking, and delete temporary captures after use.


# Session storage (/avanza-ts/docs/cli/sessions)



The CLI saves one `avanza-cli` credential in the operating system credential store: macOS Keychain, Windows Credential Manager, or Linux Secret Service (for example, GNOME Keyring or KWallet). Linux requires a running Secret Service provider.

```sh
avanza auth session
avanza auth logout
```

Session status validates the saved session and prints a redacted summary. Logout removes the local credential even if the remote logout request fails.

## Session duration [#session-duration]

Avanza lets you choose how long you stay logged in—from 30 minutes to 24 hours—in your account's website settings. This applies to biometric, username/password, and BankID logins. See Avanza's [session-duration instructions](https://www.avanza.se/kundservice.html/5121/hur-lange-kan-jag-vara-inloggad-pa-mitt-konto-utan-att-loggas-ut). The CLI checks the stored session with `avanza auth session`; an expired session requires signing in again.

Separately, the CLI's TOTP login sends a 1,440-minute `maxInactiveMinutes` value with its login request. The SDK supports requesting 30–1,440 minutes, but the CLI does not currently offer a flag for that setting. See the [SDK authentication guide](/avanza-ts/docs/sdk/authentication#totp-login) if you need to set it programmatically.


# Agent skill (/avanza-ts/docs/cli/skills)



The [Avanza CLI skill](https://github.com/AnteWall/avanza-ts/blob/main/skills/avanza-cli/SKILL.md) helps AI agents use `avanza` to look up market data and work with your account. It includes command examples and guidance for `--json` and `--fields`.

First [install the CLI](/avanza-ts/docs/cli/getting-started), then run this in your project:

```sh
npx skills add AnteWall/avanza-ts --skill avanza-cli
```

To use it in all your projects, add `--global` to the install command.

For example, ask your agent:

> Find the latest quote for Volvo B using Avanza.

> Show my recent dividends from Avanza.

For account data, [sign in](/avanza-ts/docs/cli/authentication) first.


# Authentication API (/avanza-ts/docs/sdk/reference/authentication)



Use `client.auth` for login and session lifecycle operations. For setup steps, credentials, and a BankID polling example, read the [authentication guide](/avanza-ts/docs/sdk/authentication).

## Auth client [#auth-client]

<AutoTypeTable path="../../packages/avanza-ts/src/auth/auth-client.ts" name="AuthClient" />

## TOTP options [#totp-options]

Choose either a six-digit `totpCode` or a base32 `totpSecret` (never both). Both modes accept `maxInactiveMinutes` for the requested inactivity timeout.

<AutoTypeTable path="../../packages/avanza-ts/src/auth/auth-types.ts" name="TotpCodeLoginOptions" />

<AutoTypeTable path="../../packages/avanza-ts/src/auth/auth-types.ts" name="TotpSecretLoginOptions" />

## BankID challenge [#bankid-challenge]

The QR payload must be rendered again after each pending poll. See the [BankID attempt API](/avanza-ts/docs/sdk/reference/generated/interfaces/BankIdAuthAttempt) for the complete signatures.

<AutoTypeTable path="../../packages/avanza-ts/src/auth/auth-types.ts" name="BankIdChallenge" />


# Client and configuration (/avanza-ts/docs/sdk/reference/client)



Import `AvanzaClient` from `avanza-ts`. One instance owns its HTTP transport, active session, and domain clients.

```ts
import { AvanzaClient } from 'avanza-ts';

const client = new AvanzaClient();
const results = await client.market.search('volvo');
```

## Client [#client]

<AutoTypeTable path="../../packages/avanza-ts/src/client.ts" name="AvanzaClient" />

## Options [#options]

Pass an existing session or replace the transport when needed. The SDK uses the Node.js global `fetch` and `https://www.avanza.se` by default.

<AutoTypeTable path="../../packages/avanza-ts/src/client.ts" name="AvanzaClientOptions" />

See [sessions](/avanza-ts/docs/sdk/sessions) for restoring and validating an authenticated client. All exported response types and error classes are listed in the [complete reference](/avanza-ts/docs/sdk/reference/generated).


# SDK reference (/avanza-ts/docs/sdk/reference)



`AvanzaClient` exposes domain clients as properties. These guides display type tables generated directly from the TypeScript source. Import public types and values from `avanza-ts`, rather than internal paths.

| Guide                                                    | What it covers                                     |
| -------------------------------------------------------- | -------------------------------------------------- |
| [Client and configuration](/avanza-ts/docs/sdk/reference/client)   | `AvanzaClient`, options, and errors                |
| [Authentication](/avanza-ts/docs/sdk/reference/authentication)     | TOTP, BankID, and sessions                         |
| [Markets and screeners](/avanza-ts/docs/sdk/reference/market)      | Market data, instruments, and funds                |
| [Accounts and portfolios](/avanza-ts/docs/sdk/reference/portfolio) | Accounts, positions, transactions, and performance |

For every exported interface and type alias, use the [complete generated reference](/avanza-ts/docs/sdk/reference/generated). It includes detailed signatures and links between types, such as [`AvanzaClient`](/avanza-ts/docs/sdk/reference/generated/classes/AvanzaClient) and [`StockFilter`](/avanza-ts/docs/sdk/reference/generated/interfaces/StockFilter).


# Markets and screeners (/avanza-ts/docs/sdk/reference/market)



Public market and screener requests work without signing in. Find an orderbook ID with `client.market.search()` before requesting a quote or chart.

## Market client [#market-client]

<AutoTypeTable path="../../packages/avanza-ts/src/market/market-client.ts" name="MarketClient" />

## Instruments client [#instruments-client]

<AutoTypeTable path="../../packages/avanza-ts/src/instruments/instruments-client.ts" name="InstrumentsClient" />

## Stock screen options [#stock-screen-options]

<AutoTypeTable path="../../packages/avanza-ts/src/instruments/stock-screener-types.ts" name="ScreenStocksOptions" />

## Funds client [#funds-client]

<AutoTypeTable path="../../packages/avanza-ts/src/funds/funds-client.ts" name="FundsClient" />

The [complete reference](/avanza-ts/docs/sdk/reference/generated) includes the corresponding response types and filters.


# Accounts and portfolios (/avanza-ts/docs/sdk/reference/portfolio)



Account-specific operations require a valid session. See [authentication](/avanza-ts/docs/sdk/authentication) and [sessions](/avanza-ts/docs/sdk/sessions) before calling these clients.

## Accounts client [#accounts-client]

<AutoTypeTable path="../../packages/avanza-ts/src/accounts/accounts-client.ts" name="AccountsClient" />

## Positions client [#positions-client]

<AutoTypeTable path="../../packages/avanza-ts/src/positions/positions-client.ts" name="PositionsClient" />

## Transactions client [#transactions-client]

<AutoTypeTable path="../../packages/avanza-ts/src/transactions/transactions-client.ts" name="TransactionsClient" />

## Performance client [#performance-client]

<AutoTypeTable path="../../packages/avanza-ts/src/performance/performance-client.ts" name="PerformanceClient" />

Browse all exported request and response types in the [complete reference](/avanza-ts/docs/sdk/reference/generated).


# avanza accounts (/avanza-ts/docs/cli/reference/accounts)



Read accounts and balances

* [`avanza accounts categories`](#avanza-accounts-categories)
* [`avanza accounts categorized-overview`](#avanza-accounts-categorized-overview)
* [`avanza accounts closed`](#avanza-accounts-closed)
* [`avanza accounts has-closed`](#avanza-accounts-has-closed)
* [`avanza accounts lightweight`](#avanza-accounts-lightweight)
* [`avanza accounts list`](#avanza-accounts-list)
* [`avanza accounts overview`](#avanza-accounts-overview)
* [`avanza accounts trading`](#avanza-accounts-trading)
* [`avanza accounts trading-with-positions`](#avanza-accounts-trading-with-positions)

## `avanza accounts categories` [#avanza-accounts-categories]

List account categories

```
USAGE
  $ avanza accounts categories [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts categorized-overview` [#avanza-accounts-categorized-overview]

Read the categorized account overview

```
USAGE
  $ avanza accounts categorized-overview [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts closed` [#avanza-accounts-closed]

List closed accounts

```
USAGE
  $ avanza accounts closed [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts has-closed` [#avanza-accounts-has-closed]

Check whether any accounts have been closed

```
USAGE
  $ avanza accounts has-closed [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts lightweight` [#avanza-accounts-lightweight]

Read lightweight account summaries

```
USAGE
  $ avanza accounts lightweight [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts list` [#avanza-accounts-list]

List open accounts

```
USAGE
  $ avanza accounts list [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts overview` [#avanza-accounts-overview]

Inspect one account

```
USAGE
  $ avanza accounts overview --account-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --account-id=<value>  (required) Account URL parameter ID
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza accounts trading` [#avanza-accounts-trading]

Read trading accounts

```
USAGE
  $ avanza accounts trading [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza accounts trading-with-positions` [#avanza-accounts-trading-with-positions]

Read trading accounts with positions

```
USAGE
  $ avanza accounts trading-with-positions [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```


# avanza auth (/avanza-ts/docs/cli/reference/auth)



Manage authentication and the stored session

* [`avanza auth bankid`](#avanza-auth-bankid)
* [`avanza auth logout`](#avanza-auth-logout)
* [`avanza auth session`](#avanza-auth-session)
* [`avanza auth totp`](#avanza-auth-totp)

## `avanza auth bankid` [#avanza-auth-bankid]

Sign in by scanning a rotating BankID QR code

```
USAGE
  $ avanza auth bankid
```

## `avanza auth logout` [#avanza-auth-logout]

Sign out and remove the stored session

```
USAGE
  $ avanza auth logout
```

## `avanza auth session` [#avanza-auth-session]

Validate and show the current authentication session

```
USAGE
  $ avanza auth session [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza auth totp` [#avanza-auth-totp]

Sign in with username, password, and TOTP

```
USAGE
  $ avanza auth totp
```


# avanza collections (/avanza-ts/docs/cli/reference/collections)



Read watchlists, alerts, and instrument notes

* [`avanza collections alerts`](#avanza-collections-alerts)
* [`avanza collections note-orderbooks`](#avanza-collections-note-orderbooks)
* [`avanza collections notes`](#avanza-collections-notes)
* [`avanza collections triggered-alerts`](#avanza-collections-triggered-alerts)
* [`avanza collections watchlist-data`](#avanza-collections-watchlist-data)
* [`avanza collections watchlist-news`](#avanza-collections-watchlist-news)
* [`avanza collections watchlists`](#avanza-collections-watchlists)

## `avanza collections alerts` [#avanza-collections-alerts]

List price, percent, and news alerts

```
USAGE
  $ avanza collections alerts [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza collections note-orderbooks` [#avanza-collections-note-orderbooks]

List instruments that have notes

```
USAGE
  $ avanza collections note-orderbooks [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza collections notes` [#avanza-collections-notes]

List instrument notes

```
USAGE
  $ avanza collections notes [--fields <value> --json] [--output <value> [--fixture | ]] [--orderbook-id <value>]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  Only notes for this orderbook
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza collections triggered-alerts` [#avanza-collections-triggered-alerts]

List triggered alerts

```
USAGE
  $ avanza collections triggered-alerts [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza collections watchlist-data` [#avanza-collections-watchlist-data]

Read quotes and selected data points for a watchlist

```
USAGE
  $ avanza collections watchlist-data --watchlist-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--orderbook-ids <value>] [--data-points ABSOLUTE_PERFORMANCE_SINCE_ADDED|BETA|BUY_OR_SELL|BUY_PRICE|CATEGORY|CHANGE
    |CHANGE_PERCENTAGE|COLLATERAL_FACTOR|CURRENCY|DATE_WHEN_ADDED|DIRECTION|DIVIDENDS_AMOUNT_12_MONTHS|DIVIDENDS_PER_YEA
    R|EARNINGS_PER_SHARE|END_DATE|ETF_ORDINARY_DIRECT_YIELD|ETF_RISK|EV_EBIT_RATIO|FIVE_YEARS_PERFORMANCE|FLAG_CODE|FUND
    _RATING|FUND_RISK|FUND_TOTAL_MARKET_VALUE|HIGHEST_PRICE|INSTRUMENT_TYPE|LAST_PRICE|LEVERAGE|LOWEST_PRICE|MANAGEMENT_
    FEE|MARGIN_REQUIREMENT|MARKET_CAP|MAX_PERFORMANCE|NAME|NAV|NET_DEBT_TO_EBITDA_RATIO|NEXT_DIVIDEND_AMOUNT|NEXT_DIVIDE
    ND_DATE|NEXT_REPORT_DATE|NUMBER_OF_OWNERS|ONE_MONTH_PERFORMANCE|ONE_WEEK_PERFORMANCE|ONE_YEAR_PERFORMANCE|OPTION_TYP
    E|ORDINARY_DIRECT_YIELD|PRICE_BOOK_RATIO|PRICE_EARNINGS_RATIO|PRICE_LAST_UPDATED_DATE|PRICE_LAST_UPDATED_TIME|PRICE_
    SALES_RATIO|PRICE_WHEN_ADDED|PRODUCT_FEE|RELATIVE_PERFORMANCE_SINCE_ADDED|RETURN_ON_EQUITY|SELL_PRICE|SHARPE_RATIO|S
    HORT_SELLING_ALLOWED|SIX_MONTHS_PERFORMANCE|SPREAD|STANDARD_DEVIATION_PERCENT|STRIKE_PRICE|SUPER_INTEREST_APPROVED|T
    EN_YEARS_PERFORMANCE|THIS_YEAR_PERFORMANCE|THREE_MONTHS_PERFORMANCE|THREE_YEARS_PERFORMANCE|TOTAL_FEE|UNDERLYING_INS
    TRUMENT_NAME|VALUE_TRADED|VOLATILITY|VOLUME_TRADED|WARRANT_LEVERAGE|WARRANT_TYPE...]

FLAGS
  --data-points=<option>...
      [default: LAST_PRICE] Data points to include
      <options: ABSOLUTE_PERFORMANCE_SINCE_ADDED|BETA|BUY_OR_SELL|BUY_PRICE|CATEGORY|CHANGE|CHANGE_PERCENTAGE|COLLATERAL_F
      ACTOR|CURRENCY|DATE_WHEN_ADDED|DIRECTION|DIVIDENDS_AMOUNT_12_MONTHS|DIVIDENDS_PER_YEAR|EARNINGS_PER_SHARE|END_DATE|E
      TF_ORDINARY_DIRECT_YIELD|ETF_RISK|EV_EBIT_RATIO|FIVE_YEARS_PERFORMANCE|FLAG_CODE|FUND_RATING|FUND_RISK|FUND_TOTAL_MA
      RKET_VALUE|HIGHEST_PRICE|INSTRUMENT_TYPE|LAST_PRICE|LEVERAGE|LOWEST_PRICE|MANAGEMENT_FEE|MARGIN_REQUIREMENT|MARKET_C
      AP|MAX_PERFORMANCE|NAME|NAV|NET_DEBT_TO_EBITDA_RATIO|NEXT_DIVIDEND_AMOUNT|NEXT_DIVIDEND_DATE|NEXT_REPORT_DATE|NUMBER
      _OF_OWNERS|ONE_MONTH_PERFORMANCE|ONE_WEEK_PERFORMANCE|ONE_YEAR_PERFORMANCE|OPTION_TYPE|ORDINARY_DIRECT_YIELD|PRICE_B
      OOK_RATIO|PRICE_EARNINGS_RATIO|PRICE_LAST_UPDATED_DATE|PRICE_LAST_UPDATED_TIME|PRICE_SALES_RATIO|PRICE_WHEN_ADDED|PR
      ODUCT_FEE|RELATIVE_PERFORMANCE_SINCE_ADDED|RETURN_ON_EQUITY|SELL_PRICE|SHARPE_RATIO|SHORT_SELLING_ALLOWED|SIX_MONTHS
      _PERFORMANCE|SPREAD|STANDARD_DEVIATION_PERCENT|STRIKE_PRICE|SUPER_INTEREST_APPROVED|TEN_YEARS_PERFORMANCE|THIS_YEAR_
      PERFORMANCE|THREE_MONTHS_PERFORMANCE|THREE_YEARS_PERFORMANCE|TOTAL_FEE|UNDERLYING_INSTRUMENT_NAME|VALUE_TRADED|VOLAT
      ILITY|VOLUME_TRADED|WARRANT_LEVERAGE|WARRANT_TYPE>

  --fields=<value>
      Select comma-separated JSON fields (dotted paths for nested fields)

  --fixture
      Print the HTTP request and response as a fixture

  --json
      Print the command response as JSON

  --orderbook-ids=<value>
      Comma-separated orderbook IDs; defaults to the whole watchlist

  --output=<value>
      Write the raw fixture to a new temporary file

  --watchlist-id=<value>
      (required) Watchlist ID
```

## `avanza collections watchlist-news` [#avanza-collections-watchlist-news]

List news for instruments in a watchlist

```
USAGE
  $ avanza collections watchlist-news --watchlist-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--orderbook-ids <value>] [--categories <value>]

FLAGS
  --categories=<value>     Comma-separated news categories
  --fields=<value>         Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                Print the HTTP request and response as a fixture
  --json                   Print the command response as JSON
  --orderbook-ids=<value>  Comma-separated orderbook IDs; defaults to the whole watchlist
  --output=<value>         Write the raw fixture to a new temporary file
  --watchlist-id=<value>   (required) Watchlist ID
```

## `avanza collections watchlists` [#avanza-collections-watchlists]

List watchlists

```
USAGE
  $ avanza collections watchlists [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```


# avanza funds (/avanza-ts/docs/cli/reference/funds)



Search, list, and inspect funds

* [`avanza funds chart`](#avanza-funds-chart)
* [`avanza funds chart-periods`](#avanza-funds-chart-periods)
* [`avanza funds description`](#avanza-funds-description)
* [`avanza funds details`](#avanza-funds-details)
* [`avanza funds development`](#avanza-funds-development)
* [`avanza funds favourites`](#avanza-funds-favourites)
* [`avanza funds guide`](#avanza-funds-guide)
* [`avanza funds holdings`](#avanza-funds-holdings)
* [`avanza funds is-favourite`](#avanza-funds-is-favourite)
* [`avanza funds list`](#avanza-funds-list)
* [`avanza funds lookup`](#avanza-funds-lookup)
* [`avanza funds orderbook`](#avanza-funds-orderbook)
* [`avanza funds portfolio`](#avanza-funds-portfolio)
* [`avanza funds reference`](#avanza-funds-reference)
* [`avanza funds regions`](#avanza-funds-regions)
* [`avanza funds search`](#avanza-funds-search)
* [`avanza funds sectors`](#avanza-funds-sectors)
* [`avanza funds sustainability`](#avanza-funds-sustainability)
* [`avanza funds top-ten`](#avanza-funds-top-ten)

## `avanza funds chart` [#avanza-funds-chart]

Read a fund return chart

```
USAGE
  $ avanza funds chart --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       [default: one_year] Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
```

## `avanza funds chart-periods` [#avanza-funds-chart-periods]

List fund returns per chart period

```
USAGE
  $ avanza funds chart-periods --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds description` [#avanza-funds-description]

Read the fund description

```
USAGE
  $ avanza funds description --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds details` [#avanza-funds-details]

Read fund details, fees, and returns

```
USAGE
  $ avanza funds details --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds development` [#avanza-funds-development]

Read fund returns over standard periods

```
USAGE
  $ avanza funds development --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds favourites` [#avanza-funds-favourites]

List saved favourite funds

```
USAGE
  $ avanza funds favourites [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza funds guide` [#avanza-funds-guide]

Read the complete fund page

```
USAGE
  $ avanza funds guide --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds holdings` [#avanza-funds-holdings]

List top fund holdings

```
USAGE
  $ avanza funds holdings --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds is-favourite` [#avanza-funds-is-favourite]

Check whether a fund is saved as a favourite

```
USAGE
  $ avanza funds is-favourite --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds list` [#avanza-funds-list]

List funds by filter, sort order, and page

```
USAGE
  $ avanza funds list [--fields <value> --json] [--output <value> [--fixture | ]] [--name <value>] [--filter
    <value>] [--sort-field <value>] [--order asc|desc] [--offset <value>] [--limit <value>]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>      Filters as JSON, for example {"riskFilter":["2"]}; see filterCounts
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --limit=<value>       [default: 20]
  --name=<value>        Fund name filter
  --offset=<value>
  --order=<option>      [default: desc]
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  [default: developmentThreeYears] Sort field
```

## `avanza funds lookup` [#avanza-funds-lookup]

Look up fund names and orderbook IDs

```
USAGE
  $ avanza funds lookup --query <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
  --query=<value>   (required) Search text
```

## `avanza funds orderbook` [#avanza-funds-orderbook]

Read fund trading terms and NAV

```
USAGE
  $ avanza funds orderbook --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds portfolio` [#avanza-funds-portfolio]

Read fund portfolio by country, holding, and sector

```
USAGE
  $ avanza funds portfolio --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds reference` [#avanza-funds-reference]

Read fund reference data and managers

```
USAGE
  $ avanza funds reference --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds regions` [#avanza-funds-regions]

List fund allocation by region

```
USAGE
  $ avanza funds regions --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds search` [#avanza-funds-search]

Search funds by name

```
USAGE
  $ avanza funds search --name <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --name=<value>    (required) Fund name or part of it
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza funds sectors` [#avanza-funds-sectors]

List fund allocation by sector

```
USAGE
  $ avanza funds sectors --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds sustainability` [#avanza-funds-sustainability]

Read fund sustainability data

```
USAGE
  $ avanza funds sustainability --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Fund orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza funds top-ten` [#avanza-funds-top-ten]

List the top ten funds by a sort field

```
USAGE
  $ avanza funds top-ten [--fields <value> --json] [--output <value> [--fixture | ]] [--sort-field <value>]
    [--order asc|desc] [--type FUND|EXCHANGE_TRADED_FUND|BOTH]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --order=<option>      Sort order
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  Sort field, for example developmentOneYear
  --type=<option>       [default: FUND] Instrument type
                        <options: FUND|EXCHANGE_TRADED_FUND|BOTH>
```


# Command reference (/avanza-ts/docs/cli/reference)



These topic pages are generated from the CLI's command definitions. Each page includes usage, options, and available commands for that topic. Run `avanza <topic> <command> --help` for the same information in your terminal.


# avanza instruments (/avanza-ts/docs/cli/reference/instruments)



Screen stocks and other listed products, and manage stock settings

* [`avanza instruments certificate-options`](#avanza-instruments-certificate-options)
* [`avanza instruments certificates`](#avanza-instruments-certificates)
* [`avanza instruments derivative-options`](#avanza-instruments-derivative-options)
* [`avanza instruments derivatives`](#avanza-instruments-derivatives)
* [`avanza instruments etf-options`](#avanza-instruments-etf-options)
* [`avanza instruments etfs`](#avanza-instruments-etfs)
* [`avanza instruments filters list`](#avanza-instruments-filters-list)
* [`avanza instruments filters save`](#avanza-instruments-filters-save)
* [`avanza instruments gainers-losers`](#avanza-instruments-gainers-losers)
* [`avanza instruments metadata`](#avanza-instruments-metadata)
* [`avanza instruments sectors`](#avanza-instruments-sectors)
* [`avanza instruments stock-options`](#avanza-instruments-stock-options)
* [`avanza instruments stocks`](#avanza-instruments-stocks)
* [`avanza instruments tabs delete`](#avanza-instruments-tabs-delete)
* [`avanza instruments tabs list`](#avanza-instruments-tabs-list)
* [`avanza instruments tabs save`](#avanza-instruments-tabs-save)
* [`avanza instruments theme-stocks`](#avanza-instruments-theme-stocks)
* [`avanza instruments warrant-options`](#avanza-instruments-warrant-options)
* [`avanza instruments warrants`](#avanza-instruments-warrants)

## `avanza instruments certificate-options` [#avanza-instruments-certificate-options]

List certificate filter options

```
USAGE
  $ avanza instruments certificate-options [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments certificates` [#avanza-instruments-certificates]

Screen certificates by filter, sort order, and page

```
USAGE
  $ avanza instruments certificates [--fields <value> --json] [--output <value> [--fixture | ]] [--filter <value>] [--offset
    <value>] [--limit <value>] [--sort-field <value>] [--order asc|desc]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>      Filter as JSON; keys and values from the options command
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --limit=<value>       [default: 20]
  --offset=<value>
  --order=<option>      [default: desc]
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  Sort field; defaults per product
```

## `avanza instruments derivative-options` [#avanza-instruments-derivative-options]

List option, future, and forward filter options

```
USAGE
  $ avanza instruments derivative-options [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments derivatives` [#avanza-instruments-derivatives]

List futures, forwards, and options for an underlying

```
USAGE
  $ avanza instruments derivatives [--fields <value> --json] [--output <value> [--fixture | ]] [--filter <value>] [--offset
    <value>] [--limit <value>] [--sort-field <value>] [--order asc|desc]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>      Filter as JSON; keys and values from the options command
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --limit=<value>       [default: 20]
  --offset=<value>
  --order=<option>      [default: desc]
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  Sort field; defaults per product

DESCRIPTION
  List futures, forwards, and options for an underlying

  Defaults to OMX Stockholm 30 and the nearest expiries. The only supported sort field is strikePrice.
```

## `avanza instruments etf-options` [#avanza-instruments-etf-options]

List ETF filter options

```
USAGE
  $ avanza instruments etf-options [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments etfs` [#avanza-instruments-etfs]

Screen ETFs by filter, sort order, and page

```
USAGE
  $ avanza instruments etfs [--fields <value> --json] [--output <value> [--fixture | ]] [--filter <value>] [--offset
    <value>] [--limit <value>] [--sort-field <value>] [--order asc|desc]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>      Filter as JSON; keys and values from the options command
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --limit=<value>       [default: 20]
  --offset=<value>
  --order=<option>      [default: desc]
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  Sort field; defaults per product
```

## `avanza instruments filters list` [#avanza-instruments-filters-list]

List saved stock screener filters

```
USAGE
  $ avanza instruments filters list [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments filters save` [#avanza-instruments-filters-save]

Replace saved stock screener filters

```
USAGE
  $ avanza instruments filters save --data <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --data=<value>    (required) JSON array of saved filters
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments gainers-losers` [#avanza-instruments-gainers-losers]

List stock market gainers and losers

```
USAGE
  $ avanza instruments gainers-losers [--fields <value> --json] [--output <value> [--fixture | ]] [--filter <value>]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>  Stock filter as JSON
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments metadata` [#avanza-instruments-metadata]

Show signed-in stock screener metadata

```
USAGE
  $ avanza instruments metadata [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments sectors` [#avanza-instruments-sectors]

List stock sectors

```
USAGE
  $ avanza instruments sectors [--fields <value> --json] [--output <value> [--fixture | ]] [--popular]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
  --popular         Show popular sectors only
```

## `avanza instruments stock-options` [#avanza-instruments-stock-options]

Show available stock screener filters

```
USAGE
  $ avanza instruments stock-options [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments stocks` [#avanza-instruments-stocks]

Screen stocks by filter, sort order, and page

```
USAGE
  $ avanza instruments stocks [--fields <value> --json] [--output <value> [--fixture | ]] [--filter <value>] [--offset
    <value>] [--limit <value>] [--sort-field <value>] [--order asc|desc]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>      Stock filter as JSON
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --limit=<value>       [default: 20]
  --offset=<value>
  --order=<option>      [default: desc]
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  [default: numberOfOwners]
```

## `avanza instruments tabs delete` [#avanza-instruments-tabs-delete]

Delete all saved stock screener tabs

```
USAGE
  $ avanza instruments tabs delete [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments tabs list` [#avanza-instruments-tabs-list]

List saved stock screener tabs

```
USAGE
  $ avanza instruments tabs list [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments tabs save` [#avanza-instruments-tabs-save]

Replace saved stock screener tabs

```
USAGE
  $ avanza instruments tabs save --data <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --data=<value>    (required) JSON array of tabs
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments theme-stocks` [#avanza-instruments-theme-stocks]

List themed stocks by orderbook ID

```
USAGE
  $ avanza instruments theme-stocks --orderbook-ids <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--sort-field <value>] [--order asc|desc]

FLAGS
  --fields=<value>         Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                Print the HTTP request and response as a fixture
  --json                   Print the command response as JSON
  --order=<option>         [default: desc]
                           <options: asc|desc>
  --orderbook-ids=<value>  (required) Comma-separated orderbook IDs
  --output=<value>         Write the raw fixture to a new temporary file
  --sort-field=<value>     [default: numberOfOwners]
```

## `avanza instruments warrant-options` [#avanza-instruments-warrant-options]

List warrant filter options

```
USAGE
  $ avanza instruments warrant-options [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza instruments warrants` [#avanza-instruments-warrants]

Screen warrants by filter, sort order, and page

```
USAGE
  $ avanza instruments warrants [--fields <value> --json] [--output <value> [--fixture | ]] [--filter <value>] [--offset
    <value>] [--limit <value>] [--sort-field <value>] [--order asc|desc]

FLAGS
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --filter=<value>      Filter as JSON; keys and values from the options command
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --limit=<value>       [default: 20]
  --offset=<value>
  --order=<option>      [default: desc]
                        <options: asc|desc>
  --output=<value>      Write the raw fixture to a new temporary file
  --sort-field=<value>  Sort field; defaults per product
```


# avanza market (/avanza-ts/docs/cli/reference/market)



Search instruments and read quotes, charts, indices, and ETFs

* [`avanza market analysis`](#avanza-market-analysis)
* [`avanza market broker-trades`](#avanza-market-broker-trades)
* [`avanza market chart`](#avanza-market-chart)
* [`avanza market chart-periods`](#avanza-market-chart-periods)
* [`avanza market company-events`](#avanza-market-company-events)
* [`avanza market constituents`](#avanza-market-constituents)
* [`avanza market data`](#avanza-market-data)
* [`avanza market etf`](#avanza-market-etf)
* [`avanza market etf-details`](#avanza-market-etf-details)
* [`avanza market indices`](#avanza-market-indices)
* [`avanza market insider-trades`](#avanza-market-insider-trades)
* [`avanza market insider-transactions`](#avanza-market-insider-transactions)
* [`avanza market instrument`](#avanza-market-instrument)
* [`avanza market instrument-details`](#avanza-market-instrument-details)
* [`avanza market isin`](#avanza-market-isin)
* [`avanza market market-maker-chart`](#avanza-market-market-maker-chart)
* [`avanza market marketplace`](#avanza-market-marketplace)
* [`avanza market news`](#avanza-market-news)
* [`avanza market order-depth`](#avanza-market-order-depth)
* [`avanza market overviews`](#avanza-market-overviews)
* [`avanza market owners`](#avanza-market-owners)
* [`avanza market price-chart`](#avanza-market-price-chart)
* [`avanza market quote`](#avanza-market-quote)
* [`avanza market search`](#avanza-market-search)
* [`avanza market short-selling`](#avanza-market-short-selling)
* [`avanza market stock`](#avanza-market-stock)
* [`avanza market technical-analysis`](#avanza-market-technical-analysis)
* [`avanza market trades`](#avanza-market-trades)

## `avanza market analysis` [#avanza-market-analysis]

Read key ratios, financials, and dividends by year and quarter

```
USAGE
  $ avanza market analysis --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market broker-trades` [#avanza-market-broker-trades]

Read broker trade summaries for a stock

```
USAGE
  $ avanza market broker-trades --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market chart` [#avanza-market-chart]

Read the relative market overview chart for an orderbook

```
USAGE
  $ avanza market chart --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       [default: today] Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
```

## `avanza market chart-periods` [#avanza-market-chart-periods]

Read price changes per chart period

```
USAGE
  $ avanza market chart-periods --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market company-events` [#avanza-market-company-events]

List report dates for a stock

```
USAGE
  $ avanza market company-events --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity | --from <value>
    | --to <value>]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --from=<value>          Custom range start (yyyy-MM-dd)
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
  --to=<value>            Custom range end (yyyy-MM-dd)
```

## `avanza market constituents` [#avanza-market-constituents]

List the constituents of an index

```
USAGE
  $ avanza market constituents --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market data` [#avanza-market-data]

Read trading market data for an orderbook

```
USAGE
  $ avanza market data --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market etf` [#avanza-market-etf]

Inspect an ETF

```
USAGE
  $ avanza market etf --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market etf-details` [#avanza-market-etf-details]

Read ETF details, exposures, and trading data

```
USAGE
  $ avanza market etf-details --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market indices` [#avanza-market-indices]

Read the header market indices

```
USAGE
  $ avanza market indices [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza market insider-trades` [#avanza-market-insider-trades]

List individual insider transactions

```
USAGE
  $ avanza market insider-trades --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market insider-transactions` [#avanza-market-insider-transactions]

Summarize insider transactions for a stock

```
USAGE
  $ avanza market insider-transactions --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity | --from <value>
    | --to <value>]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --from=<value>          Custom range start (yyyy-MM-dd)
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
  --to=<value>            Custom range end (yyyy-MM-dd)
```

## `avanza market instrument` [#avanza-market-instrument]

Read a certificate, warrant, future, forward, or option

```
USAGE
  $ avanza market instrument --type certificate|warrant|futureforward|option --orderbook-id <value> [--fields <value>
    --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --type=<option>         (required) Product type
                          <options: certificate|warrant|futureforward|option>
```

## `avanza market instrument-details` [#avanza-market-instrument-details]

Read issuer, documents, order depth, and trades for a listed product

```
USAGE
  $ avanza market instrument-details --type certificate|warrant|futureforward|option --orderbook-id <value> [--fields <value>
    --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --type=<option>         (required) Product type
                          <options: certificate|warrant|futureforward|option>
```

## `avanza market isin` [#avanza-market-isin]

Look up an instrument by ISIN

```
USAGE
  $ avanza market isin --isin <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --isin=<value>    (required) ISIN
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza market market-maker-chart` [#avanza-market-market-maker-chart]

Read price history with market maker bid and ask

```
USAGE
  $ avanza market market-maker-chart --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity | --from <value>
    | --to <value>] [--resolution
    minute|two_minutes|five_minutes|ten_minutes|thirty_minutes|hour|day|week|month|quarter]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --from=<value>          Custom range start (yyyy-MM-dd)
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
  --resolution=<option>   Candle resolution; defaults to the period default
                          <options:
                          minute|two_minutes|five_minutes|ten_minutes|thirty_minutes|hour|day|week|month|quarter>
  --to=<value>            Custom range end (yyyy-MM-dd)
```

## `avanza market marketplace` [#avanza-market-marketplace]

Read opening hours and status for the stock market

```
USAGE
  $ avanza market marketplace --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market news` [#avanza-market-news]

List news for an instrument

```
USAGE
  $ avanza market news --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market order-depth` [#avanza-market-order-depth]

Read stock order depth

```
USAGE
  $ avanza market order-depth --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market overviews` [#avanza-market-overviews]

Read market overview layouts

```
USAGE
  $ avanza market overviews [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza market owners` [#avanza-market-owners]

Read the history of Avanza owners

```
USAGE
  $ avanza market owners --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market price-chart` [#avanza-market-price-chart]

Read OHLC price history for an orderbook

```
USAGE
  $ avanza market price-chart --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity | --from <value>
    | --to <value>] [--resolution
    minute|two_minutes|five_minutes|ten_minutes|thirty_minutes|hour|day|week|month|quarter]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --from=<value>          Custom range start (yyyy-MM-dd)
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
  --resolution=<option>   Candle resolution; defaults to the period default
                          <options:
                          minute|two_minutes|five_minutes|ten_minutes|thirty_minutes|hour|day|week|month|quarter>
  --to=<value>            Custom range end (yyyy-MM-dd)
```

## `avanza market quote` [#avanza-market-quote]

Read the latest stock quote

```
USAGE
  $ avanza market quote --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market search` [#avanza-market-search]

Search instruments by name, ticker, or ISIN

```
USAGE
  $ avanza market search --query <value> [--fields <value> --json] [--output <value> [--fixture | ]] [--types
    STOCK|INDEX|FUND|EXCHANGE_TRADED_FUND|CERTIFICATE|WARRANT|TRADING_CURRENCY|BOND|PREMIUM_BOND|EQUITY_LINKED_BOND|OPTI
    ON|SUBSCRIPTION_OPTION|CONVERTIBLE|FUTURE_FORWARD|RIGHT|PAGE|FAQ...] [--offset <value>] [--limit <value>]

FLAGS
  --fields=<value>     Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture            Print the HTTP request and response as a fixture
  --json               Print the command response as JSON
  --limit=<value>
  --offset=<value>
  --output=<value>     Write the raw fixture to a new temporary file
  --query=<value>      (required) Search text
  --types=<option>...  Comma-separated instrument types; defaults to all
                       <options: STOCK|INDEX|FUND|EXCHANGE_TRADED_FUND|CERTIFICATE|WARRANT|TRADING_CURRENCY|BOND|PREMIUM
                       _BOND|EQUITY_LINKED_BOND|OPTION|SUBSCRIPTION_OPTION|CONVERTIBLE|FUTURE_FORWARD|RIGHT|PAGE|FAQ>
```

## `avanza market short-selling` [#avanza-market-short-selling]

Read short-selling history for a stock

```
USAGE
  $ avanza market short-selling --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market stock` [#avanza-market-stock]

Read stock details, key indicators, and quote

```
USAGE
  $ avanza market stock --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza market technical-analysis` [#avanza-market-technical-analysis]

Read OHLC lookback points before a price chart period

```
USAGE
  $ avanza market technical-analysis --orderbook-id <value> --points <value> [--fields <value> --json] [--output <value>
    [--fixture | ]] [--period today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity |
    --from <value> | --to <value>] [--resolution
    minute|two_minutes|five_minutes|ten_minutes|thirty_minutes|hour|day|week|month|quarter]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --from=<value>          Custom range start (yyyy-MM-dd)
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
  --period=<option>       Time period
                          <options:
                          today|one_week|one_month|three_months|this_year|one_year|three_years|five_years|infinity>
  --points=<value>        (required) Number of lookback points
  --resolution=<option>   Candle resolution; defaults to the period default
                          <options:
                          minute|two_minutes|five_minutes|ten_minutes|thirty_minutes|hour|day|week|month|quarter>
  --to=<value>            Custom range end (yyyy-MM-dd)
```

## `avanza market trades` [#avanza-market-trades]

Read the latest stock trades

```
USAGE
  $ avanza market trades --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```


# avanza news (/avanza-ts/docs/cli/reference/news)



Read news articles, the personal news feed, and the event calendar

* [`avanza news article`](#avanza-news-article)
* [`avanza news calendar`](#avanza-news-calendar)
* [`avanza news feed`](#avanza-news-feed)
* [`avanza news offers`](#avanza-news-offers)

## `avanza news article` [#avanza-news-article]

Read a news article

```
USAGE
  $ avanza news article --url <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
  --url=<value>     (required) Article URL or path from the news feed
```

## `avanza news calendar` [#avanza-news-calendar]

List upcoming dividends, reports, and other events by month

```
USAGE
  $ avanza news calendar [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza news feed` [#avanza-news-feed]

List news for held and watched instruments

```
USAGE
  $ avanza news feed [--fields <value> --json] [--output <value> [--fixture | ]] [--limit <value>] [--max-days
    <value>]

FLAGS
  --fields=<value>    Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture           Print the HTTP request and response as a fixture
  --json              Print the command response as JSON
  --limit=<value>     [default: 10] Number of articles
  --max-days=<value>  [default: 30] Maximum article age in days
  --output=<value>    Write the raw fixture to a new temporary file
```

## `avanza news offers` [#avanza-news-offers]

List current offers, such as share issues and IPOs

```
USAGE
  $ avanza news offers [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```


# avanza orders (/avanza-ts/docs/cli/reference/orders)



Read orders, stop-losses, and trading status

* [`avanza orders active-ids`](#avanza-orders-active-ids)
* [`avanza orders bulk-order`](#avanza-orders-bulk-order)
* [`avanza orders bulk-orders`](#avanza-orders-bulk-orders)
* [`avanza orders count`](#avanza-orders-count)
* [`avanza orders deals`](#avanza-orders-deals)
* [`avanza orders exchange-rates`](#avanza-orders-exchange-rates)
* [`avanza orders list`](#avanza-orders-list)
* [`avanza orders market-status`](#avanza-orders-market-status)
* [`avanza orders orderbook`](#avanza-orders-orderbook)
* [`avanza orders stop-loss`](#avanza-orders-stop-loss)
* [`avanza orders stop-losses`](#avanza-orders-stop-losses)

## `avanza orders active-ids` [#avanza-orders-active-ids]

List IDs of active orders

```
USAGE
  $ avanza orders active-ids [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza orders bulk-order` [#avanza-orders-bulk-order]

Read a saved bulk order

```
USAGE
  $ avanza orders bulk-order --bulk-order-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --bulk-order-id=<value>  (required) Bulk order ID
  --fields=<value>         Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                Print the HTTP request and response as a fixture
  --json                   Print the command response as JSON
  --output=<value>         Write the raw fixture to a new temporary file
```

## `avanza orders bulk-orders` [#avanza-orders-bulk-orders]

List saved bulk orders

```
USAGE
  $ avanza orders bulk-orders [--fields <value> --json] [--output <value> [--fixture | ]] [--account-id <value>] [--side
    <value>]

FLAGS
  --account-id=<value>  Account ID; defaults to all
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
  --side=<value>        Order side, for example BUY
```

## `avanza orders count` [#avanza-orders-count]

Count active orders

```
USAGE
  $ avanza orders count [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza orders deals` [#avanza-orders-deals]

List today's deals

```
USAGE
  $ avanza orders deals [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza orders exchange-rates` [#avanza-orders-exchange-rates]

List currency exchange rates

```
USAGE
  $ avanza orders exchange-rates [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza orders list` [#avanza-orders-list]

List open, fund, and cancelled orders

```
USAGE
  $ avanza orders list [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza orders market-status` [#avanza-orders-market-status]

Read whether a market is open

```
USAGE
  $ avanza orders market-status [--fields <value> --json] [--output <value> [--fixture | ]] [--country <value>] [--date
    <value>]

FLAGS
  --country=<value>  [default: SE] Country code, for example SE or US
  --date=<value>     Date (yyyy-MM-dd); defaults to today
  --fields=<value>   Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture          Print the HTTP request and response as a fixture
  --json             Print the command response as JSON
  --output=<value>   Write the raw fixture to a new temporary file
```

## `avanza orders orderbook` [#avanza-orders-orderbook]

Read trading rules for an orderbook

```
USAGE
  $ avanza orders orderbook --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza orders stop-loss` [#avanza-orders-stop-loss]

Read a stop-loss order

```
USAGE
  $ avanza orders stop-loss --account-id <value> --stop-loss-id <value> [--fields <value> --json] [--output <value>
    [--fixture | ]]

FLAGS
  --account-id=<value>    (required) Account URL parameter ID
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --output=<value>        Write the raw fixture to a new temporary file
  --stop-loss-id=<value>  (required) Stop-loss ID
```

## `avanza orders stop-losses` [#avanza-orders-stop-losses]

List active stop-loss orders

```
USAGE
  $ avanza orders stop-losses [--fields <value> --json] [--output <value> [--fixture | ]] [--account-id <value>]
    [--orderbook-id <value>]

FLAGS
  --account-id=<value>    Account ID; defaults to all
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```


# avanza performance (/avanza-ts/docs/cli/reference/performance)



Read account performance and total values

* [`avanza performance chart`](#avanza-performance-chart)
* [`avanza performance insights`](#avanza-performance-insights)
* [`avanza performance total-values`](#avanza-performance-total-values)

## `avanza performance chart` [#avanza-performance-chart]

Read the account performance chart

```
USAGE
  $ avanza performance chart [--fields <value> --json] [--output <value> [--fixture | ]] [--account-ids <value>...]
    [--period TODAY|ONE_WEEK|ONE_MONTH|THREE_MONTHS|THIS_YEAR|ONE_YEAR|THREE_YEARS|FIVE_YEARS|ALL_TIME | --from <value>
    | --to <value>] [--include-closed]

FLAGS
  --account-ids=<value>...  Comma-separated account IDs; defaults to all accounts
  --fields=<value>          Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                 Print the HTTP request and response as a fixture
  --from=<value>            Custom range start (yyyy-MM-dd)
  --include-closed          Include closed accounts
  --json                    Print the command response as JSON
  --output=<value>          Write the raw fixture to a new temporary file
  --period=<option>         Time period
                            <options:
                            TODAY|ONE_WEEK|ONE_MONTH|THREE_MONTHS|THIS_YEAR|ONE_YEAR|THREE_YEARS|FIVE_YEARS|ALL_TIME>
  --to=<value>              Custom range end (yyyy-MM-dd)
```

## `avanza performance insights` [#avanza-performance-insights]

Read what positions earned over a period, including dividends

```
USAGE
  $ avanza performance insights [--fields <value> --json] [--output <value> [--fixture | ]] [--period
    TODAY|ONE_WEEK|THIS_YEAR|THREE_YEARS_ROLLING] [--account-ids <value>...]

FLAGS
  --account-ids=<value>...  Comma-separated account IDs; defaults to all accounts
  --fields=<value>          Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                 Print the HTTP request and response as a fixture
  --json                    Print the command response as JSON
  --output=<value>          Write the raw fixture to a new temporary file
  --period=<option>         [default: THIS_YEAR] Time period
                            <options: TODAY|ONE_WEEK|THIS_YEAR|THREE_YEARS_ROLLING>
```

## `avanza performance total-values` [#avanza-performance-total-values]

Read total values, buying power, and development

```
USAGE
  $ avanza performance total-values [--fields <value> --json] [--output <value> [--fixture | ]] [--account-ids
  <value>...]

FLAGS
  --account-ids=<value>...  Comma-separated account IDs; defaults to all accounts
  --fields=<value>          Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                 Print the HTTP request and response as a fixture
  --json                    Print the command response as JSON
  --output=<value>          Write the raw fixture to a new temporary file
```


# avanza positions (/avanza-ts/docs/cli/reference/positions)



Read positions and statistics

* [`avanza positions countries`](#avanza-positions-countries)
* [`avanza positions list`](#avanza-positions-list)
* [`avanza positions orderbooks`](#avanza-positions-orderbooks)
* [`avanza positions popular-statistics`](#avanza-positions-popular-statistics)
* [`avanza positions statistics`](#avanza-positions-statistics)
* [`avanza positions tools`](#avanza-positions-tools)

## `avanza positions countries` [#avanza-positions-countries]

Read country allocations for positions

```
USAGE
  $ avanza positions countries [--fields <value> --json] [--output <value> [--fixture | ]] [--account-id <value>]

FLAGS
  --account-id=<value>  Optional account URL parameter ID
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza positions list` [#avanza-positions-list]

Read positions

```
USAGE
  $ avanza positions list [--fields <value> --json] [--output <value> [--fixture | ]] [--account-id <value>]

FLAGS
  --account-id=<value>  Optional account URL parameter ID
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza positions orderbooks` [#avanza-positions-orderbooks]

Read orderbook details for positions

```
USAGE
  $ avanza positions orderbooks --orderbook-ids <value>... [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>            Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                   Print the HTTP request and response as a fixture
  --json                      Print the command response as JSON
  --orderbook-ids=<value>...  (required) Comma-separated orderbook IDs
  --output=<value>            Write the raw fixture to a new temporary file
```

## `avanza positions popular-statistics` [#avanza-positions-popular-statistics]

Read popular position statistics for an orderbook

```
USAGE
  $ avanza positions popular-statistics --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture |
  ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza positions statistics` [#avanza-positions-statistics]

Read position statistics for an orderbook

```
USAGE
  $ avanza positions statistics --orderbook-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>        Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture               Print the HTTP request and response as a fixture
  --json                  Print the command response as JSON
  --orderbook-id=<value>  (required) Orderbook ID
  --output=<value>        Write the raw fixture to a new temporary file
```

## `avanza positions tools` [#avanza-positions-tools]

Read active position tools

```
USAGE
  $ avanza positions tools [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```


# avanza savings (/avanza-ts/docs/cli/reference/savings)



Read recurring savings, savings goals, credit, and pensions

* [`avanza savings categories`](#avanza-savings-categories)
* [`avanza savings credit-accounts`](#avanza-savings-credit-accounts)
* [`avanza savings credit-info`](#avanza-savings-credit-info)
* [`avanza savings goal-health`](#avanza-savings-goal-health)
* [`avanza savings goal-performance`](#avanza-savings-goal-performance)
* [`avanza savings payout-plan`](#avanza-savings-payout-plan)
* [`avanza savings payout-plans`](#avanza-savings-payout-plans)
* [`avanza savings pension`](#avanza-savings-pension)
* [`avanza savings pension-distribution`](#avanza-savings-pension-distribution)
* [`avanza savings periodic`](#avanza-savings-periodic)
* [`avanza savings recurring-deposits`](#avanza-savings-recurring-deposits)

## `avanza savings categories` [#avanza-savings-categories]

List savings goals and account categories

```
USAGE
  $ avanza savings categories [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza savings credit-accounts` [#avanza-savings-credit-accounts]

List accounts available for securities credit

```
USAGE
  $ avanza savings credit-accounts [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza savings credit-info` [#avanza-savings-credit-info]

Read credit limit, used credit, and interest per account

```
USAGE
  $ avanza savings credit-info [--fields <value> --json] [--output <value> [--fixture | ]] [--type credited|uncredited]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
  --type=<option>   [default: credited] Accounts with or without securities credit
                    <options: credited|uncredited>
```

## `avanza savings goal-health` [#avanza-savings-goal-health]

Compare savings goal progress with its targets

```
USAGE
  $ avanza savings goal-health --category-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --category-id=<value>  (required) Savings category ID
  --fields=<value>       Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture              Print the HTTP request and response as a fixture
  --json                 Print the command response as JSON
  --output=<value>       Write the raw fixture to a new temporary file
```

## `avanza savings goal-performance` [#avanza-savings-goal-performance]

Read savings goal performance over time

```
USAGE
  $ avanza savings goal-performance --category-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]
    [--period ONE_WEEK|ONE_MONTH|THREE_MONTHS|THIS_YEAR|ONE_YEAR|THREE_YEARS|INFINITY]

FLAGS
  --category-id=<value>  (required) Savings category ID
  --fields=<value>       Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture              Print the HTTP request and response as a fixture
  --json                 Print the command response as JSON
  --output=<value>       Write the raw fixture to a new temporary file
  --period=<option>      [default: ONE_YEAR] Time period
                         <options: ONE_WEEK|ONE_MONTH|THREE_MONTHS|THIS_YEAR|ONE_YEAR|THREE_YEARS|INFINITY>
```

## `avanza savings payout-plan` [#avanza-savings-payout-plan]

Read the payout plan for a pension account

```
USAGE
  $ avanza savings payout-plan --account-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --account-id=<value>  (required) Numeric pension account ID
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza savings payout-plans` [#avanza-savings-payout-plans]

List pension payout plans

```
USAGE
  $ avanza savings payout-plans [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza savings pension` [#avanza-savings-pension]

Read pension insurance details

```
USAGE
  $ avanza savings pension --account-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --account-id=<value>  (required) Numeric pension account ID
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza savings pension-distribution` [#avanza-savings-pension-distribution]

Read fund allocation for pension premiums

```
USAGE
  $ avanza savings pension-distribution --account-id <value> [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --account-id=<value>  (required) Numeric pension account ID
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza savings periodic` [#avanza-savings-periodic]

List monthly fund savings

```
USAGE
  $ avanza savings periodic [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza savings recurring-deposits` [#avanza-savings-recurring-deposits]

List recurring deposits

```
USAGE
  $ avanza savings recurring-deposits [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```


# avanza transactions (/avanza-ts/docs/cli/reference/transactions)



Read transactions and dividends

* [`avanza transactions dividends`](#avanza-transactions-dividends)
* [`avanza transactions list`](#avanza-transactions-list)
* [`avanza transactions pending`](#avanza-transactions-pending)
* [`avanza transactions show`](#avanza-transactions-show)
* [`avanza transactions upcoming-dividends`](#avanza-transactions-upcoming-dividends)

## `avanza transactions dividends` [#avanza-transactions-dividends]

List received dividends

```
USAGE
  $ avanza transactions dividends [--fields <value> --json] [--output <value> [--fixture | ]] [--account-id <value>]
    [--include-closed]

FLAGS
  --account-id=<value>  Account URL parameter ID; defaults to all
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --include-closed      Include closed accounts
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```

## `avanza transactions list` [#avanza-transactions-list]

List transactions

```
USAGE
  $ avanza transactions list [--fields <value> --json] [--output <value> [--fixture | ]] [--from <value>] [--to
    <value>] [--account-ids <value>...] [--types <value>...] [--isin <value>] [--include-cancelled] [--include-closed]

FLAGS
  --account-ids=<value>...  Comma-separated account IDs
  --fields=<value>          Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                 Print the HTTP request and response as a fixture
  --from=<value>            Start date (yyyy-MM-dd); defaults to one year back
  --include-cancelled       Include cancelled transactions
  --include-closed          Include closed accounts
  --isin=<value>            Instrument ISIN
  --json                    Print the command response as JSON
  --output=<value>          Write the raw fixture to a new temporary file
  --to=<value>              End date (yyyy-MM-dd); defaults to today
  --types=<value>...        Comma-separated transaction types, for example BUY,SELL,DIVIDEND
```

## `avanza transactions pending` [#avanza-transactions-pending]

List pending withdrawals and internal transfers

```
USAGE
  $ avanza transactions pending [--fields <value> --json] [--output <value> [--fixture | ]]

FLAGS
  --fields=<value>  Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture         Print the HTTP request and response as a fixture
  --json            Print the command response as JSON
  --output=<value>  Write the raw fixture to a new temporary file
```

## `avanza transactions show` [#avanza-transactions-show]

Inspect one transaction

```
USAGE
  $ avanza transactions show --account-id <value> --transaction-id <value> [--fields <value> --json] [--output <value>
    [--fixture | ]]

FLAGS
  --account-id=<value>      (required) Account ID or URL parameter ID
  --fields=<value>          Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture                 Print the HTTP request and response as a fixture
  --json                    Print the command response as JSON
  --output=<value>          Write the raw fixture to a new temporary file
  --transaction-id=<value>  (required) Transaction ID
```

## `avanza transactions upcoming-dividends` [#avanza-transactions-upcoming-dividends]

List upcoming dividends for held positions

```
USAGE
  $ avanza transactions upcoming-dividends [--fields <value> --json] [--output <value> [--fixture | ]] [--account-id
  <value>]

FLAGS
  --account-id=<value>  Account URL parameter ID; defaults to all
  --fields=<value>      Select comma-separated JSON fields (dotted paths for nested fields)
  --fixture             Print the HTTP request and response as a fixture
  --json                Print the command response as JSON
  --output=<value>      Write the raw fixture to a new temporary file
```


# Exported API (/avanza-ts/docs/sdk/reference/generated)



## Classes [#classes]

* [AvanzaAuthenticationError](./classes/AvanzaAuthenticationError.md)
* [AvanzaAuthenticationRequiredError](./classes/AvanzaAuthenticationRequiredError.md)
* [AvanzaClient](./classes/AvanzaClient.md)
* [AvanzaError](./classes/AvanzaError.md)
* [AvanzaHttpError](./classes/AvanzaHttpError.md)

## Interfaces [#interfaces]

* [AccountAmount](./interfaces/AccountAmount.md)
* [AccountCategoriesResponse](./interfaces/AccountCategoriesResponse.md)
* [AccountCategory](./interfaces/AccountCategory.md)
* [AccountOverviewResponse](./interfaces/AccountOverviewResponse.md)
* [AccountsClient](./interfaces/AccountsClient.md)
* [AccountSummary](./interfaces/AccountSummary.md)
* [ActivePositionTool](./interfaces/ActivePositionTool.md)
* [AlertsResponse](./interfaces/AlertsResponse.md)
* [AnalysisPoint](./interfaces/AnalysisPoint.md)
* [AuthClient](./interfaces/AuthClient.md)
* [AvanzaClientOptions](./interfaces/AvanzaClientOptions.md)
* [AvanzaCookie](./interfaces/AvanzaCookie.md)
* [BankIdAuthAttempt](./interfaces/BankIdAuthAttempt.md)
* [BankIdChallenge](./interfaces/BankIdChallenge.md)
* [BankIdSession](./interfaces/BankIdSession.md)
* [BrokerTradeSummary](./interfaces/BrokerTradeSummary.md)
* [BulkOrder](./interfaces/BulkOrder.md)
* [BulkOrderOptions](./interfaces/BulkOrderOptions.md)
* [BulkOrdersResponse](./interfaces/BulkOrdersResponse.md)
* [BuyingPower](./interfaces/BuyingPower.md)
* [CalendarDividend](./interfaces/CalendarDividend.md)
* [CalendarMonth](./interfaces/CalendarMonth.md)
* [CalendarOrderbook](./interfaces/CalendarOrderbook.md)
* [CalendarReport](./interfaces/CalendarReport.md)
* [CategorizedAccountOverviewResponse](./interfaces/CategorizedAccountOverviewResponse.md)
* [ChartPeriodChange](./interfaces/ChartPeriodChange.md)
* [ClosedAccount](./interfaces/ClosedAccount.md)
* [CollectionsClient](./interfaces/CollectionsClient.md)
* [CompanyEvent](./interfaces/CompanyEvent.md)
* [CompanyReport](./interfaces/CompanyReport.md)
* [CreditAccountsResponse](./interfaces/CreditAccountsResponse.md)
* [CreditInfo](./interfaces/CreditInfo.md)
* [CreditInfoResponse](./interfaces/CreditInfoResponse.md)
* [CurrencyBalance](./interfaces/CurrencyBalance.md)
* [DealsResponse](./interfaces/DealsResponse.md)
* [Dividend](./interfaces/Dividend.md)
* [DividendAmount](./interfaces/DividendAmount.md)
* [DividendOptions](./interfaces/DividendOptions.md)
* [EtfDetailsResponse](./interfaces/EtfDetailsResponse.md)
* [EtfResponse](./interfaces/EtfResponse.md)
* [EtfUnderlying](./interfaces/EtfUnderlying.md)
* [ExchangeRate](./interfaces/ExchangeRate.md)
* [Exposures](./interfaces/Exposures.md)
* [FundChartResponse](./interfaces/FundChartResponse.md)
* [FundDescription](./interfaces/FundDescription.md)
* [FundDevelopment](./interfaces/FundDevelopment.md)
* [FundFilterCount](./interfaces/FundFilterCount.md)
* [FundGuide](./interfaces/FundGuide.md)
* [FundInstrumentSearchResponse](./interfaces/FundInstrumentSearchResponse.md)
* [FundListOptions](./interfaces/FundListOptions.md)
* [FundListResponse](./interfaces/FundListResponse.md)
* [FundListView](./interfaces/FundListView.md)
* [FundNamedValue](./interfaces/FundNamedValue.md)
* [FundOrderbook](./interfaces/FundOrderbook.md)
* [FundOrderbookDetails](./interfaces/FundOrderbookDetails.md)
* [FundPieChartPoint](./interfaces/FundPieChartPoint.md)
* [FundPortfolioData](./interfaces/FundPortfolioData.md)
* [FundPortfolioPoint](./interfaces/FundPortfolioPoint.md)
* [FundProductInvolvement](./interfaces/FundProductInvolvement.md)
* [FundRatingView](./interfaces/FundRatingView.md)
* [FundReference](./interfaces/FundReference.md)
* [FundsClient](./interfaces/FundsClient.md)
* [FundSearchResponse](./interfaces/FundSearchResponse.md)
* [FundSearchView](./interfaces/FundSearchView.md)
* [FundSustainability](./interfaces/FundSustainability.md)
* [FundTopListView](./interfaces/FundTopListView.md)
* [FundTopTenOptions](./interfaces/FundTopTenOptions.md)
* [FundTopTenResponse](./interfaces/FundTopTenResponse.md)
* [GainersLosersResponse](./interfaces/GainersLosersResponse.md)
* [HasClosedAccountsResponse](./interfaces/HasClosedAccountsResponse.md)
* [HeaderIndex](./interfaces/HeaderIndex.md)
* [HeaderIndicesResponse](./interfaces/HeaderIndicesResponse.md)
* [IndexConstituent](./interfaces/IndexConstituent.md)
* [InsiderTrade](./interfaces/InsiderTrade.md)
* [InsiderTradesResponse](./interfaces/InsiderTradesResponse.md)
* [InsiderTransactionSummary](./interfaces/InsiderTransactionSummary.md)
* [InsightsInstrumentGroup](./interfaces/InsightsInstrumentGroup.md)
* [InsightsInstrumentLink](./interfaces/InsightsInstrumentLink.md)
* [InsightsOutcome](./interfaces/InsightsOutcome.md)
* [InsightsPosition](./interfaces/InsightsPosition.md)
* [InsightsReport](./interfaces/InsightsReport.md)
* [InstrumentByIsinResponse](./interfaces/InstrumentByIsinResponse.md)
* [InstrumentLink](./interfaces/InstrumentLink.md)
* [InstrumentNewsArticle](./interfaces/InstrumentNewsArticle.md)
* [InstrumentNewsResponse](./interfaces/InstrumentNewsResponse.md)
* [InstrumentsClient](./interfaces/InstrumentsClient.md)
* [InstrumentUnderlying](./interfaces/InstrumentUnderlying.md)
* [InsuranceParty](./interfaces/InsuranceParty.md)
* [LightweightAccount](./interfaces/LightweightAccount.md)
* [ListedInstrument](./interfaces/ListedInstrument.md)
* [ListedInstrumentDetails](./interfaces/ListedInstrumentDetails.md)
* [ListedProductFilterOption](./interfaces/ListedProductFilterOption.md)
* [Listing](./interfaces/Listing.md)
* [MarketClient](./interfaces/MarketClient.md)
* [MarketDataResponse](./interfaces/MarketDataResponse.md)
* [MarketMakerChartResponse](./interfaces/MarketMakerChartResponse.md)
* [MarketOverview](./interfaces/MarketOverview.md)
* [MarketOverviewWidget](./interfaces/MarketOverviewWidget.md)
* [MarketplaceStatus](./interfaces/MarketplaceStatus.md)
* [MarketTrade](./interfaces/MarketTrade.md)
* [MatrixFutureForward](./interfaces/MatrixFutureForward.md)
* [MatrixOption](./interfaces/MatrixOption.md)
* [MoneyAmount](./interfaces/MoneyAmount.md)
* [MoverStock](./interfaces/MoverStock.md)
* [NewsArticle](./interfaces/NewsArticle.md)
* [NewsArticleOrderbook](./interfaces/NewsArticleOrderbook.md)
* [NewsClient](./interfaces/NewsClient.md)
* [NewsFeedItem](./interfaces/NewsFeedItem.md)
* [NewsFeedOptions](./interfaces/NewsFeedOptions.md)
* [NewsFeedOrderbook](./interfaces/NewsFeedOrderbook.md)
* [NewsFeedResponse](./interfaces/NewsFeedResponse.md)
* [Note](./interfaces/Note.md)
* [NoteOrderbook](./interfaces/NoteOrderbook.md)
* [NumberOfOwnersResponse](./interfaces/NumberOfOwnersResponse.md)
* [Ohlc](./interfaces/Ohlc.md)
* [OrderCount](./interfaces/OrderCount.md)
* [OrderDepth](./interfaces/OrderDepth.md)
* [OrderDepthLevel](./interfaces/OrderDepthLevel.md)
* [OrderDepthSide](./interfaces/OrderDepthSide.md)
* [OrdersClient](./interfaces/OrdersClient.md)
* [OrdersResponse](./interfaces/OrdersResponse.md)
* [OverviewChartResponse](./interfaces/OverviewChartResponse.md)
* [PendingTransactionsResponse](./interfaces/PendingTransactionsResponse.md)
* [PensionDetails](./interfaces/PensionDetails.md)
* [PensionDistribution](./interfaces/PensionDistribution.md)
* [PerformanceChartOptions](./interfaces/PerformanceChartOptions.md)
* [PerformanceChartResponse](./interfaces/PerformanceChartResponse.md)
* [PerformanceClient](./interfaces/PerformanceClient.md)
* [PerformanceDateRange](./interfaces/PerformanceDateRange.md)
* [PerformanceDevelopment](./interfaces/PerformanceDevelopment.md)
* [PerformancePoint](./interfaces/PerformancePoint.md)
* [PeriodicSavingsResponse](./interfaces/PeriodicSavingsResponse.md)
* [PopularStockSector](./interfaces/PopularStockSector.md)
* [PositionCategoriesResponse](./interfaces/PositionCategoriesResponse.md)
* [PositionCountryAllocation](./interfaces/PositionCountryAllocation.md)
* [PositionOrderbook](./interfaces/PositionOrderbook.md)
* [PositionPopularCategoriesResponse](./interfaces/PositionPopularCategoriesResponse.md)
* [PositionsClient](./interfaces/PositionsClient.md)
* [PriceChartOptions](./interfaces/PriceChartOptions.md)
* [PriceChartResponse](./interfaces/PriceChartResponse.md)
* [RecurringDepositsResponse](./interfaces/RecurringDepositsResponse.md)
* [SavedStockFilter](./interfaces/SavedStockFilter.md)
* [SavedStockFiltersResponse](./interfaces/SavedStockFiltersResponse.md)
* [SavingsCategory](./interfaces/SavingsCategory.md)
* [SavingsCategoryAccount](./interfaces/SavingsCategoryAccount.md)
* [SavingsClient](./interfaces/SavingsClient.md)
* [SavingsGoalHealth](./interfaces/SavingsGoalHealth.md)
* [SavingsGoalPerformance](./interfaces/SavingsGoalPerformance.md)
* [SavingsGoalPoint](./interfaces/SavingsGoalPoint.md)
* [ScreenedCertificate](./interfaces/ScreenedCertificate.md)
* [ScreenedEtf](./interfaces/ScreenedEtf.md)
* [ScreenedStock](./interfaces/ScreenedStock.md)
* [ScreenedWarrant](./interfaces/ScreenedWarrant.md)
* [ScreenListedProductsOptions](./interfaces/ScreenListedProductsOptions.md)
* [ScreenStocksOptions](./interfaces/ScreenStocksOptions.md)
* [ScreenStocksResponse](./interfaces/ScreenStocksResponse.md)
* [SearchHit](./interfaces/SearchHit.md)
* [SearchHitPrice](./interfaces/SearchHitPrice.md)
* [SearchHitSector](./interfaces/SearchHitSector.md)
* [SearchOptions](./interfaces/SearchOptions.md)
* [SearchResponse](./interfaces/SearchResponse.md)
* [SessionInfoResponse](./interfaces/SessionInfoResponse.md)
* [ShortSellingPoint](./interfaces/ShortSellingPoint.md)
* [ShortSellingResponse](./interfaces/ShortSellingResponse.md)
* [StartBankIdOptions](./interfaces/StartBankIdOptions.md)
* [StockAnalysis](./interfaces/StockAnalysis.md)
* [StockFilter](./interfaces/StockFilter.md)
* [StockFilterOption](./interfaces/StockFilterOption.md)
* [StockFilterOptions](./interfaces/StockFilterOptions.md)
* [StockFilterRange](./interfaces/StockFilterRange.md)
* [StockInfo](./interfaces/StockInfo.md)
* [StockQuote](./interfaces/StockQuote.md)
* [StockScreenerMetadataResponse](./interfaces/StockScreenerMetadataResponse.md)
* [StockScreenerTab](./interfaces/StockScreenerTab.md)
* [StockScreenerTabsResponse](./interfaces/StockScreenerTabsResponse.md)
* [StockSector](./interfaces/StockSector.md)
* [StockSectorGroup](./interfaces/StockSectorGroup.md)
* [StockSort](./interfaces/StockSort.md)
* [StopLoss](./interfaces/StopLoss.md)
* [StopLossOptions](./interfaces/StopLossOptions.md)
* [ThemeStocksResponse](./interfaces/ThemeStocksResponse.md)
* [TotalValue](./interfaces/TotalValue.md)
* [TotalValuesAccount](./interfaces/TotalValuesAccount.md)
* [TotalValuesResponse](./interfaces/TotalValuesResponse.md)
* [TotpCodeLoginOptions](./interfaces/TotpCodeLoginOptions.md)
* [TotpSecretLoginOptions](./interfaces/TotpSecretLoginOptions.md)
* [TotpSession](./interfaces/TotpSession.md)
* [TradingAccount](./interfaces/TradingAccount.md)
* [TradingOrderbook](./interfaces/TradingOrderbook.md)
* [TradingPosition](./interfaces/TradingPosition.md)
* [Transaction](./interfaces/Transaction.md)
* [TransactionListFilter](./interfaces/TransactionListFilter.md)
* [TransactionListResponse](./interfaces/TransactionListResponse.md)
* [TransactionOrderbook](./interfaces/TransactionOrderbook.md)
* [TransactionsClient](./interfaces/TransactionsClient.md)
* [UnderlyingInstrument](./interfaces/UnderlyingInstrument.md)
* [UpcomingDividend](./interfaces/UpcomingDividend.md)
* [Watchlist](./interfaces/Watchlist.md)
* [WatchlistNewsItem](./interfaces/WatchlistNewsItem.md)
* [WatchlistNewsOptions](./interfaces/WatchlistNewsOptions.md)
* [WatchlistNewsResponse](./interfaces/WatchlistNewsResponse.md)
* [WatchlistOrderbook](./interfaces/WatchlistOrderbook.md)
* [WatchlistRow](./interfaces/WatchlistRow.md)
* [WebSocketClient](./interfaces/WebSocketClient.md)

## Type Aliases [#type-aliases]

* [AccountListResponse](./type-aliases/AccountListResponse.md)
* [ActivePositionToolsResponse](./type-aliases/ActivePositionToolsResponse.md)
* [Alert](./type-aliases/Alert.md)
* [AnalysisSeries](./type-aliases/AnalysisSeries.md)
* [AnalysisSummary](./type-aliases/AnalysisSummary.md)
* [AvanzaAuthenticationErrorCode](./type-aliases/AvanzaAuthenticationErrorCode.md)
* [AvanzaSession](./type-aliases/AvanzaSession.md)
* [BankIdPollResult](./type-aliases/BankIdPollResult.md)
* [CalendarResponse](./type-aliases/CalendarResponse.md)
* [ChartPeriod](./type-aliases/ChartPeriod.md)
* [ChartResolution](./type-aliases/ChartResolution.md)
* [ClosedAccountsResponse](./type-aliases/ClosedAccountsResponse.md)
* [CreditType](./type-aliases/CreditType.md)
* [DealItem](./type-aliases/DealItem.md)
* [DividendsResponse](./type-aliases/DividendsResponse.md)
* [FundInstrumentType](./type-aliases/FundInstrumentType.md)
* [FundSortDirection](./type-aliases/FundSortDirection.md)
* [HistoricalClosingPrices](./type-aliases/HistoricalClosingPrices.md)
* [InsightsPeriod](./type-aliases/InsightsPeriod.md)
* [LightweightAccountsResponse](./type-aliases/LightweightAccountsResponse.md)
* [ListedInstrumentType](./type-aliases/ListedInstrumentType.md)
* [ListedProductFilter](./type-aliases/ListedProductFilter.md)
* [ListedProductFilterOptions](./type-aliases/ListedProductFilterOptions.md)
* [MarketStatus](./type-aliases/MarketStatus.md)
* [OrderItem](./type-aliases/OrderItem.md)
* [PerformancePeriod](./type-aliases/PerformancePeriod.md)
* [PositionCountriesResponse](./type-aliases/PositionCountriesResponse.md)
* [PositionListResponse](./type-aliases/PositionListResponse.md)
* [PositionOrderbooksResponse](./type-aliases/PositionOrderbooksResponse.md)
* [PriceChartPeriod](./type-aliases/PriceChartPeriod.md)
* [SavingsGoalPeriod](./type-aliases/SavingsGoalPeriod.md)
* [ScreenCertificatesResponse](./type-aliases/ScreenCertificatesResponse.md)
* [ScreenDerivativesResponse](./type-aliases/ScreenDerivativesResponse.md)
* [ScreenEtfsResponse](./type-aliases/ScreenEtfsResponse.md)
* [ScreenListedProductsResponse](./type-aliases/ScreenListedProductsResponse.md)
* [ScreenWarrantsResponse](./type-aliases/ScreenWarrantsResponse.md)
* [SearchInstrumentType](./type-aliases/SearchInstrumentType.md)
* [StockMetric](./type-aliases/StockMetric.md)
* [TotpLoginOptions](./type-aliases/TotpLoginOptions.md)
* [TradingAccountsResponse](./type-aliases/TradingAccountsResponse.md)
* [UnverifiedItem](./type-aliases/UnverifiedItem.md)
* [UpcomingDividendsResponse](./type-aliases/UpcomingDividendsResponse.md)
* [WatchlistDataPoint](./type-aliases/WatchlistDataPoint.md)

## Variables [#variables]

* [chartPeriods](./variables/chartPeriods.md)
* [chartResolutions](./variables/chartResolutions.md)
* [insightsPeriods](./variables/insightsPeriods.md)
* [listedInstrumentTypes](./variables/listedInstrumentTypes.md)
* [performancePeriods](./variables/performancePeriods.md)
* [savedFiltersSchema](./variables/savedFiltersSchema.md)
* [savingsGoalPeriods](./variables/savingsGoalPeriods.md)
* [screenerTabsSchema](./variables/screenerTabsSchema.md)
* [searchInstrumentTypes](./variables/searchInstrumentTypes.md)
* [stockFilterSchema](./variables/stockFilterSchema.md)
* [watchlistDataPoints](./variables/watchlistDataPoints.md)


# Class: AvanzaAuthenticationError (/avanza-ts/docs/sdk/reference/generated/classes/AvanzaAuthenticationError)



## Extends [#extends]

* [`AvanzaError`](./AvanzaError.md)

## Constructors [#constructors]

### Constructor [#constructor]

> **new AvanzaAuthenticationError**(`options`): `AvanzaAuthenticationError`

#### Parameters [#parameters]

##### options [#options]

`AvanzaAuthenticationErrorOptions`

#### Returns [#returns]

`AvanzaAuthenticationError`

#### Overrides [#overrides]

[`AvanzaError`](./AvanzaError.md).[`constructor`](./AvanzaError.md#constructor)

## Properties [#properties]

### cause? [#cause]

> `optional` &#x2A;*cause?**: `unknown`

#### Inherited from [#inherited-from]

[`AvanzaError`](./AvanzaError.md).[`cause`](./AvanzaError.md#cause)

***

### code [#code]

> `readonly` **code**: [`AvanzaAuthenticationErrorCode`](../type-aliases/AvanzaAuthenticationErrorCode.md)

***

### message [#message]

> **message**: `string`

#### Inherited from [#inherited-from-1]

[`AvanzaError`](./AvanzaError.md).[`message`](./AvanzaError.md#message)

***

### name [#name]

> **name**: `string`

#### Inherited from [#inherited-from-2]

[`AvanzaError`](./AvanzaError.md).[`name`](./AvanzaError.md#name)

***

### stack? [#stack]

> `optional` &#x2A;*stack?**: `string`

#### Inherited from [#inherited-from-3]

[`AvanzaError`](./AvanzaError.md).[`stack`](./AvanzaError.md#stack)

***

### upstreamStatus [#upstreamstatus]

> `readonly` **upstreamStatus**: `number` | `undefined`

***

### stackTraceLimit [#stacktracelimit]

> `static` **stackTraceLimit**: `number`

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from [#inherited-from-4]

[`AvanzaError`](./AvanzaError.md).[`stackTraceLimit`](./AvanzaError.md#stacktracelimit)

## Methods [#methods]

### captureStackTrace() [#capturestacktrace]

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters-1]

##### targetObject [#targetobject]

`object`

##### constructorOpt? [#constructoropt]

`Function`

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-5]

[`AvanzaError`](./AvanzaError.md).[`captureStackTrace`](./AvanzaError.md#capturestacktrace)

***

### prepareStackTrace() [#preparestacktrace]

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

#### Parameters [#parameters-2]

##### err [#err]

`Error`

##### stackTraces [#stacktraces]

`CallSite`\[]

#### Returns [#returns-2]

`any`

#### See [#see]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Inherited from [#inherited-from-6]

[`AvanzaError`](./AvanzaError.md).[`prepareStackTrace`](./AvanzaError.md#preparestacktrace)


# Class: AvanzaAuthenticationRequiredError (/avanza-ts/docs/sdk/reference/generated/classes/AvanzaAuthenticationRequiredError)



## Extends [#extends]

* [`AvanzaError`](./AvanzaError.md)

## Constructors [#constructors]

### Constructor [#constructor]

> **new AvanzaAuthenticationRequiredError**(): `AvanzaAuthenticationRequiredError`

#### Returns [#returns]

`AvanzaAuthenticationRequiredError`

#### Overrides [#overrides]

[`AvanzaError`](./AvanzaError.md).[`constructor`](./AvanzaError.md#constructor)

## Properties [#properties]

### cause? [#cause]

> `optional` &#x2A;*cause?**: `unknown`

#### Inherited from [#inherited-from]

[`AvanzaError`](./AvanzaError.md).[`cause`](./AvanzaError.md#cause)

***

### message [#message]

> **message**: `string`

#### Inherited from [#inherited-from-1]

[`AvanzaError`](./AvanzaError.md).[`message`](./AvanzaError.md#message)

***

### name [#name]

> **name**: `string`

#### Inherited from [#inherited-from-2]

[`AvanzaError`](./AvanzaError.md).[`name`](./AvanzaError.md#name)

***

### stack? [#stack]

> `optional` &#x2A;*stack?**: `string`

#### Inherited from [#inherited-from-3]

[`AvanzaError`](./AvanzaError.md).[`stack`](./AvanzaError.md#stack)

***

### stackTraceLimit [#stacktracelimit]

> `static` **stackTraceLimit**: `number`

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from [#inherited-from-4]

[`AvanzaError`](./AvanzaError.md).[`stackTraceLimit`](./AvanzaError.md#stacktracelimit)

## Methods [#methods]

### captureStackTrace() [#capturestacktrace]

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters]

##### targetObject [#targetobject]

`object`

##### constructorOpt? [#constructoropt]

`Function`

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-5]

[`AvanzaError`](./AvanzaError.md).[`captureStackTrace`](./AvanzaError.md#capturestacktrace)

***

### prepareStackTrace() [#preparestacktrace]

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

#### Parameters [#parameters-1]

##### err [#err]

`Error`

##### stackTraces [#stacktraces]

`CallSite`\[]

#### Returns [#returns-2]

`any`

#### See [#see]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Inherited from [#inherited-from-6]

[`AvanzaError`](./AvanzaError.md).[`prepareStackTrace`](./AvanzaError.md#preparestacktrace)


# Class: AvanzaClient (/avanza-ts/docs/sdk/reference/generated/classes/AvanzaClient)



## Constructors [#constructors]

### Constructor [#constructor]

> **new AvanzaClient**(`options?`): `AvanzaClient`

#### Parameters [#parameters]

##### options? [#options]

[`AvanzaClientOptions`](../interfaces/AvanzaClientOptions.md) = `{}`

#### Returns [#returns]

`AvanzaClient`

## Properties [#properties]

### accounts [#accounts]

> `readonly` **accounts**: [`AccountsClient`](../interfaces/AccountsClient.md)

***

### auth [#auth]

> `readonly` **auth**: [`AuthClient`](../interfaces/AuthClient.md)

***

### collections [#collections]

> `readonly` **collections**: [`CollectionsClient`](../interfaces/CollectionsClient.md)

***

### funds [#funds]

> `readonly` **funds**: [`FundsClient`](../interfaces/FundsClient.md)

***

### instruments [#instruments]

> `readonly` **instruments**: [`InstrumentsClient`](../interfaces/InstrumentsClient.md)

***

### market [#market]

> `readonly` **market**: [`MarketClient`](../interfaces/MarketClient.md)

***

### news [#news]

> `readonly` **news**: [`NewsClient`](../interfaces/NewsClient.md)

***

### orders [#orders]

> `readonly` **orders**: [`OrdersClient`](../interfaces/OrdersClient.md)

***

### performance [#performance]

> `readonly` **performance**: [`PerformanceClient`](../interfaces/PerformanceClient.md)

***

### positions [#positions]

> `readonly` **positions**: [`PositionsClient`](../interfaces/PositionsClient.md)

***

### savings [#savings]

> `readonly` **savings**: [`SavingsClient`](../interfaces/SavingsClient.md)

***

### transactions [#transactions]

> `readonly` **transactions**: [`TransactionsClient`](../interfaces/TransactionsClient.md)

***

### websocket [#websocket]

> `readonly` **websocket**: [`WebSocketClient`](../interfaces/WebSocketClient.md)

## Accessors [#accessors]

### session [#session]

#### Get Signature [#get-signature]

> **get** **session**(): [`AvanzaSession`](../type-aliases/AvanzaSession.md) | `undefined`

##### Returns [#returns-1]

[`AvanzaSession`](../type-aliases/AvanzaSession.md) | `undefined`

## Methods [#methods]

### clearSession() [#clearsession]

> **clearSession**(): `void`

#### Returns [#returns-2]

`void`

***

### setSession() [#setsession]

> **setSession**(`session`): `void`

#### Parameters [#parameters-1]

##### session [#session-1]

[`AvanzaSession`](../type-aliases/AvanzaSession.md)

#### Returns [#returns-3]

`void`


# Class: AvanzaError (/avanza-ts/docs/sdk/reference/generated/classes/AvanzaError)



## Extends [#extends]

* `Error`

## Extended by [#extended-by]

* [`AvanzaAuthenticationError`](./AvanzaAuthenticationError.md)
* [`AvanzaAuthenticationRequiredError`](./AvanzaAuthenticationRequiredError.md)
* [`AvanzaHttpError`](./AvanzaHttpError.md)

## Constructors [#constructors]

### Constructor [#constructor]

> **new AvanzaError**(`message`, `options?`): `AvanzaError`

#### Parameters [#parameters]

##### message [#message]

`string`

##### options? [#options]

`ErrorOptions`

#### Returns [#returns]

`AvanzaError`

#### Overrides [#overrides]

`Error.constructor`

## Properties [#properties]

### cause? [#cause]

> `optional` &#x2A;*cause?**: `unknown`

#### Inherited from [#inherited-from]

`Error.cause`

***

### message [#message-1]

> **message**: `string`

#### Inherited from [#inherited-from-1]

`Error.message`

***

### name [#name]

> **name**: `string`

#### Inherited from [#inherited-from-2]

`Error.name`

***

### stack? [#stack]

> `optional` &#x2A;*stack?**: `string`

#### Inherited from [#inherited-from-3]

`Error.stack`

***

### stackTraceLimit [#stacktracelimit]

> `static` **stackTraceLimit**: `number`

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from [#inherited-from-4]

`Error.stackTraceLimit`

## Methods [#methods]

### captureStackTrace() [#capturestacktrace]

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters-1]

##### targetObject [#targetobject]

`object`

##### constructorOpt? [#constructoropt]

`Function`

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-5]

`Error.captureStackTrace`

***

### prepareStackTrace() [#preparestacktrace]

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

#### Parameters [#parameters-2]

##### err [#err]

`Error`

##### stackTraces [#stacktraces]

`CallSite`\[]

#### Returns [#returns-2]

`any`

#### See [#see]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Inherited from [#inherited-from-6]

`Error.prepareStackTrace`


# Class: AvanzaHttpError (/avanza-ts/docs/sdk/reference/generated/classes/AvanzaHttpError)



## Extends [#extends]

* [`AvanzaError`](./AvanzaError.md)

## Constructors [#constructors]

### Constructor [#constructor]

> **new AvanzaHttpError**(`options`): `AvanzaHttpError`

#### Parameters [#parameters]

##### options [#options]

`AvanzaHttpErrorOptions`

#### Returns [#returns]

`AvanzaHttpError`

#### Overrides [#overrides]

[`AvanzaError`](./AvanzaError.md).[`constructor`](./AvanzaError.md#constructor)

## Properties [#properties]

### body [#body]

> `readonly` **body**: `unknown`

***

### cause? [#cause]

> `optional` &#x2A;*cause?**: `unknown`

#### Inherited from [#inherited-from]

[`AvanzaError`](./AvanzaError.md).[`cause`](./AvanzaError.md#cause)

***

### headers [#headers]

> `readonly` **headers**: `Readonly`\<`Record`\<`string`, `string`>>

***

### message [#message]

> **message**: `string`

#### Inherited from [#inherited-from-1]

[`AvanzaError`](./AvanzaError.md).[`message`](./AvanzaError.md#message)

***

### name [#name]

> **name**: `string`

#### Inherited from [#inherited-from-2]

[`AvanzaError`](./AvanzaError.md).[`name`](./AvanzaError.md#name)

***

### stack? [#stack]

> `optional` &#x2A;*stack?**: `string`

#### Inherited from [#inherited-from-3]

[`AvanzaError`](./AvanzaError.md).[`stack`](./AvanzaError.md#stack)

***

### status [#status]

> `readonly` **status**: `number`

***

### statusText [#statustext]

> `readonly` **statusText**: `string`

***

### stackTraceLimit [#stacktracelimit]

> `static` **stackTraceLimit**: `number`

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from [#inherited-from-4]

[`AvanzaError`](./AvanzaError.md).[`stackTraceLimit`](./AvanzaError.md#stacktracelimit)

## Methods [#methods]

### captureStackTrace() [#capturestacktrace]

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters-1]

##### targetObject [#targetobject]

`object`

##### constructorOpt? [#constructoropt]

`Function`

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-5]

[`AvanzaError`](./AvanzaError.md).[`captureStackTrace`](./AvanzaError.md#capturestacktrace)

***

### prepareStackTrace() [#preparestacktrace]

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

#### Parameters [#parameters-2]

##### err [#err]

`Error`

##### stackTraces [#stacktraces]

`CallSite`\[]

#### Returns [#returns-2]

`any`

#### See [#see]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Inherited from [#inherited-from-6]

[`AvanzaError`](./AvanzaError.md).[`prepareStackTrace`](./AvanzaError.md#preparestacktrace)


# Type Alias: AccountListResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/AccountListResponse)



> **AccountListResponse** = readonly [`AccountSummary`](../interfaces/AccountSummary.md)\[]


# Type Alias: ActivePositionToolsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/ActivePositionToolsResponse)



> **ActivePositionToolsResponse** = readonly [`ActivePositionTool`](../interfaces/ActivePositionTool.md)\[]


# Type Alias: Alert (/avanza-ts/docs/sdk/reference/generated/type-aliases/Alert)



> **Alert** = `object` & `Readonly`\<`Record`\<`string`, `unknown`>>

Alert item fields follow the web app's model; captured responses had no
alerts yet. `messageTypes` contains `EMAIL` and/or `PUSH_NOTIFICATION`.

## Type Declaration [#type-declaration]

### messageTypes [#messagetypes]

> `readonly` **messageTypes**: readonly `string`\[]


# Type Alias: AnalysisSeries (/avanza-ts/docs/sdk/reference/generated/type-aliases/AnalysisSeries)



> **AnalysisSeries** = `Readonly`\<`Record`\<`string`, readonly [`AnalysisPoint`](../interfaces/AnalysisPoint.md)\[]>>

Metric name, for example `priceEarningsRatio` or `sales`, to its series.


# Type Alias: AnalysisSummary (/avanza-ts/docs/sdk/reference/generated/type-aliases/AnalysisSummary)



> **AnalysisSummary** = `Readonly`\<`Record`\<`string`, \{ `average`: `number` | `null`; `latest`: `number` | `null`; }>>


# Type Alias: AvanzaAuthenticationErrorCode (/avanza-ts/docs/sdk/reference/generated/type-aliases/AvanzaAuthenticationErrorCode)



> **AvanzaAuthenticationErrorCode** = `"cancelled"` | `"customer_selection"` | `"denied"` | `"invalid_credentials"` | `"malformed_response"` | `"network"` | `"protocol"` | `"session_unverified"` | `"timeout"` | `"unsupported_method"`


# Type Alias: AvanzaSession (/avanza-ts/docs/sdk/reference/generated/type-aliases/AvanzaSession)



> **AvanzaSession** = [`BankIdSession`](../interfaces/BankIdSession.md) | [`TotpSession`](../interfaces/TotpSession.md)


# Type Alias: BankIdPollResult (/avanza-ts/docs/sdk/reference/generated/type-aliases/BankIdPollResult)



> **BankIdPollResult** = \{ `challenge`: [`BankIdChallenge`](../interfaces/BankIdChallenge.md); `status`: `"pending"`; } | \{ `session`: [`BankIdSession`](../interfaces/BankIdSession.md); `status`: `"complete"`; } | \{ `status`: `"denied"`; } | \{ `status`: `"expired"`; }


# Type Alias: CalendarResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/CalendarResponse)



> **CalendarResponse** = readonly [`CalendarMonth`](../interfaces/CalendarMonth.md)\[]


# Type Alias: ChartPeriod (/avanza-ts/docs/sdk/reference/generated/type-aliases/ChartPeriod)



> **ChartPeriod** = *typeof* [`chartPeriods`](../variables/chartPeriods.md)\[`number`]


# Type Alias: ChartResolution (/avanza-ts/docs/sdk/reference/generated/type-aliases/ChartResolution)



> **ChartResolution** = *typeof* [`chartResolutions`](../variables/chartResolutions.md)\[`number`]


# Type Alias: ClosedAccountsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/ClosedAccountsResponse)



> **ClosedAccountsResponse** = readonly [`ClosedAccount`](../interfaces/ClosedAccount.md)\[]


# Type Alias: CreditType (/avanza-ts/docs/sdk/reference/generated/type-aliases/CreditType)



> **CreditType** = `"credited"` | `"uncredited"`


# Type Alias: DealItem (/avanza-ts/docs/sdk/reference/generated/type-aliases/DealItem)



> **DealItem** = [`OrderItem`](./OrderItem.md) & `object`

## Type Declaration [#type-declaration]

### orderId? [#orderid]

> `readonly` `optional` &#x2A;*orderId?**: `string`


# Type Alias: DividendsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/DividendsResponse)



> **DividendsResponse** = readonly [`Dividend`](../interfaces/Dividend.md)\[]


# Type Alias: FundInstrumentType (/avanza-ts/docs/sdk/reference/generated/type-aliases/FundInstrumentType)



> **FundInstrumentType** = `"FUND"` | `"EXCHANGE_TRADED_FUND"` | `"BOTH"`


# Type Alias: FundSortDirection (/avanza-ts/docs/sdk/reference/generated/type-aliases/FundSortDirection)



> **FundSortDirection** = `"ASCENDING"` | `"DESCENDING"`


# Type Alias: HistoricalClosingPrices (/avanza-ts/docs/sdk/reference/generated/type-aliases/HistoricalClosingPrices)



> **HistoricalClosingPrices** = `Readonly`\<`Record`\<`string`, `number` | `string`>>

Closing prices at the start of each period; missing periods are omitted.


# Type Alias: InsightsPeriod (/avanza-ts/docs/sdk/reference/generated/type-aliases/InsightsPeriod)



> **InsightsPeriod** = *typeof* [`insightsPeriods`](../variables/insightsPeriods.md)\[`number`]


# Type Alias: LightweightAccountsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/LightweightAccountsResponse)



> **LightweightAccountsResponse** = readonly [`LightweightAccount`](../interfaces/LightweightAccount.md)\[]


# Type Alias: ListedInstrumentType (/avanza-ts/docs/sdk/reference/generated/type-aliases/ListedInstrumentType)



> **ListedInstrumentType** = *typeof* [`listedInstrumentTypes`](../variables/listedInstrumentTypes.md)\[`number`]


# Type Alias: ListedProductFilter (/avanza-ts/docs/sdk/reference/generated/type-aliases/ListedProductFilter)



> **ListedProductFilter** = `Readonly`\<`Record`\<`string`, `boolean` | `string` | readonly `string`\[]>>

Filter keys and values come from the matching `filter-options` response.


# Type Alias: ListedProductFilterOptions (/avanza-ts/docs/sdk/reference/generated/type-aliases/ListedProductFilterOptions)



> **ListedProductFilterOptions** = `Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](../interfaces/ListedProductFilterOption.md)\[]>>


# Type Alias: MarketStatus (/avanza-ts/docs/sdk/reference/generated/type-aliases/MarketStatus)



> **MarketStatus** = `string`

For example `MARKET_OPEN`.


# Type Alias: OrderItem (/avanza-ts/docs/sdk/reference/generated/type-aliases/OrderItem)



> **OrderItem** = `object` & `Readonly`\<`Record`\<`string`, `unknown`>>

Only `id` and `account.urlParameterId` are confirmed by the web app;
captured responses had no orders yet.

## Type Declaration [#type-declaration]

### account [#account]

> `readonly` **account**: `object` & `Readonly`\<`Record`\<`string`, `unknown`>>

#### Type Declaration [#type-declaration-1]

##### urlParameterId? [#urlparameterid]

> `readonly` `optional` &#x2A;*urlParameterId?**: `string`

### id [#id]

> `readonly` **id**: `string`


# Type Alias: PerformancePeriod (/avanza-ts/docs/sdk/reference/generated/type-aliases/PerformancePeriod)



> **PerformancePeriod** = *typeof* [`performancePeriods`](../variables/performancePeriods.md)\[`number`]


# Type Alias: PositionCountriesResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/PositionCountriesResponse)



> **PositionCountriesResponse** = readonly [`PositionCountryAllocation`](../interfaces/PositionCountryAllocation.md)\[]


# Type Alias: PositionListResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/PositionListResponse)



> **PositionListResponse** = `z.infer`\<*typeof* `positionListResponseSchema`>


# Type Alias: PositionOrderbooksResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/PositionOrderbooksResponse)



> **PositionOrderbooksResponse** = readonly [`PositionOrderbook`](../interfaces/PositionOrderbook.md)\[]


# Type Alias: PriceChartPeriod (/avanza-ts/docs/sdk/reference/generated/type-aliases/PriceChartPeriod)



> **PriceChartPeriod** = [`ChartPeriod`](./ChartPeriod.md) | [`PerformanceDateRange`](../interfaces/PerformanceDateRange.md)

A named period or a custom `yyyy-MM-dd` range.


# Type Alias: SavingsGoalPeriod (/avanza-ts/docs/sdk/reference/generated/type-aliases/SavingsGoalPeriod)



> **SavingsGoalPeriod** = *typeof* [`savingsGoalPeriods`](../variables/savingsGoalPeriods.md)\[`number`]


# Type Alias: ScreenCertificatesResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/ScreenCertificatesResponse)



> **ScreenCertificatesResponse** = [`ScreenListedProductsResponse`](./ScreenListedProductsResponse.md)\<`"certificates"`, [`ScreenedCertificate`](../interfaces/ScreenedCertificate.md)>


# Type Alias: ScreenDerivativesResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/ScreenDerivativesResponse)



> **ScreenDerivativesResponse** = [`ScreenListedProductsResponse`](./ScreenListedProductsResponse.md)\<`"futureForwards"`, [`MatrixFutureForward`](../interfaces/MatrixFutureForward.md)> & `object`

Futures, forwards, and put/call pairs for one underlying. The API defaults
to OMX Stockholm 30 and the nearest expiries, and only sorts by `strikePrice`.

## Type Declaration [#type-declaration]

### matchedOptions [#matchedoptions]

> `readonly` **matchedOptions**: readonly `object`\[]

### underlyingInstrument [#underlyinginstrument]

> `readonly` **underlyingInstrument**: `object`

#### underlyingInstrument.change [#underlyinginstrumentchange]

> `readonly` **change**: `number`

#### underlyingInstrument.changePercent [#underlyinginstrumentchangepercent]

> `readonly` **changePercent**: `number`

#### underlyingInstrument.countryCode [#underlyinginstrumentcountrycode]

> `readonly` **countryCode**: `string`

#### underlyingInstrument.highestPrice [#underlyinginstrumenthighestprice]

> `readonly` **highestPrice**: `number`

#### underlyingInstrument.instrumentType [#underlyinginstrumentinstrumenttype]

> `readonly` **instrumentType**: `string`

#### underlyingInstrument.lastPrice [#underlyinginstrumentlastprice]

> `readonly` **lastPrice**: `number`

#### underlyingInstrument.lowestPrice [#underlyinginstrumentlowestprice]

> `readonly` **lowestPrice**: `number`

#### underlyingInstrument.name [#underlyinginstrumentname]

> `readonly` **name**: `string`

#### underlyingInstrument.orderbookId [#underlyinginstrumentorderbookid]

> `readonly` **orderbookId**: `string`


# Type Alias: ScreenEtfsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/ScreenEtfsResponse)



> **ScreenEtfsResponse** = [`ScreenListedProductsResponse`](./ScreenListedProductsResponse.md)\<`"etfs"`, [`ScreenedEtf`](../interfaces/ScreenedEtf.md)>


# Type Alias: ScreenListedProductsResponse\<Key, Item\> (/avanza-ts/docs/sdk/reference/generated/type-aliases/ScreenListedProductsResponse)



> **ScreenListedProductsResponse**\<`Key`, `Item`> = `{ readonly [K in Key]: readonly Item[] }` & `object`

## Type Declaration [#type-declaration]

### filter [#filter]

> `readonly` **filter**: [`ListedProductFilter`](./ListedProductFilter.md)

### filterOptions [#filteroptions]

> `readonly` **filterOptions**: [`ListedProductFilterOptions`](./ListedProductFilterOptions.md)

### pagination [#pagination]

> `readonly` **pagination**: `object`

#### pagination.limit [#paginationlimit]

> `readonly` **limit**: `number`

#### pagination.offset [#paginationoffset]

> `readonly` **offset**: `number`

### sortBy [#sortby]

> `readonly` **sortBy**: [`StockSort`](../interfaces/StockSort.md)

### totalNumberOfOrderbooks [#totalnumberoforderbooks]

> `readonly` **totalNumberOfOrderbooks**: `number`

## Type Parameters [#type-parameters]

### Key [#key]

`Key` *extends* `string`

### Item [#item]

`Item`


# Type Alias: ScreenWarrantsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/ScreenWarrantsResponse)



> **ScreenWarrantsResponse** = [`ScreenListedProductsResponse`](./ScreenListedProductsResponse.md)\<`"warrants"`, [`ScreenedWarrant`](../interfaces/ScreenedWarrant.md)>


# Type Alias: SearchInstrumentType (/avanza-ts/docs/sdk/reference/generated/type-aliases/SearchInstrumentType)



> **SearchInstrumentType** = *typeof* [`searchInstrumentTypes`](../variables/searchInstrumentTypes.md)\[`number`]


# Type Alias: StockMetric (/avanza-ts/docs/sdk/reference/generated/type-aliases/StockMetric)



> **StockMetric** = `"directYield"` | `"priceEarningsRatio"` | `"lastPrice"` | `"highestPrice"` | `"lowestPrice"` | `"buyPrice"` | `"sellPrice"` | `"totalValueTraded"` | `"totalVolumeTraded"` | `"lastPriceUpdated"` | `"oneDayChangePercent"` | `"oneWeekChangePercent"` | `"startOfYearChangePercent"` | `"oneYearChangePercent"` | `"oneMonthChangePercent"` | `"threeMonthsChangePercent"` | `"sixMonthsChangePercent"` | `"threeYearsChangePercent"` | `"fiveYearsChangePercent"` | `"tenYearsChangePercent"` | `"infinityChangePercent"` | `"numberOfOwners"` | `"shortSellingRatio"` | `"evEbitRatio"` | `"netDebtEbitdaRatio"` | `"pricePerSaleRatio"` | `"priceSalesRatio"` | `"returnOnEquity"` | `"returnOnAssets"` | `"returnOnCapitalEmployed"` | `"priceBookRatio"` | `"earningsPerShare"` | `"dividendPerShare"` | `"equityPerShare"` | `"dividendRatio"` | `"turnoverPerShare"` | `"marketCapitalization"` | `"marketCap"` | `"beta"` | `"volatility"` | `"sma20"` | `"sma50"` | `"sma200"` | `"smaBetween50and200"` | `"rsi14"` | `"rsiTrendThreeDays"` | `"rsiTrendFiveDays"` | `"bollingerDistanceUpperToLower"` | `"bollingerDistanceUpper"` | `"bollingerDistanceLower"` | `"collateralValue"` | `"dividendsPerYear"` | `"debtToEquityRatio"` | `"profitMargin"` | `"sales"` | `"totalAssets"` | `"totalLiabilities"` | `"netProfit"` | `"ownersChangeOneDay"` | `"ownersChangeOneWeek"` | `"ownersChangeOneMonth"` | `"ownersChangeThreeMonths"` | `"ownersChangeThisYear"` | `"ownersChangeOneYear"` | `"ownersChangeOneDayAbsolute"` | `"ownersChangeOneWeekAbsolute"` | `"ownersChangeOneMonthAbsolute"` | `"ownersChangeThreeMonthsAbsolute"` | `"ownersChangeThisYearAbsolute"` | `"ownersChangeOneYearAbsolute"` | `"macdValue"` | `"macdHistogram"` | `"macdSignal"` | `"operatingCashFlow"`


# Type Alias: TotpLoginOptions (/avanza-ts/docs/sdk/reference/generated/type-aliases/TotpLoginOptions)



> **TotpLoginOptions** = [`TotpCodeLoginOptions`](../interfaces/TotpCodeLoginOptions.md) | [`TotpSecretLoginOptions`](../interfaces/TotpSecretLoginOptions.md)


# Type Alias: TradingAccountsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/TradingAccountsResponse)



> **TradingAccountsResponse** = readonly [`TradingAccount`](../interfaces/TradingAccount.md)\[]


# Type Alias: UnverifiedItem (/avanza-ts/docs/sdk/reference/generated/type-aliases/UnverifiedItem)



> **UnverifiedItem** = `Readonly`\<`Record`\<`string`, `unknown`>>

Item fields are unverified; captured lists were empty so far.


# Type Alias: UpcomingDividendsResponse (/avanza-ts/docs/sdk/reference/generated/type-aliases/UpcomingDividendsResponse)



> **UpcomingDividendsResponse** = readonly [`UpcomingDividend`](../interfaces/UpcomingDividend.md)\[]


# Type Alias: WatchlistDataPoint (/avanza-ts/docs/sdk/reference/generated/type-aliases/WatchlistDataPoint)



> **WatchlistDataPoint** = *typeof* [`watchlistDataPoints`](../variables/watchlistDataPoints.md)\[`number`]


# Variable: chartPeriods (/avanza-ts/docs/sdk/reference/generated/variables/chartPeriods)



> `const` **chartPeriods**: readonly \[`"today"`, `"one_week"`, `"one_month"`, `"three_months"`, `"this_year"`, `"one_year"`, `"three_years"`, `"five_years"`, `"infinity"`]


# Variable: chartResolutions (/avanza-ts/docs/sdk/reference/generated/variables/chartResolutions)



> `const` **chartResolutions**: readonly \[`"minute"`, `"two_minutes"`, `"five_minutes"`, `"ten_minutes"`, `"thirty_minutes"`, `"hour"`, `"day"`, `"week"`, `"month"`, `"quarter"`]


# Variable: insightsPeriods (/avanza-ts/docs/sdk/reference/generated/variables/insightsPeriods)



> `const` **insightsPeriods**: readonly \[`"TODAY"`, `"ONE_WEEK"`, `"THIS_YEAR"`, `"THREE_YEARS_ROLLING"`]


# Variable: listedInstrumentTypes (/avanza-ts/docs/sdk/reference/generated/variables/listedInstrumentTypes)



> `const` **listedInstrumentTypes**: readonly \[`"certificate"`, `"warrant"`, `"futureforward"`, `"option"`]


# Variable: performancePeriods (/avanza-ts/docs/sdk/reference/generated/variables/performancePeriods)



> `const` **performancePeriods**: readonly \[`"TODAY"`, `"ONE_WEEK"`, `"ONE_MONTH"`, `"THREE_MONTHS"`, `"THIS_YEAR"`, `"ONE_YEAR"`, `"THREE_YEARS"`, `"FIVE_YEARS"`, `"ALL_TIME"`]


# Variable: savedFiltersSchema (/avanza-ts/docs/sdk/reference/generated/variables/savedFiltersSchema)



> `const` **savedFiltersSchema**: `ZodObject`\<\{ `filters`: `ZodArray`\<`ZodObject`\<\{ `filter`: `ZodType`\<[`StockFilter`](../interfaces/StockFilter.md), `unknown`, `$ZodTypeInternals`\<[`StockFilter`](../interfaces/StockFilter.md), `unknown`>>; `name`: `ZodString`; }, `$loose`>>; }, `$loose`>


# Variable: savingsGoalPeriods (/avanza-ts/docs/sdk/reference/generated/variables/savingsGoalPeriods)



> `const` **savingsGoalPeriods**: readonly \[`"ONE_WEEK"`, `"ONE_MONTH"`, `"THREE_MONTHS"`, `"THIS_YEAR"`, `"ONE_YEAR"`, `"THREE_YEARS"`, `"INFINITY"`]


# Variable: screenerTabsSchema (/avanza-ts/docs/sdk/reference/generated/variables/screenerTabsSchema)



> `const` **screenerTabsSchema**: `ZodObject`\<\{ `tabs`: `ZodArray`\<`ZodObject`\<\{ `columns`: `ZodArray`\<`ZodString`>; `name`: `ZodString`; }, `$loose`>>; }, `$loose`>


# Variable: searchInstrumentTypes (/avanza-ts/docs/sdk/reference/generated/variables/searchInstrumentTypes)



> `const` **searchInstrumentTypes**: readonly \[`"STOCK"`, `"INDEX"`, `"FUND"`, `"EXCHANGE_TRADED_FUND"`, `"CERTIFICATE"`, `"WARRANT"`, `"TRADING_CURRENCY"`, `"BOND"`, `"PREMIUM_BOND"`, `"EQUITY_LINKED_BOND"`, `"OPTION"`, `"SUBSCRIPTION_OPTION"`, `"CONVERTIBLE"`, `"FUTURE_FORWARD"`, `"RIGHT"`, `"PAGE"`, `"FAQ"`]


# Variable: stockFilterSchema (/avanza-ts/docs/sdk/reference/generated/variables/stockFilterSchema)



> `const` **stockFilterSchema**: `z.ZodType`\<[`StockFilter`](../interfaces/StockFilter.md)>


# Variable: watchlistDataPoints (/avanza-ts/docs/sdk/reference/generated/variables/watchlistDataPoints)



> `const` **watchlistDataPoints**: readonly \[`"ABSOLUTE_PERFORMANCE_SINCE_ADDED"`, `"BETA"`, `"BUY_OR_SELL"`, `"BUY_PRICE"`, `"CATEGORY"`, `"CHANGE"`, `"CHANGE_PERCENTAGE"`, `"COLLATERAL_FACTOR"`, `"CURRENCY"`, `"DATE_WHEN_ADDED"`, `"DIRECTION"`, `"DIVIDENDS_AMOUNT_12_MONTHS"`, `"DIVIDENDS_PER_YEAR"`, `"EARNINGS_PER_SHARE"`, `"END_DATE"`, `"ETF_ORDINARY_DIRECT_YIELD"`, `"ETF_RISK"`, `"EV_EBIT_RATIO"`, `"FIVE_YEARS_PERFORMANCE"`, `"FLAG_CODE"`, `"FUND_RATING"`, `"FUND_RISK"`, `"FUND_TOTAL_MARKET_VALUE"`, `"HIGHEST_PRICE"`, `"INSTRUMENT_TYPE"`, `"LAST_PRICE"`, `"LEVERAGE"`, `"LOWEST_PRICE"`, `"MANAGEMENT_FEE"`, `"MARGIN_REQUIREMENT"`, `"MARKET_CAP"`, `"MAX_PERFORMANCE"`, `"NAME"`, `"NAV"`, `"NET_DEBT_TO_EBITDA_RATIO"`, `"NEXT_DIVIDEND_AMOUNT"`, `"NEXT_DIVIDEND_DATE"`, `"NEXT_REPORT_DATE"`, `"NUMBER_OF_OWNERS"`, `"ONE_MONTH_PERFORMANCE"`, `"ONE_WEEK_PERFORMANCE"`, `"ONE_YEAR_PERFORMANCE"`, `"OPTION_TYPE"`, `"ORDINARY_DIRECT_YIELD"`, `"PRICE_BOOK_RATIO"`, `"PRICE_EARNINGS_RATIO"`, `"PRICE_LAST_UPDATED_DATE"`, `"PRICE_LAST_UPDATED_TIME"`, `"PRICE_SALES_RATIO"`, `"PRICE_WHEN_ADDED"`, `"PRODUCT_FEE"`, `"RELATIVE_PERFORMANCE_SINCE_ADDED"`, `"RETURN_ON_EQUITY"`, `"SELL_PRICE"`, `"SHARPE_RATIO"`, `"SHORT_SELLING_ALLOWED"`, `"SIX_MONTHS_PERFORMANCE"`, `"SPREAD"`, `"STANDARD_DEVIATION_PERCENT"`, `"STRIKE_PRICE"`, `"SUPER_INTEREST_APPROVED"`, `"TEN_YEARS_PERFORMANCE"`, `"THIS_YEAR_PERFORMANCE"`, `"THREE_MONTHS_PERFORMANCE"`, `"THREE_YEARS_PERFORMANCE"`, `"TOTAL_FEE"`, `"UNDERLYING_INSTRUMENT_NAME"`, `"VALUE_TRADED"`, `"VOLATILITY"`, `"VOLUME_TRADED"`, `"WARRANT_LEVERAGE"`, `"WARRANT_TYPE"`]

Data points the web app can request for watchlist rows.


# Interface: AccountAmount (/avanza-ts/docs/sdk/reference/generated/interfaces/AccountAmount)



## Properties [#properties]

### decimalPrecision [#decimalprecision]

> `readonly` **decimalPrecision**: `number`

***

### unit [#unit]

> `readonly` **unit**: `string`

***

### unitType [#unittype]

> `readonly` **unitType**: `string`

***

### value [#value]

> `readonly` **value**: `number`


# Interface: AccountCategoriesResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/AccountCategoriesResponse)



## Properties [#properties]

### accounts [#accounts]

> `readonly` **accounts**: [`AccountListResponse`](../type-aliases/AccountListResponse.md)

***

### categories [#categories]

> `readonly` **categories**: readonly [`AccountCategory`](./AccountCategory.md)\[]


# Interface: AccountCategory (/avanza-ts/docs/sdk/reference/generated/interfaces/AccountCategory)



## Properties [#properties]

### accountIds [#accountids]

> `readonly` **accountIds**: readonly `string`\[]

***

### externalMortgageIds [#externalmortgageids]

> `readonly` **externalMortgageIds**: readonly `object`\[]

***

### id [#id]

> `readonly` **id**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### order [#order]

> `readonly` **order**: `number`

***

### savingsGoal [#savingsgoal]

> `readonly` **savingsGoal**: `boolean`


# Interface: AccountOverviewResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/AccountOverviewResponse)



## Properties [#properties]

### account [#account]

> `readonly` **account**: `object`

#### autoDistribution [#autodistribution]

> `readonly` **autoDistribution**: `boolean`

#### balance [#balance]

> `readonly` **balance**: [`AccountAmount`](./AccountAmount.md)

#### buyingPower [#buyingpower]

> `readonly` **buyingPower**: [`AccountAmount`](./AccountAmount.md)

#### buyingPowerWithoutCredit [#buyingpowerwithoutcredit]

> `readonly` **buyingPowerWithoutCredit**: [`AccountAmount`](./AccountAmount.md)

#### credit [#credit]

> `readonly` **credit**: [`AccountAmount`](./AccountAmount.md) | `null`

#### currencyBalances [#currencybalances]

> `readonly` **currencyBalances**: readonly [`AccountAmount`](./AccountAmount.md)\[]

#### discretionaryPortfolio [#discretionaryportfolio]

> `readonly` **discretionaryPortfolio**: `boolean`

#### id [#id]

> `readonly` **id**: `string`

#### name [#name]

> `readonly` **name**: `object`

##### name.defaultName [#namedefaultname]

> `readonly` **defaultName**: `string`

##### name.userDefinedName [#nameuserdefinedname]

> `readonly` **userDefinedName**: `string` | `null`

#### pendingRebalance [#pendingrebalance]

> `readonly` **pendingRebalance**: `boolean`

#### status [#status]

> `readonly` **status**: `string`

#### type [#type]

> `readonly` **type**: `string`

#### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`

***

### category [#category]

> `readonly` **category**: `object`

#### id [#id-1]

> `readonly` **id**: `string`

#### name [#name-1]

> `readonly` **name**: `string`

#### savingsGoalView [#savingsgoalview]

> `readonly` **savingsGoalView**: `object` | `null`


# Interface: AccountSummary (/avanza-ts/docs/sdk/reference/generated/interfaces/AccountSummary)



## Properties [#properties]

### accountSettings? [#accountsettings]

> `readonly` `optional` &#x2A;*accountSettings?**: `Readonly`\<`Record`\<`string`, `boolean`>>

***

### accountType [#accounttype]

> `readonly` **accountType**: `string`

***

### active [#active]

> `readonly` **active**: `boolean`

***

### autoDistribution? [#autodistribution]

> `readonly` `optional` &#x2A;*autoDistribution?**: `boolean`

***

### clearingAccountNumber? [#clearingaccountnumber]

> `readonly` `optional` &#x2A;*clearingAccountNumber?**: `string`

***

### discretionaryPortfolio? [#discretionaryportfolio]

> `readonly` `optional` &#x2A;*discretionaryPortfolio?**: `boolean`

***

### hasCreditAccount? [#hascreditaccount]

> `readonly` `optional` &#x2A;*hasCreditAccount?**: `boolean`

***

### hasMultipleOwners? [#hasmultipleowners]

> `readonly` `optional` &#x2A;*hasMultipleOwners?**: `boolean`

***

### id [#id]

> `readonly` **id**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`


# Interface: AccountsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/AccountsClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### accountsAndPositions() [#accountsandpositions]

> **accountsAndPositions**(`signal?`): `Promise`\<[`TradingAccountsResponse`](../type-aliases/TradingAccountsResponse.md)>

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`TradingAccountsResponse`](../type-aliases/TradingAccountsResponse.md)>

***

### categories() [#categories]

> **categories**(`signal?`): `Promise`\<[`AccountCategoriesResponse`](./AccountCategoriesResponse.md)>

#### Parameters [#parameters-1]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`AccountCategoriesResponse`](./AccountCategoriesResponse.md)>

***

### categorizedOverview() [#categorizedoverview]

> **categorizedOverview**(`signal?`): `Promise`\<[`CategorizedAccountOverviewResponse`](./CategorizedAccountOverviewResponse.md)>

#### Parameters [#parameters-2]

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`CategorizedAccountOverviewResponse`](./CategorizedAccountOverviewResponse.md)>

***

### closed() [#closed]

> **closed**(`signal?`): `Promise`\<[`ClosedAccountsResponse`](../type-aliases/ClosedAccountsResponse.md)>

#### Parameters [#parameters-3]

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<[`ClosedAccountsResponse`](../type-aliases/ClosedAccountsResponse.md)>

***

### hasClosed() [#hasclosed]

> **hasClosed**(`signal?`): `Promise`\<[`HasClosedAccountsResponse`](./HasClosedAccountsResponse.md)>

#### Parameters [#parameters-4]

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`HasClosedAccountsResponse`](./HasClosedAccountsResponse.md)>

***

### lightweightAccounts() [#lightweightaccounts]

> **lightweightAccounts**(`signal?`): `Promise`\<[`LightweightAccountsResponse`](../type-aliases/LightweightAccountsResponse.md)>

#### Parameters [#parameters-5]

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<[`LightweightAccountsResponse`](../type-aliases/LightweightAccountsResponse.md)>

***

### list() [#list]

> **list**(`signal?`): `Promise`\<[`AccountListResponse`](../type-aliases/AccountListResponse.md)>

#### Parameters [#parameters-6]

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<[`AccountListResponse`](../type-aliases/AccountListResponse.md)>

***

### overview() [#overview]

> **overview**(`accountId`, `signal?`): `Promise`\<[`AccountOverviewResponse`](./AccountOverviewResponse.md)>

#### Parameters [#parameters-7]

##### accountId [#accountid]

`string`

##### signal? [#signal-7]

`AbortSignal`

#### Returns [#returns-7]

`Promise`\<[`AccountOverviewResponse`](./AccountOverviewResponse.md)>

***

### tradingAccounts() [#tradingaccounts]

> **tradingAccounts**(`signal?`): `Promise`\<[`TradingAccountsResponse`](../type-aliases/TradingAccountsResponse.md)>

#### Parameters [#parameters-8]

##### signal? [#signal-8]

`AbortSignal`

#### Returns [#returns-8]

`Promise`\<[`TradingAccountsResponse`](../type-aliases/TradingAccountsResponse.md)>


# Interface: ActivePositionTool (/avanza-ts/docs/sdk/reference/generated/interfaces/ActivePositionTool)



## Properties [#properties]

### hasAlert [#hasalert]

> `readonly` **hasAlert**: `boolean`

***

### hasNote [#hasnote]

> `readonly` **hasNote**: `boolean`

***

### inWatchlist [#inwatchlist]

> `readonly` **inWatchlist**: `boolean`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`


# Interface: AlertsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/AlertsResponse)



## Properties [#properties]

### newsAlerts [#newsalerts]

> `readonly` **newsAlerts**: readonly [`Alert`](../type-aliases/Alert.md)\[]

***

### percentAlerts [#percentalerts]

> `readonly` **percentAlerts**: readonly [`Alert`](../type-aliases/Alert.md)\[]

***

### priceAlerts [#pricealerts]

> `readonly` **priceAlerts**: readonly [`Alert`](../type-aliases/Alert.md)\[]


# Interface: AnalysisPoint (/avanza-ts/docs/sdk/reference/generated/interfaces/AnalysisPoint)



## Properties [#properties]

### date? [#date]

> `readonly` `optional` &#x2A;*date?**: `string`

Report date; present on quarterly series and dividends.

***

### financialYear [#financialyear]

> `readonly` **financialYear**: `number`

***

### reportType [#reporttype]

> `readonly` **reportType**: `string`

For example `FULL_YEAR` or `Q1`.

***

### value [#value]

> `readonly` **value**: `number`


# Interface: AuthClient (/avanza-ts/docs/sdk/reference/generated/interfaces/AuthClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### getSessionInfo() [#getsessioninfo]

> **getSessionInfo**(`signal?`): `Promise`\<[`SessionInfoResponse`](./SessionInfoResponse.md)>

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`SessionInfoResponse`](./SessionInfoResponse.md)>

***

### loginWithTotp() [#loginwithtotp]

> **loginWithTotp**(`options`): `Promise`\<[`TotpSession`](./TotpSession.md)>

#### Parameters [#parameters-1]

##### options [#options]

[`TotpLoginOptions`](../type-aliases/TotpLoginOptions.md)

#### Returns [#returns-1]

`Promise`\<[`TotpSession`](./TotpSession.md)>

***

### logout() [#logout]

> **logout**(`signal?`): `Promise`\<`void`>

#### Parameters [#parameters-2]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<`void`>

***

### startBankId() [#startbankid]

> **startBankId**(`options?`): `Promise`\<[`BankIdAuthAttempt`](./BankIdAuthAttempt.md)>

#### Parameters [#parameters-3]

##### options? [#options-1]

[`StartBankIdOptions`](./StartBankIdOptions.md) = `{}`

#### Returns [#returns-3]

`Promise`\<[`BankIdAuthAttempt`](./BankIdAuthAttempt.md)>

***

### validateSession() [#validatesession]

> **validateSession**(`signal?`): `Promise`\<`boolean`>

#### Parameters [#parameters-4]

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<`boolean`>


# Interface: AvanzaClientOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/AvanzaClientOptions)



## Properties [#properties]

### baseUrl? [#baseurl]

> `readonly` `optional` &#x2A;*baseUrl?**: `string`

***

### fetch? [#fetch]

> `readonly` `optional` &#x2A;*fetch?**: \{(`input`, `init?`): `Promise`\<`Response`>; (`input`, `init?`): `Promise`\<`Response`>; }

#### Call Signature [#call-signature]

> (`input`, `init?`): `Promise`\<`Response`>

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)

##### Parameters [#parameters]

###### input [#input]

`URL` | `RequestInfo`

###### init? [#init]

`RequestInit`

##### Returns [#returns]

`Promise`\<`Response`>

#### Call Signature [#call-signature-1]

> (`input`, `init?`): `Promise`\<`Response`>

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)

##### Parameters [#parameters-1]

###### input [#input-1]

`string` | `URL` | `Request`

###### init? [#init-1]

`RequestInit`

##### Returns [#returns-1]

`Promise`\<`Response`>

***

### session? [#session]

> `readonly` `optional` &#x2A;*session?**: [`AvanzaSession`](../type-aliases/AvanzaSession.md)


# Interface: AvanzaCookie (/avanza-ts/docs/sdk/reference/generated/interfaces/AvanzaCookie)



## Properties [#properties]

### creation? [#creation]

> `readonly` `optional` &#x2A;*creation?**: `string`

***

### domain? [#domain]

> `readonly` `optional` &#x2A;*domain?**: `string`

***

### expires? [#expires]

> `readonly` `optional` &#x2A;*expires?**: `string`

***

### extensions? [#extensions]

> `readonly` `optional` &#x2A;*extensions?**: readonly `string`\[]

***

### hostOnly? [#hostonly]

> `readonly` `optional` &#x2A;*hostOnly?**: `boolean`

***

### httpOnly? [#httponly]

> `readonly` `optional` &#x2A;*httpOnly?**: `boolean`

***

### key [#key]

> `readonly` **key**: `string`

***

### lastAccessed? [#lastaccessed]

> `readonly` `optional` &#x2A;*lastAccessed?**: `string`

***

### maxAge? [#maxage]

> `readonly` `optional` &#x2A;*maxAge?**: `string` | `number`

***

### path? [#path]

> `readonly` `optional` &#x2A;*path?**: `string`

***

### pathIsDefault? [#pathisdefault]

> `readonly` `optional` &#x2A;*pathIsDefault?**: `boolean`

***

### sameSite? [#samesite]

> `readonly` `optional` &#x2A;*sameSite?**: `string`

***

### secure? [#secure]

> `readonly` `optional` &#x2A;*secure?**: `boolean`

***

### value [#value]

> `readonly` **value**: `string`


# Interface: BankIdAuthAttempt (/avanza-ts/docs/sdk/reference/generated/interfaces/BankIdAuthAttempt)



## Accessors [#accessors]

### challenge [#challenge]

#### Get Signature [#get-signature]

> **get** **challenge**(): [`BankIdChallenge`](./BankIdChallenge.md)

##### Returns [#returns]

[`BankIdChallenge`](./BankIdChallenge.md)

## Methods [#methods]

### cancel() [#cancel]

> **cancel**(): `Promise`\<`void`>

#### Returns [#returns-1]

`Promise`\<`void`>

***

### poll() [#poll]

> **poll**(): `Promise`\<[`BankIdPollResult`](../type-aliases/BankIdPollResult.md)>

#### Returns [#returns-2]

`Promise`\<[`BankIdPollResult`](../type-aliases/BankIdPollResult.md)>


# Interface: BankIdChallenge (/avanza-ts/docs/sdk/reference/generated/interfaces/BankIdChallenge)



## Properties [#properties]

### autostartToken? [#autostarttoken]

> `readonly` `optional` &#x2A;*autostartToken?**: `string`

***

### autostartUrl? [#autostarturl]

> `readonly` `optional` &#x2A;*autostartUrl?**: `string`

***

### qrPayload [#qrpayload]

> `readonly` **qrPayload**: `string`

***

### refreshAfterMs [#refreshafterms]

> `readonly` **refreshAfterMs**: `number`


# Interface: BankIdSession (/avanza-ts/docs/sdk/reference/generated/interfaces/BankIdSession)



## Properties [#properties]

### cookies [#cookies]

> `readonly` **cookies**: readonly [`AvanzaCookie`](./AvanzaCookie.md)\[]

***

### customerId? [#customerid]

> `readonly` `optional` &#x2A;*customerId?**: `string`

***

### mode [#mode]

> `readonly` **mode**: `"bankid"`

***

### securityToken? [#securitytoken]

> `readonly` `optional` &#x2A;*securityToken?**: `string`


# Interface: BrokerTradeSummary (/avanza-ts/docs/sdk/reference/generated/interfaces/BrokerTradeSummary)



## Properties [#properties]

### brokerCode [#brokercode]

> `readonly` **brokerCode**: `string`

***

### brokerName [#brokername]

> `readonly` **brokerName**: `string`

***

### buyVolume [#buyvolume]

> `readonly` **buyVolume**: `number`

***

### netBuyVolume [#netbuyvolume]

> `readonly` **netBuyVolume**: `number`

***

### sellVolume [#sellvolume]

> `readonly` **sellVolume**: `number`


# Interface: BulkOrder (/avanza-ts/docs/sdk/reference/generated/interfaces/BulkOrder)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### created [#created]

> `readonly` **created**: `string`

***

### createdFrom [#createdfrom]

> `readonly` **createdFrom**: `string`

***

### id [#id]

> `readonly` **id**: `string`

***

### side [#side]

> `readonly` **side**: `string`

***

### totalSum [#totalsum]

> `readonly` **totalSum**: `string`

***

### tradingBulkOrderEntities [#tradingbulkorderentities]

> `readonly` **tradingBulkOrderEntities**: readonly `object`\[]


# Interface: BulkOrderOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/BulkOrderOptions)



## Properties [#properties]

### accountId? [#accountid]

> `readonly` `optional` &#x2A;*accountId?**: `string`

***

### side? [#side]

> `readonly` `optional` &#x2A;*side?**: `string`

For example `BUY`.


# Interface: BulkOrdersResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/BulkOrdersResponse)



## Properties [#properties]

### tradingBulkOrders [#tradingbulkorders]

> `readonly` **tradingBulkOrders**: readonly [`BulkOrder`](./BulkOrder.md)\[]


# Interface: BuyingPower (/avanza-ts/docs/sdk/reference/generated/interfaces/BuyingPower)



## Properties [#properties]

### availableCredit [#availablecredit]

> `readonly` **availableCredit**: [`AccountAmount`](./AccountAmount.md)

***

### balanceOnTradableAccounts [#balanceontradableaccounts]

> `readonly` **balanceOnTradableAccounts**: [`AccountAmount`](./AccountAmount.md)

***

### currencyBalances [#currencybalances]

> `readonly` **currencyBalances**: readonly [`CurrencyBalance`](./CurrencyBalance.md)\[]

***

### currentOrders [#currentorders]

> `readonly` **currentOrders**: [`AccountAmount`](./AccountAmount.md)

***

### forwardResult [#forwardresult]

> `readonly` **forwardResult**: [`AccountAmount`](./AccountAmount.md)

***

### grossExposure [#grossexposure]

> `readonly` **grossExposure**: [`AccountAmount`](./AccountAmount.md)

***

### grossExposureLimit [#grossexposurelimit]

> `readonly` **grossExposureLimit**: [`AccountAmount`](./AccountAmount.md)

***

### negativeAccruedInterest [#negativeaccruedinterest]

> `readonly` **negativeAccruedInterest**: [`AccountAmount`](./AccountAmount.md)

***

### total [#total]

> `readonly` **total**: [`AccountAmount`](./AccountAmount.md)

***

### totalExcludingCredit [#totalexcludingcredit]

> `readonly` **totalExcludingCredit**: [`AccountAmount`](./AccountAmount.md)

***

### totalMarginRequirement [#totalmarginrequirement]

> `readonly` **totalMarginRequirement**: [`AccountAmount`](./AccountAmount.md)


# Interface: CalendarDividend (/avanza-ts/docs/sdk/reference/generated/interfaces/CalendarDividend)



## Properties [#properties]

### amount [#amount]

> `readonly` **amount**: `number`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### established [#established]

> `readonly` **established**: `boolean`

***

### exclusiveDividendDate [#exclusivedividenddate]

> `readonly` **exclusiveDividendDate**: `string`

***

### orderbook [#orderbook]

> `readonly` **orderbook**: [`CalendarOrderbook`](./CalendarOrderbook.md)

***

### paymentDate [#paymentdate]

> `readonly` **paymentDate**: `string`

***

### price [#price]

> `readonly` **price**: `number`

***

### volume [#volume]

> `readonly` **volume**: `number`


# Interface: CalendarMonth (/avanza-ts/docs/sdk/reference/generated/interfaces/CalendarMonth)



Event lists typed as `unknown[]` were absent from every capture so far.

## Properties [#properties]

### generalMeetings? [#generalmeetings]

> `readonly` `optional` &#x2A;*generalMeetings?**: readonly `unknown`\[]

***

### monthlySavings? [#monthlysavings]

> `readonly` `optional` &#x2A;*monthlySavings?**: readonly `unknown`\[]

***

### notes? [#notes]

> `readonly` `optional` &#x2A;*notes?**: readonly `unknown`\[]

***

### offers? [#offers]

> `readonly` `optional` &#x2A;*offers?**: readonly `unknown`\[]

***

### recurringDeposits? [#recurringdeposits]

> `readonly` `optional` &#x2A;*recurringDeposits?**: readonly `unknown`\[]

***

### recurringFundInvestments? [#recurringfundinvestments]

> `readonly` `optional` &#x2A;*recurringFundInvestments?**: readonly `unknown`\[]

***

### reports? [#reports]

> `readonly` `optional` &#x2A;*reports?**: readonly [`CalendarReport`](./CalendarReport.md)\[]

***

### upcomingDividends? [#upcomingdividends]

> `readonly` `optional` &#x2A;*upcomingDividends?**: `object`

#### totalAmountSek [#totalamountsek]

> `readonly` **totalAmountSek**: `number`

#### upcomingDividends [#upcomingdividends-1]

> `readonly` **upcomingDividends**: readonly [`CalendarDividend`](./CalendarDividend.md)\[]

***

### yearMonth [#yearmonth]

> `readonly` **yearMonth**: `string`

`yyyy-MM`.


# Interface: CalendarOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/CalendarOrderbook)



## Properties [#properties]

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### id [#id]

> `readonly` **id**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### name [#name]

> `readonly` **name**: `string`


# Interface: CalendarReport (/avanza-ts/docs/sdk/reference/generated/interfaces/CalendarReport)



## Properties [#properties]

### companyName [#companyname]

> `readonly` **companyName**: `string`

***

### date [#date]

> `readonly` **date**: `string`

***

### orderbook [#orderbook]

> `readonly` **orderbook**: [`CalendarOrderbook`](./CalendarOrderbook.md)

***

### reportType [#reporttype]

> `readonly` **reportType**: `string`


# Interface: CategorizedAccountOverviewResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/CategorizedAccountOverviewResponse)



## Properties [#properties]

### accounts [#accounts]

> `readonly` **accounts**: readonly `object`\[]

***

### categories [#categories]

> `readonly` **categories**: readonly `object`\[]

***

### loans [#loans]

> `readonly` **loans**: readonly `object`\[]


# Interface: ChartPeriodChange (/avanza-ts/docs/sdk/reference/generated/interfaces/ChartPeriodChange)



## Properties [#properties]

### change [#change]

> `readonly` **change**: `number` | `null`

***

### startDate [#startdate]

> `readonly` **startDate**: `string` | `null`

***

### timePeriod [#timeperiod]

> `readonly` **timePeriod**: `"today"` | `"one_week"` | `"one_month"` | `"three_months"` | `"this_year"` | `"one_year"` | `"three_years"` | `"five_years"` | `"infinity"`


# Interface: ClosedAccount (/avanza-ts/docs/sdk/reference/generated/interfaces/ClosedAccount)



## Properties [#properties]

### accountType [#accounttype]

> `readonly` **accountType**: `string`

***

### closedDate [#closeddate]

> `readonly` **closedDate**: `string` | `null`

***

### id [#id]

> `readonly` **id**: `string`

***

### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`


# Interface: CollectionsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/CollectionsClient)



Read-only watchlists, alerts, and instrument notes. All require a session.

## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### alerts() [#alerts]

> **alerts**(`signal?`): `Promise`\<[`AlertsResponse`](./AlertsResponse.md)>

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`AlertsResponse`](./AlertsResponse.md)>

***

### noteOrderbooks() [#noteorderbooks]

> **noteOrderbooks**(`signal?`): `Promise`\<readonly [`NoteOrderbook`](./NoteOrderbook.md)\[]>

Orderbooks that have at least one note.

#### Parameters [#parameters-1]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<readonly [`NoteOrderbook`](./NoteOrderbook.md)\[]>

***

### notes() [#notes]

> **notes**(`orderbookId?`, `signal?`): `Promise`\<readonly [`Note`](./Note.md)\[]>

#### Parameters [#parameters-2]

##### orderbookId? [#orderbookid]

`string`

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<readonly [`Note`](./Note.md)\[]>

***

### triggeredAlerts() [#triggeredalerts]

> **triggeredAlerts**(`signal?`): `Promise`\<readonly [`Alert`](../type-aliases/Alert.md)\[]>

#### Parameters [#parameters-3]

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<readonly [`Alert`](../type-aliases/Alert.md)\[]>

***

### watchlistData() [#watchlistdata]

> **watchlistData**(`watchListId`, `orderbookIds`, `dataPoints?`, `signal?`): `Promise`\<readonly [`WatchlistRow`](./WatchlistRow.md)\[]>

Queries rows for `orderbookIds` in a watchlist; `dataPoints` select the returned fields.

#### Parameters [#parameters-4]

##### watchListId [#watchlistid]

`string`

##### orderbookIds [#orderbookids]

readonly `string`\[]

##### dataPoints? [#datapoints]

readonly (`"ABSOLUTE_PERFORMANCE_SINCE_ADDED"` | `"BETA"` | `"BUY_OR_SELL"` | `"BUY_PRICE"` | `"CATEGORY"` | `"CHANGE"` | `"CHANGE_PERCENTAGE"` | `"COLLATERAL_FACTOR"` | `"CURRENCY"` | `"DATE_WHEN_ADDED"` | `"DIRECTION"` | `"DIVIDENDS_AMOUNT_12_MONTHS"` | `"DIVIDENDS_PER_YEAR"` | `"EARNINGS_PER_SHARE"` | `"END_DATE"` | `"ETF_ORDINARY_DIRECT_YIELD"` | `"ETF_RISK"` | `"EV_EBIT_RATIO"` | `"FIVE_YEARS_PERFORMANCE"` | `"FLAG_CODE"` | `"FUND_RATING"` | `"FUND_RISK"` | `"FUND_TOTAL_MARKET_VALUE"` | `"HIGHEST_PRICE"` | `"INSTRUMENT_TYPE"` | `"LAST_PRICE"` | `"LEVERAGE"` | `"LOWEST_PRICE"` | `"MANAGEMENT_FEE"` | `"MARGIN_REQUIREMENT"` | `"MARKET_CAP"` | `"MAX_PERFORMANCE"` | `"NAME"` | `"NAV"` | `"NET_DEBT_TO_EBITDA_RATIO"` | `"NEXT_DIVIDEND_AMOUNT"` | `"NEXT_DIVIDEND_DATE"` | `"NEXT_REPORT_DATE"` | `"NUMBER_OF_OWNERS"` | `"ONE_MONTH_PERFORMANCE"` | `"ONE_WEEK_PERFORMANCE"` | `"ONE_YEAR_PERFORMANCE"` | `"OPTION_TYPE"` | `"ORDINARY_DIRECT_YIELD"` | `"PRICE_BOOK_RATIO"` | `"PRICE_EARNINGS_RATIO"` | `"PRICE_LAST_UPDATED_DATE"` | `"PRICE_LAST_UPDATED_TIME"` | `"PRICE_SALES_RATIO"` | `"PRICE_WHEN_ADDED"` | `"PRODUCT_FEE"` | `"RELATIVE_PERFORMANCE_SINCE_ADDED"` | `"RETURN_ON_EQUITY"` | `"SELL_PRICE"` | `"SHARPE_RATIO"` | `"SHORT_SELLING_ALLOWED"` | `"SIX_MONTHS_PERFORMANCE"` | `"SPREAD"` | `"STANDARD_DEVIATION_PERCENT"` | `"STRIKE_PRICE"` | `"SUPER_INTEREST_APPROVED"` | `"TEN_YEARS_PERFORMANCE"` | `"THIS_YEAR_PERFORMANCE"` | `"THREE_MONTHS_PERFORMANCE"` | `"THREE_YEARS_PERFORMANCE"` | `"TOTAL_FEE"` | `"UNDERLYING_INSTRUMENT_NAME"` | `"VALUE_TRADED"` | `"VOLATILITY"` | `"VOLUME_TRADED"` | `"WARRANT_LEVERAGE"` | `"WARRANT_TYPE"`)\[] = `...`

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<readonly [`WatchlistRow`](./WatchlistRow.md)\[]>

***

### watchlistNews() [#watchlistnews]

> **watchlistNews**(`orderbookIds`, `options?`, `signal?`): `Promise`\<[`WatchlistNewsResponse`](./WatchlistNewsResponse.md)>

#### Parameters [#parameters-5]

##### orderbookIds [#orderbookids-1]

readonly `string`\[]

##### options? [#options]

[`WatchlistNewsOptions`](./WatchlistNewsOptions.md) = `{}`

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<[`WatchlistNewsResponse`](./WatchlistNewsResponse.md)>

***

### watchlists() [#watchlists]

> **watchlists**(`signal?`): `Promise`\<readonly [`Watchlist`](./Watchlist.md)\[]>

#### Parameters [#parameters-6]

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<readonly [`Watchlist`](./Watchlist.md)\[]>


# Interface: CompanyEvent (/avanza-ts/docs/sdk/reference/generated/interfaces/CompanyEvent)



## Properties [#properties]

### eventType [#eventtype]

> `readonly` **eventType**: `string`

***

### timestamp [#timestamp]

> `readonly` **timestamp**: `number`


# Interface: CompanyReport (/avanza-ts/docs/sdk/reference/generated/interfaces/CompanyReport)



## Properties [#properties]

### date [#date]

> `readonly` **date**: `string`

***

### isConfirmed [#isconfirmed]

> `readonly` **isConfirmed**: `boolean`

***

### reportType [#reporttype]

> `readonly` **reportType**: `string`


# Interface: CreditAccountsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/CreditAccountsResponse)



## Properties [#properties]

### accounts [#accounts]

> `readonly` **accounts**: readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]


# Interface: CreditInfo (/avanza-ts/docs/sdk/reference/generated/interfaces/CreditInfo)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### creditLimit [#creditlimit]

> `readonly` **creditLimit**: `number`

***

### currentCreditBreakPoints [#currentcreditbreakpoints]

> `readonly` **currentCreditBreakPoints**: readonly `object`\[]

***

### currentInterest [#currentinterest]

> `readonly` **currentInterest**: `number`

***

### currentLeverage [#currentleverage]

> `readonly` **currentLeverage**: `number`

***

### currentLtv [#currentltv]

> `readonly` **currentLtv**: `number`

Loan to value.

***

### currentTotalPotentialCollateralValue [#currenttotalpotentialcollateralvalue]

> `readonly` **currentTotalPotentialCollateralValue**: `number`

***

### currentUsedCredit [#currentusedcredit]

> `readonly` **currentUsedCredit**: `number`

***

### ongoingOrders [#ongoingorders]

> `readonly` **ongoingOrders**: `unknown`


# Interface: CreditInfoResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/CreditInfoResponse)



## Properties [#properties]

### creditInfos [#creditinfos]

> `readonly` **creditInfos**: readonly [`CreditInfo`](./CreditInfo.md)\[]


# Interface: CurrencyBalance (/avanza-ts/docs/sdk/reference/generated/interfaces/CurrencyBalance)



## Properties [#properties]

### balance [#balance]

> `readonly` **balance**: [`AccountAmount`](./AccountAmount.md)


# Interface: DealsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/DealsResponse)



## Properties [#properties]

### deals [#deals]

> `readonly` **deals**: readonly [`DealItem`](../type-aliases/DealItem.md)\[]

***

### fundDeals [#funddeals]

> `readonly` **fundDeals**: readonly [`DealItem`](../type-aliases/DealItem.md)\[]


# Interface: Dividend (/avanza-ts/docs/sdk/reference/generated/interfaces/Dividend)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### amount [#amount]

> `readonly` **amount**: [`DividendAmount`](./DividendAmount.md) | `null`

***

### amountInSek [#amountinsek]

> `readonly` **amountInSek**: `number`

***

### amountPerShare [#amountpershare]

> `readonly` **amountPerShare**: [`DividendAmount`](./DividendAmount.md) | `null`

***

### amountPerShareInSek [#amountpershareinsek]

> `readonly` **amountPerShareInSek**: `number`

***

### currencyRate [#currencyrate]

> `readonly` **currencyRate**: `number` | `null`

***

### date [#date]

> `readonly` **date**: `string`

***

### encryptedAccountId [#encryptedaccountid]

> `readonly` **encryptedAccountId**: `string`

***

### instrumentName [#instrumentname]

> `readonly` **instrumentName**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### orderbook [#orderbook]

> `readonly` **orderbook**: [`TransactionOrderbook`](./TransactionOrderbook.md) | `null`

***

### stockRedemptionPayment [#stockredemptionpayment]

> `readonly` **stockRedemptionPayment**: `boolean`

***

### transactionCurrency [#transactioncurrency]

> `readonly` **transactionCurrency**: `string`

***

### volume [#volume]

> `readonly` **volume**: `number`


# Interface: DividendAmount (/avanza-ts/docs/sdk/reference/generated/interfaces/DividendAmount)



## Properties [#properties]

### currency [#currency]

> `readonly` **currency**: `string`

***

### value [#value]

> `readonly` **value**: `number`


# Interface: DividendOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/DividendOptions)



## Properties [#properties]

### accountId? [#accountid]

> `readonly` `optional` &#x2A;*accountId?**: `string`

***

### includeClosedAccounts? [#includeclosedaccounts]

> `readonly` `optional` &#x2A;*includeClosedAccounts?**: `boolean`


# Interface: EtfDetailsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/EtfDetailsResponse)



## Properties [#properties]

### assetCategory [#assetcategory]

> `readonly` **assetCategory**: `string`

***

### brokerTradeSummaries [#brokertradesummaries]

> `readonly` **brokerTradeSummaries**: readonly [`BrokerTradeSummary`](./BrokerTradeSummary.md)\[]

***

### category [#category]

> `readonly` **category**: `string`

***

### collateralValue [#collateralvalue]

> `readonly` **collateralValue**: `number`

***

### countryExposures [#countryexposures]

> `readonly` **countryExposures**: [`Exposures`](./Exposures.md)\<\{ `countryCode`: `string`; `countryName`: `string`; `weight`: `number`; }>

***

### description [#description]

> `readonly` **description**: `string`

***

### dividends [#dividends]

> `readonly` **dividends**: `object`

#### events [#events]

> `readonly` **events**: readonly `unknown`\[]

#### pastEvents [#pastevents]

> `readonly` **pastEvents**: readonly `unknown`\[]

***

### documents [#documents]

> `readonly` **documents**: `Readonly`\<`Record`\<`string`, `string`>>

***

### esgView [#esgview]

> `readonly` **esgView**: `unknown`

***

### fundExposures [#fundexposures]

> `readonly` **fundExposures**: readonly `object`\[]

***

### holdingPeriod [#holdingperiod]

> `readonly` **holdingPeriod**: `string`

***

### introDate [#introdate]

> `readonly` **introDate**: `string`

***

### issuer [#issuer]

> `readonly` **issuer**: `string`

***

### orderDepth [#orderdepth]

> `readonly` **orderDepth**: [`OrderDepth`](./OrderDepth.md)

***

### portfolioDate [#portfoliodate]

> `readonly` **portfolioDate**: `string`

***

### riskScore [#riskscore]

> `readonly` **riskScore**: `string`

***

### sectorExposures [#sectorexposures]

> `readonly` **sectorExposures**: [`Exposures`](./Exposures.md)\<\{ `sector`: `string`; `weight`: `number`; }>

***

### subCategory [#subcategory]

> `readonly` **subCategory**: `string`

***

### superInterestApproved [#superinterestapproved]

> `readonly` **superInterestApproved**: `boolean`

***

### trades [#trades]

> `readonly` **trades**: readonly [`MarketTrade`](./MarketTrade.md)\[]

***

### tradingUnit [#tradingunit]

> `readonly` **tradingUnit**: `number`

***

### underlying [#underlying]

> `readonly` **underlying**: [`EtfUnderlying`](./EtfUnderlying.md) | `null`


# Interface: EtfResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/EtfResponse)



## Properties [#properties]

### historicalClosingPrices [#historicalclosingprices]

> `readonly` **historicalClosingPrices**: `Readonly`\<`Record`\<`string`, `number` | `string`>>

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### keyIndicators [#keyindicators]

> `readonly` **keyIndicators**: `object`

#### direction [#direction]

> `readonly` **direction**: `string`

#### historicYield? [#historicyield]

> `readonly` `optional` &#x2A;*historicYield?**: `number`

#### historicYieldDate? [#historicyielddate]

> `readonly` `optional` &#x2A;*historicYieldDate?**: `string`

#### leverage [#leverage]

> `readonly` **leverage**: `number`

#### numberOfOwners [#numberofowners]

> `readonly` **numberOfOwners**: `number`

***

### listing [#listing]

> `readonly` **listing**: [`Listing`](./Listing.md)

***

### marketPlace [#marketplace]

> `readonly` **marketPlace**: `object`

#### marketOpen [#marketopen]

> `readonly` **marketOpen**: `boolean`

#### normalClosingTime [#normalclosingtime]

> `readonly` **normalClosingTime**: `string`

#### openingTime [#openingtime]

> `readonly` **openingTime**: `string`

#### timeLeftMs [#timeleftms]

> `readonly` **timeLeftMs**: `number`

#### todayClosingTime [#todayclosingtime]

> `readonly` **todayClosingTime**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### quote [#quote]

> `readonly` **quote**: [`StockQuote`](./StockQuote.md)

***

### tradable [#tradable]

> `readonly` **tradable**: `string`

***

### type [#type]

> `readonly` **type**: `string`

***

### underlying [#underlying]

> `readonly` **underlying**: [`EtfUnderlying`](./EtfUnderlying.md) | `null`


# Interface: EtfUnderlying (/avanza-ts/docs/sdk/reference/generated/interfaces/EtfUnderlying)



## Properties [#properties]

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### listing [#listing]

> `readonly` **listing**: [`Listing`](./Listing.md)

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### previousClosingPrice [#previousclosingprice]

> `readonly` **previousClosingPrice**: `number` | `null`

***

### quote [#quote]

> `readonly` **quote**: `Partial`\<[`StockQuote`](./StockQuote.md)>


# Interface: ExchangeRate (/avanza-ts/docs/sdk/reference/generated/interfaces/ExchangeRate)



## Properties [#properties]

### buyPrice [#buyprice]

> `readonly` **buyPrice**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### sellPrice [#sellprice]

> `readonly` **sellPrice**: `string`

***

### updated [#updated]

> `readonly` **updated**: `string`


# Interface: Exposures\<Exposure\> (/avanza-ts/docs/sdk/reference/generated/interfaces/Exposures)



## Type Parameters [#type-parameters]

### Exposure [#exposure]

`Exposure`

## Properties [#properties]

### exposures [#exposures]

> `readonly` **exposures**: readonly `Exposure`\[]

***

### updated [#updated]

> `readonly` **updated**: `string`


# Interface: FundChartResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/FundChartResponse)



## Properties [#properties]

### dataSerie [#dataserie]

> `readonly` **dataSerie**: readonly `object`\[]

`x` is a timestamp in milliseconds; `y` is the change in percent.

***

### fromDate [#fromdate]

> `readonly` **fromDate**: `string`

***

### id [#id]

> `readonly` **id**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### toDate [#todate]

> `readonly` **toDate**: `string`


# Interface: FundDescription (/avanza-ts/docs/sdk/reference/generated/interfaces/FundDescription)



## Properties [#properties]

### detailedCategoryDescription [#detailedcategorydescription]

> `readonly` **detailedCategoryDescription**: `string`

***

### heading [#heading]

> `readonly` **heading**: `string`

***

### response [#response]

> `readonly` **response**: `string`

The fund's description text.


# Interface: FundDevelopment (/avanza-ts/docs/sdk/reference/generated/interfaces/FundDevelopment)



## Properties [#properties]

### developmentFiveYears [#developmentfiveyears]

> `readonly` **developmentFiveYears**: `number` | `null`

***

### developmentOneDay [#developmentoneday]

> `readonly` **developmentOneDay**: `number` | `null`

***

### developmentOneMonth [#developmentonemonth]

> `readonly` **developmentOneMonth**: `number` | `null`

***

### developmentOneWeek [#developmentoneweek]

> `readonly` **developmentOneWeek**: `number` | `null`

***

### developmentOneYear [#developmentoneyear]

> `readonly` **developmentOneYear**: `number` | `null`

***

### developmentSixMonths [#developmentsixmonths]

> `readonly` **developmentSixMonths**: `number` | `null`

***

### developmentTenYears [#developmenttenyears]

> `readonly` **developmentTenYears**: `number` | `null`

***

### developmentThisYear [#developmentthisyear]

> `readonly` **developmentThisYear**: `number` | `null`

***

### developmentThreeMonths [#developmentthreemonths]

> `readonly` **developmentThreeMonths**: `number` | `null`

***

### developmentThreeYears [#developmentthreeyears]

> `readonly` **developmentThreeYears**: `number` | `null`


# Interface: FundFilterCount (/avanza-ts/docs/sdk/reference/generated/interfaces/FundFilterCount)



## Properties [#properties]

### active [#active]

> `readonly` **active**: `boolean`

***

### count [#count]

> `readonly` **count**: `number`

***

### group [#group]

> `readonly` **group**: `number`

***

### title [#title]

> `readonly` **title**: `string`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: FundGuide (/avanza-ts/docs/sdk/reference/generated/interfaces/FundGuide)



The complete fund page: reference data, returns, allocation, and sustainability.

## Properties [#properties]

### adminCompany [#admincompany]

> `readonly` **adminCompany**: `object`

#### country [#country]

> `readonly` **country**: `string`

#### name [#name]

> `readonly` **name**: `string`

#### url [#url]

> `readonly` **url**: `string`

***

### aumCoveredCarbon [#aumcoveredcarbon]

> `readonly` **aumCoveredCarbon**: `number` | `null`

***

### capital [#capital]

> `readonly` **capital**: `number`

***

### carbonRiskScore [#carbonriskscore]

> `readonly` **carbonRiskScore**: `number` | `null`

***

### carbonSolutionsInvolvement [#carbonsolutionsinvolvement]

> `readonly` **carbonSolutionsInvolvement**: `number` | `null`

***

### categories [#categories]

> `readonly` **categories**: readonly `string`\[]

***

### controversyScore [#controversyscore]

> `readonly` **controversyScore**: `number` | `null`

***

### countryChartData [#countrychartdata]

> `readonly` **countryChartData**: readonly [`FundPortfolioPoint`](./FundPortfolioPoint.md)\[]

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### description [#description]

> `readonly` **description**: `string`

***

### developmentFiveYears [#developmentfiveyears]

> `readonly` **developmentFiveYears**: `number` | `null`

***

### developmentOneDay [#developmentoneday]

> `readonly` **developmentOneDay**: `number` | `null`

***

### developmentOneMonth [#developmentonemonth]

> `readonly` **developmentOneMonth**: `number` | `null`

***

### developmentOneYear [#developmentoneyear]

> `readonly` **developmentOneYear**: `number` | `null`

***

### developmentSixMonths [#developmentsixmonths]

> `readonly` **developmentSixMonths**: `number` | `null`

***

### developmentThisYear [#developmentthisyear]

> `readonly` **developmentThisYear**: `number` | `null`

***

### developmentThreeMonths [#developmentthreemonths]

> `readonly` **developmentThreeMonths**: `number` | `null`

***

### developmentThreeYears [#developmentthreeyears]

> `readonly` **developmentThreeYears**: `number` | `null`

***

### environmentalScore [#environmentalscore]

> `readonly` **environmentalScore**: `number` | `null`

***

### esgScore [#esgscore]

> `readonly` **esgScore**: `number` | `null`

***

### fossilFuelInvolvement [#fossilfuelinvolvement]

> `readonly` **fossilFuelInvolvement**: `number` | `null`

***

### fundManagers [#fundmanagers]

> `readonly` **fundManagers**: readonly `object`\[]

***

### fundRatingViews [#fundratingviews]

> `readonly` **fundRatingViews**: readonly [`FundRatingView`](./FundRatingView.md)\[]

***

### fundType [#fundtype]

> `readonly` **fundType**: `string`

***

### fundTypeName [#fundtypename]

> `readonly` **fundTypeName**: `string`

***

### governanceScore [#governancescore]

> `readonly` **governanceScore**: `number` | `null`

***

### hedgeFund [#hedgefund]

> `readonly` **hedgeFund**: `boolean`

***

### holdingChartData [#holdingchartdata]

> `readonly` **holdingChartData**: readonly [`FundPortfolioPoint`](./FundPortfolioPoint.md)\[]

***

### indexFund [#indexfund]

> `readonly` **indexFund**: `boolean`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### lowCarbon [#lowcarbon]

> `readonly` **lowCarbon**: `boolean` | `null`

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number`

***

### name [#name-1]

> `readonly` **name**: `string`

***

### nav [#nav]

> `readonly` **nav**: `number`

***

### navDate [#navdate]

> `readonly` **navDate**: `string`

***

### portfolioDate [#portfoliodate]

> `readonly` **portfolioDate**: `string`

***

### ppmCode [#ppmcode]

> `readonly` **ppmCode**: `string` | `null`

***

### pricingFrequency [#pricingfrequency]

> `readonly` **pricingFrequency**: `string`

***

### primaryBenchmark [#primarybenchmark]

> `readonly` **primaryBenchmark**: `string` | `null`

***

### productFee [#productfee]

> `readonly` **productFee**: `number`

***

### productInvolvements [#productinvolvements]

> `readonly` **productInvolvements**: readonly [`FundProductInvolvement`](./FundProductInvolvement.md)\[]

***

### prospectusLink [#prospectuslink]

> `readonly` **prospectusLink**: `string`

***

### rating [#rating]

> `readonly` **rating**: `number` | `null`

***

### recommendedHoldingPeriod [#recommendedholdingperiod]

> `readonly` **recommendedHoldingPeriod**: `string`

***

### risk [#risk]

> `readonly` **risk**: `number`

***

### riskText [#risktext]

> `readonly` **riskText**: `string`

***

### sectorChartData [#sectorchartdata]

> `readonly` **sectorChartData**: readonly [`FundPortfolioPoint`](./FundPortfolioPoint.md)\[]

***

### sharpeRatio [#sharperatio]

> `readonly` **sharpeRatio**: `number` | `null`

***

### socialScore [#socialscore]

> `readonly` **socialScore**: `number` | `null`

***

### standardDeviation [#standarddeviation]

> `readonly` **standardDeviation**: `number` | `null`

***

### startDate [#startdate]

> `readonly` **startDate**: `string`

***

### superloanOrderbook [#superloanorderbook]

> `readonly` **superloanOrderbook**: `boolean`

***

### sustainabilityRating [#sustainabilityrating]

> `readonly` **sustainabilityRating**: `number` | `null`

***

### sustainabilityRatingCategoryName [#sustainabilityratingcategoryname]

> `readonly` **sustainabilityRatingCategoryName**: `string`

***

### svanen [#svanen]

> `readonly` **svanen**: `boolean`

***

### ucitsFund [#ucitsfund]

> `readonly` **ucitsFund**: `boolean`


# Interface: FundInstrumentSearchResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/FundInstrumentSearchResponse)



## Properties [#properties]

### orderbookSearchViews [#orderbooksearchviews]

> `readonly` **orderbookSearchViews**: readonly `object`\[]

***

### totalNumberOfHits [#totalnumberofhits]

> `readonly` **totalNumberOfHits**: `number`


# Interface: FundListOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/FundListOptions)



Filter values come from the `filterCounts` titles in a list response.

## Properties [#properties]

### filter? [#filter]

> `readonly` `optional` &#x2A;*filter?**: `Readonly`\<`Record`\<`string`, `string` | `number` | `boolean` | readonly `string`\[] | `null`>>

***

### maxNoResults? [#maxnoresults]

> `readonly` `optional` &#x2A;*maxNoResults?**: `number`

***

### name? [#name]

> `readonly` `optional` &#x2A;*name?**: `string`

***

### sortDirection? [#sortdirection]

> `readonly` `optional` &#x2A;*sortDirection?**: [`FundSortDirection`](../type-aliases/FundSortDirection.md)

***

### sortField? [#sortfield]

> `readonly` `optional` &#x2A;*sortField?**: `string`

A `FundListView` field, for example `developmentThreeYears`.

***

### startIndex? [#startindex]

> `readonly` `optional` &#x2A;*startIndex?**: `number`


# Interface: FundListResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/FundListResponse)



## Properties [#properties]

### filterCounts [#filtercounts]

> `readonly` **filterCounts**: `Readonly`\<`Record`\<`string`, readonly [`FundFilterCount`](./FundFilterCount.md)\[]>>

***

### filteredFundsMetaData [#filteredfundsmetadata]

> `readonly` **filteredFundsMetaData**: `object`

#### averageEsgScore [#averageesgscore]

> `readonly` **averageEsgScore**: `number`

#### averageRisk [#averagerisk]

> `readonly` **averageRisk**: `number`

#### averageTotalFee [#averagetotalfee]

> `readonly` **averageTotalFee**: `number`

#### numberOfEtfs [#numberofetfs]

> `readonly` **numberOfEtfs**: `number`

#### numberOfFunds [#numberoffunds]

> `readonly` **numberOfFunds**: `number`

#### numberOfFundsEsgScore [#numberoffundsesgscore]

> `readonly` **numberOfFundsEsgScore**: `number`

#### numberOfFundsRisk [#numberoffundsrisk]

> `readonly` **numberOfFundsRisk**: `number`

#### numberOfFundsTotalFee [#numberoffundstotalfee]

> `readonly` **numberOfFundsTotalFee**: `number`

***

### fundListViews [#fundlistviews]

> `readonly` **fundListViews**: readonly [`FundListView`](./FundListView.md)\[]

***

### totalNoFunds [#totalnofunds]

> `readonly` **totalNoFunds**: `number`


# Interface: FundListView (/avanza-ts/docs/sdk/reference/generated/interfaces/FundListView)



## Properties [#properties]

### arcticOilAndGasExplorationInvolvement [#arcticoilandgasexplorationinvolvement]

> `readonly` **arcticOilAndGasExplorationInvolvement**: `number` | `null`

***

### aumCoveredCarbon [#aumcoveredcarbon]

> `readonly` **aumCoveredCarbon**: `number` | `null`

***

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### capital [#capital]

> `readonly` **capital**: `number`

***

### carbonRiskScore [#carbonriskscore]

> `readonly` **carbonRiskScore**: `number` | `null`

***

### carbonSolutionsInvolvement [#carbonsolutionsinvolvement]

> `readonly` **carbonSolutionsInvolvement**: `number` | `null`

***

### category [#category]

> `readonly` **category**: `string`

***

### collateralValue [#collateralvalue]

> `readonly` **collateralValue**: `number`

***

### companyName [#companyname]

> `readonly` **companyName**: `string`

***

### currencyCode [#currencycode]

> `readonly` **currencyCode**: `string`

***

### developmentFiveYears [#developmentfiveyears]

> `readonly` **developmentFiveYears**: `number` | `null`

***

### developmentOneDay [#developmentoneday]

> `readonly` **developmentOneDay**: `number` | `null`

***

### developmentOneMonth [#developmentonemonth]

> `readonly` **developmentOneMonth**: `number` | `null`

***

### developmentOneWeek [#developmentoneweek]

> `readonly` **developmentOneWeek**: `number` | `null`

***

### developmentOneYear [#developmentoneyear]

> `readonly` **developmentOneYear**: `number` | `null`

***

### developmentTenYears [#developmenttenyears]

> `readonly` **developmentTenYears**: `number` | `null`

***

### developmentThisYear [#developmentthisyear]

> `readonly` **developmentThisYear**: `number` | `null`

***

### developmentThreeMonths [#developmentthreemonths]

> `readonly` **developmentThreeMonths**: `number` | `null`

***

### developmentThreeYears [#developmentthreeyears]

> `readonly` **developmentThreeYears**: `number` | `null`

***

### environmentalRating [#environmentalrating]

> `readonly` **environmentalRating**: `number` | `null`

***

### environmentalScore [#environmentalscore]

> `readonly` **environmentalScore**: `number` | `null`

***

### esgScore [#esgscore]

> `readonly` **esgScore**: `number` | `null`

***

### euArticleType [#euarticletype]

> `readonly` **euArticleType**: [`FundNamedValue`](./FundNamedValue.md)

***

### fossilFuelInvolvement [#fossilfuelinvolvement]

> `readonly` **fossilFuelInvolvement**: `number` | `null`

***

### fundRatingViews [#fundratingviews]

> `readonly` **fundRatingViews**: readonly [`FundRatingView`](./FundRatingView.md)\[]

***

### fundType [#fundtype]

> `readonly` **fundType**: `string`

***

### governanceRating [#governancerating]

> `readonly` **governanceRating**: `number` | `null`

***

### governanceScore [#governancescore]

> `readonly` **governanceScore**: `number` | `null`

***

### hasCashDividends [#hascashdividends]

> `readonly` **hasCashDividends**: `boolean`

***

### hasCurrencyExchangeFee [#hascurrencyexchangefee]

> `readonly` **hasCurrencyExchangeFee**: `boolean`

***

### indexFund [#indexfund]

> `readonly` **indexFund**: `boolean`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### lowCarbon [#lowcarbon]

> `readonly` **lowCarbon**: `boolean` | `null`

***

### managedType [#managedtype]

> `readonly` **managedType**: `string`

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number`

***

### minimumBuy [#minimumbuy]

> `readonly` **minimumBuy**: `number`

***

### minimumBuyMonthlySaving [#minimumbuymonthlysaving]

> `readonly` **minimumBuyMonthlySaving**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### nav [#nav]

> `readonly` **nav**: `number`

***

### navDate [#navdate]

> `readonly` **navDate**: `string`

***

### nrBuyOrders [#nrbuyorders]

> `readonly` **nrBuyOrders**: `number`

***

### nrOfOwners [#nrofowners]

> `readonly` **nrOfOwners**: `number`

***

### nrSellOrders [#nrsellorders]

> `readonly` **nrSellOrders**: `number`

***

### oilSandsExtractionInvolvement [#oilsandsextractioninvolvement]

> `readonly` **oilSandsExtractionInvolvement**: `number` | `null`

***

### ongoingFee [#ongoingfee]

> `readonly` **ongoingFee**: `number`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### otherFee [#otherfee]

> `readonly` **otherFee**: `number`

***

### primaryBenchmark [#primarybenchmark]

> `readonly` **primaryBenchmark**: `string` | `null`

***

### productInvolvementViews [#productinvolvementviews]

> `readonly` **productInvolvementViews**: readonly [`FundProductInvolvement`](./FundProductInvolvement.md)\[]

***

### prospectusLink [#prospectuslink]

> `readonly` **prospectusLink**: `string`

***

### rating [#rating]

> `readonly` **rating**: `number` | `null`

***

### recommendedHoldingPeriod [#recommendedholdingperiod]

> `readonly` **recommendedHoldingPeriod**: `string`

***

### recommendedHoldingPeriodValue [#recommendedholdingperiodvalue]

> `readonly` **recommendedHoldingPeriodValue**: `string`

***

### risk [#risk]

> `readonly` **risk**: `number`

***

### sharpeRatio [#sharperatio]

> `readonly` **sharpeRatio**: `number` | `null`

***

### socialRating [#socialrating]

> `readonly` **socialRating**: `number` | `null`

***

### socialScore [#socialscore]

> `readonly` **socialScore**: `number` | `null`

***

### standardDeviation [#standarddeviation]

> `readonly` **standardDeviation**: `number` | `null`

***

### startDate [#startdate]

> `readonly` **startDate**: `string`

***

### superloanOrderbook [#superloanorderbook]

> `readonly` **superloanOrderbook**: `boolean`

***

### sustainabilityLevel [#sustainabilitylevel]

> `readonly` **sustainabilityLevel**: `string` | `null`

***

### sustainabilityRating [#sustainabilityrating]

> `readonly` **sustainabilityRating**: `number` | `null`

***

### sustainabilityRatingCategoryName [#sustainabilityratingcategoryname]

> `readonly` **sustainabilityRatingCategoryName**: `string`

***

### svanen [#svanen]

> `readonly` **svanen**: `boolean`

***

### tagList [#taglist]

> `readonly` **tagList**: readonly `object`\[]

***

### thermalCoalInvolvement [#thermalcoalinvolvement]

> `readonly` **thermalCoalInvolvement**: `number` | `null`

***

### totalFee [#totalfee]

> `readonly` **totalFee**: `number`

***

### transactionFee [#transactionfee]

> `readonly` **transactionFee**: `number`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: FundNamedValue (/avanza-ts/docs/sdk/reference/generated/interfaces/FundNamedValue)



## Properties [#properties]

### name [#name]

> `readonly` **name**: `string`

***

### value [#value]

> `readonly` **value**: `string`


# Interface: FundOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/FundOrderbook)



## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### buyCommission [#buycommission]

> `readonly` **buyCommission**: `number`

***

### buyStopDateTime [#buystopdatetime]

> `readonly` **buyStopDateTime**: `string`

***

### hasCurrencyExchangeFee [#hascurrencyexchangefee]

> `readonly` **hasCurrencyExchangeFee**: `boolean`

***

### minimumThresholdAdditionalBuy [#minimumthresholdadditionalbuy]

> `readonly` **minimumThresholdAdditionalBuy**: `number`

***

### minimumThresholdBuy [#minimumthresholdbuy]

> `readonly` **minimumThresholdBuy**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### nav [#nav]

> `readonly` **nav**: `number`

***

### navDate [#navdate]

> `readonly` **navDate**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### privateAsset [#privateasset]

> `readonly` **privateAsset**: `boolean`

***

### productFee [#productfee]

> `readonly` **productFee**: `number`

***

### prospectusLink [#prospectuslink]

> `readonly` **prospectusLink**: `string`

***

### sellStopDateTime [#sellstopdatetime]

> `readonly` **sellStopDateTime**: `string`


# Interface: FundOrderbookDetails (/avanza-ts/docs/sdk/reference/generated/interfaces/FundOrderbookDetails)



## Extends [#extends]

* `Omit`\<[`FundOrderbook`](./FundOrderbook.md), `"privateAsset"`>

## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

#### Inherited from [#inherited-from]

[`FundOrderbook`](./FundOrderbook.md).[`buyable`](./FundOrderbook.md#buyable)

***

### buyCommission [#buycommission]

> `readonly` **buyCommission**: `number`

#### Inherited from [#inherited-from-1]

[`FundOrderbook`](./FundOrderbook.md).[`buyCommission`](./FundOrderbook.md#buycommission)

***

### buyStopDateTime [#buystopdatetime]

> `readonly` **buyStopDateTime**: `string`

#### Inherited from [#inherited-from-2]

[`FundOrderbook`](./FundOrderbook.md).[`buyStopDateTime`](./FundOrderbook.md#buystopdatetime)

***

### description [#description]

> `readonly` **description**: `string`

***

### fundCompanyName [#fundcompanyname]

> `readonly` **fundCompanyName**: `string`

***

### hasCurrencyExchangeFee [#hascurrencyexchangefee]

> `readonly` **hasCurrencyExchangeFee**: `boolean`

#### Inherited from [#inherited-from-3]

[`FundOrderbook`](./FundOrderbook.md).[`hasCurrencyExchangeFee`](./FundOrderbook.md#hascurrencyexchangefee)

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number`

***

### minimumThresholdAdditionalBuy [#minimumthresholdadditionalbuy]

> `readonly` **minimumThresholdAdditionalBuy**: `number`

#### Inherited from [#inherited-from-4]

[`FundOrderbook`](./FundOrderbook.md).[`minimumThresholdAdditionalBuy`](./FundOrderbook.md#minimumthresholdadditionalbuy)

***

### minimumThresholdBuy [#minimumthresholdbuy]

> `readonly` **minimumThresholdBuy**: `number`

#### Inherited from [#inherited-from-5]

[`FundOrderbook`](./FundOrderbook.md).[`minimumThresholdBuy`](./FundOrderbook.md#minimumthresholdbuy)

***

### name [#name]

> `readonly` **name**: `string`

#### Inherited from [#inherited-from-6]

[`FundOrderbook`](./FundOrderbook.md).[`name`](./FundOrderbook.md#name)

***

### nav [#nav]

> `readonly` **nav**: `number`

#### Inherited from [#inherited-from-7]

[`FundOrderbook`](./FundOrderbook.md).[`nav`](./FundOrderbook.md#nav)

***

### navChangeFiveYears [#navchangefiveyears]

> `readonly` **navChangeFiveYears**: `number` | `null`

***

### navChangeOneYear [#navchangeoneyear]

> `readonly` **navChangeOneYear**: `number` | `null`

***

### navChangeTenYears [#navchangetenyears]

> `readonly` **navChangeTenYears**: `number` | `null`

***

### navChangeThreeMonths [#navchangethreemonths]

> `readonly` **navChangeThreeMonths**: `number` | `null`

***

### navChangeThreeYears [#navchangethreeyears]

> `readonly` **navChangeThreeYears**: `number` | `null`

***

### navDate [#navdate]

> `readonly` **navDate**: `string`

#### Inherited from [#inherited-from-8]

[`FundOrderbook`](./FundOrderbook.md).[`navDate`](./FundOrderbook.md#navdate)

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

#### Inherited from [#inherited-from-9]

[`FundOrderbook`](./FundOrderbook.md).[`orderbookId`](./FundOrderbook.md#orderbookid)

***

### owners [#owners]

> `readonly` **owners**: `number`

***

### productFee [#productfee]

> `readonly` **productFee**: `number`

#### Inherited from [#inherited-from-10]

[`FundOrderbook`](./FundOrderbook.md).[`productFee`](./FundOrderbook.md#productfee)

***

### prospectusLink [#prospectuslink]

> `readonly` **prospectusLink**: `string`

#### Inherited from [#inherited-from-11]

[`FundOrderbook`](./FundOrderbook.md).[`prospectusLink`](./FundOrderbook.md#prospectuslink)

***

### rating [#rating]

> `readonly` **rating**: `number` | `null`

***

### risk [#risk]

> `readonly` **risk**: `string`

***

### riskNumber [#risknumber]

> `readonly` **riskNumber**: `number`

***

### sellStopDateTime [#sellstopdatetime]

> `readonly` **sellStopDateTime**: `string`

#### Inherited from [#inherited-from-12]

[`FundOrderbook`](./FundOrderbook.md).[`sellStopDateTime`](./FundOrderbook.md#sellstopdatetime)


# Interface: FundPieChartPoint (/avanza-ts/docs/sdk/reference/generated/interfaces/FundPieChartPoint)



## Properties [#properties]

### name [#name]

> `readonly` **name**: `string`

***

### value [#value]

> `readonly` **value**: `number`


# Interface: FundPortfolioData (/avanza-ts/docs/sdk/reference/generated/interfaces/FundPortfolioData)



## Properties [#properties]

### countryChartData [#countrychartdata]

> `readonly` **countryChartData**: readonly [`FundPortfolioPoint`](./FundPortfolioPoint.md)\[]

***

### holdingChartData [#holdingchartdata]

> `readonly` **holdingChartData**: readonly [`FundPortfolioPoint`](./FundPortfolioPoint.md)\[]

***

### portfolioDate [#portfoliodate]

> `readonly` **portfolioDate**: `string`

***

### previousPortfolioDate [#previousportfoliodate]

> `readonly` **previousPortfolioDate**: `string`

***

### sectorChartData [#sectorchartdata]

> `readonly` **sectorChartData**: readonly [`FundPortfolioPoint`](./FundPortfolioPoint.md)\[]


# Interface: FundPortfolioPoint (/avanza-ts/docs/sdk/reference/generated/interfaces/FundPortfolioPoint)



## Properties [#properties]

### countryCode [#countrycode]

> `readonly` **countryCode**: `string` | `null`

***

### currency [#currency]

> `readonly` **currency**: `string` | `null`

***

### deltaRank [#deltarank]

> `readonly` **deltaRank**: `number` | `null`

***

### isin [#isin]

> `readonly` **isin**: `string` | `null`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string` | `null`

***

### previousY [#previousy]

> `readonly` **previousY**: `number`

***

### type [#type]

> `readonly` **type**: `string` | `null`

***

### y [#y]

> `readonly` **y**: `number`


# Interface: FundProductInvolvement (/avanza-ts/docs/sdk/reference/generated/interfaces/FundProductInvolvement)



## Properties [#properties]

### product [#product]

> `readonly` **product**: `string`

***

### productDescription [#productdescription]

> `readonly` **productDescription**: `string`

***

### value [#value]

> `readonly` **value**: `number`


# Interface: FundRatingView (/avanza-ts/docs/sdk/reference/generated/interfaces/FundRatingView)



## Properties [#properties]

### date [#date]

> `readonly` **date**: `string`

***

### fundRating [#fundrating]

> `readonly` **fundRating**: `number`

***

### fundRatingType [#fundratingtype]

> `readonly` **fundRatingType**: `string`


# Interface: FundReference (/avanza-ts/docs/sdk/reference/generated/interfaces/FundReference)



## Properties [#properties]

### adminCompany [#admincompany]

> `readonly` **adminCompany**: `object`

#### country [#country]

> `readonly` **country**: `string`

#### name [#name]

> `readonly` **name**: `string`

#### url [#url]

> `readonly` **url**: `string`

***

### capital [#capital]

> `readonly` **capital**: `number`

***

### categories [#categories]

> `readonly` **categories**: readonly `string`\[]

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### description [#description]

> `readonly` **description**: `string`

***

### excludedFromPromotion [#excludedfrompromotion]

> `readonly` **excludedFromPromotion**: `boolean`

***

### fundManagers [#fundmanagers]

> `readonly` **fundManagers**: readonly `object`\[]

***

### fundRatings [#fundratings]

> `readonly` **fundRatings**: readonly [`FundRatingView`](./FundRatingView.md)\[]

***

### fundType [#fundtype]

> `readonly` **fundType**: `string`

***

### fundTypeName [#fundtypename]

> `readonly` **fundTypeName**: `string`

***

### hedgeFund [#hedgefund]

> `readonly` **hedgeFund**: `boolean`

***

### indexFund [#indexfund]

> `readonly` **indexFund**: `boolean`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### managedType [#managedtype]

> `readonly` **managedType**: `string`

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number`

***

### name [#name-1]

> `readonly` **name**: `string`

***

### nav [#nav]

> `readonly` **nav**: `number`

***

### navDate [#navdate]

> `readonly` **navDate**: `string`

***

### ppmCode [#ppmcode]

> `readonly` **ppmCode**: `string` | `null`

***

### pricingFrequency [#pricingfrequency]

> `readonly` **pricingFrequency**: `string`

***

### primaryBenchmark [#primarybenchmark]

> `readonly` **primaryBenchmark**: `string` | `null`

***

### rating [#rating]

> `readonly` **rating**: `number` | `null`

***

### recommendedHoldingPeriod [#recommendedholdingperiod]

> `readonly` **recommendedHoldingPeriod**: `string`

***

### riskLevel [#risklevel]

> `readonly` **riskLevel**: `object`

#### riskNumber [#risknumber]

> `readonly` **riskNumber**: `number`

#### riskText [#risktext]

> `readonly` **riskText**: `string`

***

### sharpeRatio [#sharperatio]

> `readonly` **sharpeRatio**: `number` | `null`

***

### standardDeviation [#standarddeviation]

> `readonly` **standardDeviation**: `number` | `null`

***

### startDate [#startdate]

> `readonly` **startDate**: `string`

***

### ucitsFund [#ucitsfund]

> `readonly` **ucitsFund**: `boolean`


# Interface: FundSearchResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/FundSearchResponse)



## Properties [#properties]

### fundSearchViews [#fundsearchviews]

> `readonly` **fundSearchViews**: readonly [`FundSearchView`](./FundSearchView.md)\[]


# Interface: FundSearchView (/avanza-ts/docs/sdk/reference/generated/interfaces/FundSearchView)



## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### developmentFiveYears [#developmentfiveyears]

> `readonly` **developmentFiveYears**: `number` | `null`

***

### developmentOneYear [#developmentoneyear]

> `readonly` **developmentOneYear**: `number` | `null`

***

### developmentThreeYears [#developmentthreeyears]

> `readonly` **developmentThreeYears**: `number` | `null`

***

### foreignExchange [#foreignexchange]

> `readonly` **foreignExchange**: `boolean`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number`

***

### minimumBuy [#minimumbuy]

> `readonly` **minimumBuy**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### prospectusLink [#prospectuslink]

> `readonly` **prospectusLink**: `string`

***

### rating [#rating]

> `readonly` **rating**: `number` | `null`

***

### risk [#risk]

> `readonly` **risk**: `number`

***

### totalFee [#totalfee]

> `readonly` **totalFee**: `number`


# Interface: FundSustainability (/avanza-ts/docs/sdk/reference/generated/interfaces/FundSustainability)



## Properties [#properties]

### arcticOilAndGasExplorationInvolvement [#arcticoilandgasexplorationinvolvement]

> `readonly` **arcticOilAndGasExplorationInvolvement**: `number` | `null`

***

### aumCoveredCarbon [#aumcoveredcarbon]

> `readonly` **aumCoveredCarbon**: `number` | `null`

***

### carbonRiskScore [#carbonriskscore]

> `readonly` **carbonRiskScore**: `number` | `null`

***

### carbonSolutionsInvolvement [#carbonsolutionsinvolvement]

> `readonly` **carbonSolutionsInvolvement**: `number` | `null`

***

### controversyScore [#controversyscore]

> `readonly` **controversyScore**: `number` | `null`

***

### environmentalRating [#environmentalrating]

> `readonly` **environmentalRating**: `number` | `null`

***

### environmentalScore [#environmentalscore]

> `readonly` **environmentalScore**: `number` | `null`

***

### esgScore [#esgscore]

> `readonly` **esgScore**: `number` | `null`

***

### euArticleType [#euarticletype]

> `readonly` **euArticleType**: [`FundNamedValue`](./FundNamedValue.md)

***

### fossilFuelInvolvement [#fossilfuelinvolvement]

> `readonly` **fossilFuelInvolvement**: `number` | `null`

***

### governanceRating [#governancerating]

> `readonly` **governanceRating**: `number` | `null`

***

### governanceScore [#governancescore]

> `readonly` **governanceScore**: `number` | `null`

***

### lowCarbon [#lowcarbon]

> `readonly` **lowCarbon**: `boolean`

***

### oilAndGasProductionInvolvement [#oilandgasproductioninvolvement]

> `readonly` **oilAndGasProductionInvolvement**: `number` | `null`

***

### oilSandsExtractionInvolvement [#oilsandsextractioninvolvement]

> `readonly` **oilSandsExtractionInvolvement**: `number` | `null`

***

### productInvolvements [#productinvolvements]

> `readonly` **productInvolvements**: readonly [`FundProductInvolvement`](./FundProductInvolvement.md) & `object`\[]

***

### socialRating [#socialrating]

> `readonly` **socialRating**: `number` | `null`

***

### socialScore [#socialscore]

> `readonly` **socialScore**: `number` | `null`

***

### sustainabilityDevelopmentGoals [#sustainabilitydevelopmentgoals]

> `readonly` **sustainabilityDevelopmentGoals**: readonly [`FundNamedValue`](./FundNamedValue.md) & `object`\[]

***

### sustainabilityRating [#sustainabilityrating]

> `readonly` **sustainabilityRating**: `number` | `null`

***

### sustainabilityRatingCategoryName [#sustainabilityratingcategoryname]

> `readonly` **sustainabilityRatingCategoryName**: `string`

***

### svanen [#svanen]

> `readonly` **svanen**: `boolean`

***

### thermalCoalInvolvement [#thermalcoalinvolvement]

> `readonly` **thermalCoalInvolvement**: `number` | `null`

***

### thermalCoalPowerGenerationInvolvement [#thermalcoalpowergenerationinvolvement]

> `readonly` **thermalCoalPowerGenerationInvolvement**: `number` | `null`


# Interface: FundTopListView (/avanza-ts/docs/sdk/reference/generated/interfaces/FundTopListView)



## Properties [#properties]

### developmentFiveYears [#developmentfiveyears]

> `readonly` **developmentFiveYears**: `number` | `null`

***

### developmentOneYear [#developmentoneyear]

> `readonly` **developmentOneYear**: `number` | `null`

***

### developmentThreeMonths [#developmentthreemonths]

> `readonly` **developmentThreeMonths**: `number` | `null`

***

### developmentThreeYears [#developmentthreeyears]

> `readonly` **developmentThreeYears**: `number` | `null`

***

### esgScore [#esgscore]

> `readonly` **esgScore**: `number` | `null`

***

### fundRatingViews [#fundratingviews]

> `readonly` **fundRatingViews**: readonly [`FundRatingView`](./FundRatingView.md)\[]

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### nrOfBuyOrders [#nrofbuyorders]

> `readonly` **nrOfBuyOrders**: `number`

***

### nrOfOwners [#nrofowners]

> `readonly` **nrOfOwners**: `number`

***

### nrOfSellOrders [#nrofsellorders]

> `readonly` **nrOfSellOrders**: `number`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### rating [#rating]

> `readonly` **rating**: `number` | `null`

***

### risk [#risk]

> `readonly` **risk**: `number`

***

### totalFee [#totalfee]

> `readonly` **totalFee**: `number`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: FundTopTenOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/FundTopTenOptions)



## Properties [#properties]

### fundInstrumentType? [#fundinstrumenttype]

> `readonly` `optional` &#x2A;*fundInstrumentType?**: [`FundInstrumentType`](../type-aliases/FundInstrumentType.md)

***

### sortDirection? [#sortdirection]

> `readonly` `optional` &#x2A;*sortDirection?**: [`FundSortDirection`](../type-aliases/FundSortDirection.md)

***

### sortField? [#sortfield]

> `readonly` `optional` &#x2A;*sortField?**: `string`

A `FundTopListView` field, for example `developmentOneYear`.


# Interface: FundTopTenResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/FundTopTenResponse)



## Properties [#properties]

### fundTopListViews [#fundtoplistviews]

> `readonly` **fundTopListViews**: readonly [`FundTopListView`](./FundTopListView.md)\[]


# Interface: FundsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/FundsClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### chart() [#chart]

> **chart**(`orderbookId`, `period`, `signal?`): `Promise`\<[`FundChartResponse`](./FundChartResponse.md)>

#### Parameters [#parameters]

##### orderbookId [#orderbookid]

`string`

##### period [#period]

`"today"` | `"one_week"` | `"one_month"` | `"three_months"` | `"this_year"` | `"one_year"` | `"three_years"` | `"five_years"` | `"infinity"`

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`FundChartResponse`](./FundChartResponse.md)>

***

### chartPeriods() [#chartperiods]

> **chartPeriods**(`orderbookId`, `signal?`): `Promise`\<readonly [`ChartPeriodChange`](./ChartPeriodChange.md)\[]>

#### Parameters [#parameters-1]

##### orderbookId [#orderbookid-1]

`string`

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<readonly [`ChartPeriodChange`](./ChartPeriodChange.md)\[]>

***

### description() [#description]

> **description**(`orderbookId`, `signal?`): `Promise`\<[`FundDescription`](./FundDescription.md)>

#### Parameters [#parameters-2]

##### orderbookId [#orderbookid-2]

`string`

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`FundDescription`](./FundDescription.md)>

***

### details() [#details]

> **details**(`orderbookId`, `signal?`): `Promise`\<[`FundOrderbookDetails`](./FundOrderbookDetails.md)>

#### Parameters [#parameters-3]

##### orderbookId [#orderbookid-3]

`string`

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<[`FundOrderbookDetails`](./FundOrderbookDetails.md)>

***

### development() [#development]

> **development**(`orderbookId`, `signal?`): `Promise`\<[`FundDevelopment`](./FundDevelopment.md)>

#### Parameters [#parameters-4]

##### orderbookId [#orderbookid-4]

`string`

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`FundDevelopment`](./FundDevelopment.md)>

***

### favourites() [#favourites]

> **favourites**(`signal?`): `Promise`\<readonly `unknown`\[]>

Requires a session. The item shape is unverified; captures so far were empty.

#### Parameters [#parameters-5]

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<readonly `unknown`\[]>

***

### guide() [#guide]

> **guide**(`orderbookId`, `signal?`): `Promise`\<[`FundGuide`](./FundGuide.md)>

#### Parameters [#parameters-6]

##### orderbookId [#orderbookid-5]

`string`

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<[`FundGuide`](./FundGuide.md)>

***

### holdings() [#holdings]

> **holdings**(`orderbookId`, `signal?`): `Promise`\<readonly [`FundPieChartPoint`](./FundPieChartPoint.md)\[]>

#### Parameters [#parameters-7]

##### orderbookId [#orderbookid-6]

`string`

##### signal? [#signal-7]

`AbortSignal`

#### Returns [#returns-7]

`Promise`\<readonly [`FundPieChartPoint`](./FundPieChartPoint.md)\[]>

***

### instrumentSearch() [#instrumentsearch]

> **instrumentSearch**(`query`, `signal?`): `Promise`\<[`FundInstrumentSearchResponse`](./FundInstrumentSearchResponse.md)>

#### Parameters [#parameters-8]

##### query [#query]

`string`

##### signal? [#signal-8]

`AbortSignal`

#### Returns [#returns-8]

`Promise`\<[`FundInstrumentSearchResponse`](./FundInstrumentSearchResponse.md)>

***

### isFavourite() [#isfavourite]

> **isFavourite**(`orderbookId`, `signal?`): `Promise`\<`boolean`>

Requires a session.

#### Parameters [#parameters-9]

##### orderbookId [#orderbookid-7]

`string`

##### signal? [#signal-9]

`AbortSignal`

#### Returns [#returns-9]

`Promise`\<`boolean`>

***

### list() [#list]

> **list**(`options?`, `signal?`): `Promise`\<[`FundListResponse`](./FundListResponse.md)>

#### Parameters [#parameters-10]

##### options? [#options]

[`FundListOptions`](./FundListOptions.md) = `{}`

##### signal? [#signal-10]

`AbortSignal`

#### Returns [#returns-10]

`Promise`\<[`FundListResponse`](./FundListResponse.md)>

***

### orderbook() [#orderbook]

> **orderbook**(`orderbookId`, `signal?`): `Promise`\<[`FundOrderbook`](./FundOrderbook.md)>

#### Parameters [#parameters-11]

##### orderbookId [#orderbookid-8]

`string`

##### signal? [#signal-11]

`AbortSignal`

#### Returns [#returns-11]

`Promise`\<[`FundOrderbook`](./FundOrderbook.md)>

***

### portfolioData() [#portfoliodata]

> **portfolioData**(`orderbookId`, `signal?`): `Promise`\<[`FundPortfolioData`](./FundPortfolioData.md)>

#### Parameters [#parameters-12]

##### orderbookId [#orderbookid-9]

`string`

##### signal? [#signal-12]

`AbortSignal`

#### Returns [#returns-12]

`Promise`\<[`FundPortfolioData`](./FundPortfolioData.md)>

***

### reference() [#reference]

> **reference**(`orderbookId`, `signal?`): `Promise`\<[`FundReference`](./FundReference.md)>

#### Parameters [#parameters-13]

##### orderbookId [#orderbookid-10]

`string`

##### signal? [#signal-13]

`AbortSignal`

#### Returns [#returns-13]

`Promise`\<[`FundReference`](./FundReference.md)>

***

### regions() [#regions]

> **regions**(`orderbookId`, `signal?`): `Promise`\<readonly [`FundPieChartPoint`](./FundPieChartPoint.md)\[]>

#### Parameters [#parameters-14]

##### orderbookId [#orderbookid-11]

`string`

##### signal? [#signal-14]

`AbortSignal`

#### Returns [#returns-14]

`Promise`\<readonly [`FundPieChartPoint`](./FundPieChartPoint.md)\[]>

***

### search() [#search]

> **search**(`name`, `signal?`): `Promise`\<[`FundSearchResponse`](./FundSearchResponse.md)>

#### Parameters [#parameters-15]

##### name [#name]

`string`

##### signal? [#signal-15]

`AbortSignal`

#### Returns [#returns-15]

`Promise`\<[`FundSearchResponse`](./FundSearchResponse.md)>

***

### sectors() [#sectors]

> **sectors**(`orderbookId`, `signal?`): `Promise`\<readonly [`FundPieChartPoint`](./FundPieChartPoint.md)\[]>

#### Parameters [#parameters-16]

##### orderbookId [#orderbookid-12]

`string`

##### signal? [#signal-16]

`AbortSignal`

#### Returns [#returns-16]

`Promise`\<readonly [`FundPieChartPoint`](./FundPieChartPoint.md)\[]>

***

### sustainability() [#sustainability]

> **sustainability**(`orderbookId`, `signal?`): `Promise`\<[`FundSustainability`](./FundSustainability.md)>

#### Parameters [#parameters-17]

##### orderbookId [#orderbookid-13]

`string`

##### signal? [#signal-17]

`AbortSignal`

#### Returns [#returns-17]

`Promise`\<[`FundSustainability`](./FundSustainability.md)>

***

### topTen() [#topten]

> **topTen**(`options?`, `signal?`): `Promise`\<[`FundTopTenResponse`](./FundTopTenResponse.md)>

#### Parameters [#parameters-18]

##### options? [#options-1]

[`FundTopTenOptions`](./FundTopTenOptions.md) = `{}`

##### signal? [#signal-18]

`AbortSignal`

#### Returns [#returns-18]

`Promise`\<[`FundTopTenResponse`](./FundTopTenResponse.md)>


# Interface: GainersLosersResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/GainersLosersResponse)



## Properties [#properties]

### gainers [#gainers]

> `readonly` **gainers**: readonly [`MoverStock`](./MoverStock.md)\[]

***

### losers [#losers]

> `readonly` **losers**: readonly [`MoverStock`](./MoverStock.md)\[]

***

### numberOfGainers [#numberofgainers]

> `readonly` **numberOfGainers**: `number`

***

### numberOfLosers [#numberoflosers]

> `readonly` **numberOfLosers**: `number`

***

### numberOfNeutrals [#numberofneutrals]

> `readonly` **numberOfNeutrals**: `number`


# Interface: HasClosedAccountsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/HasClosedAccountsResponse)



## Properties [#properties]

### hasClosedAccounts [#hasclosedaccounts]

> `readonly` **hasClosedAccounts**: `boolean`


# Interface: HeaderIndex (/avanza-ts/docs/sdk/reference/generated/interfaces/HeaderIndex)



## Properties [#properties]

### link [#link]

> `readonly` **link**: [`InstrumentLink`](./InstrumentLink.md)

***

### priceAtStartOfYear [#priceatstartofyear]

> `readonly` **priceAtStartOfYear**: `string`

***

### quoteChangeToday [#quotechangetoday]

> `readonly` **quoteChangeToday**: `string`

***

### quoteChangeYear [#quotechangeyear]

> `readonly` **quoteChangeYear**: `string`

***

### todayChangeDirection [#todaychangedirection]

> `readonly` **todayChangeDirection**: `number`

***

### todayPriceUpdated [#todaypriceupdated]

> `readonly` **todayPriceUpdated**: `string`

***

### yearChangeDirection [#yearchangedirection]

> `readonly` **yearChangeDirection**: `number`


# Interface: HeaderIndicesResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/HeaderIndicesResponse)



## Properties [#properties]

### indexes [#indexes]

> `readonly` **indexes**: readonly [`HeaderIndex`](./HeaderIndex.md)\[]


# Interface: IndexConstituent (/avanza-ts/docs/sdk/reference/generated/interfaces/IndexConstituent)



## Properties [#properties]

### changePercent [#changepercent]

> `readonly` **changePercent**: `number` | `null`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`


# Interface: InsiderTrade (/avanza-ts/docs/sdk/reference/generated/interfaces/InsiderTrade)



## Properties [#properties]

### aggregatedTransaction [#aggregatedtransaction]

> `readonly` **aggregatedTransaction**: `boolean`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### equityProgram [#equityprogram]

> `readonly` **equityProgram**: `boolean`

***

### insiderName [#insidername]

> `readonly` **insiderName**: `string`

***

### insiderPosition [#insiderposition]

> `readonly` **insiderPosition**: `string`

***

### instrumentDescription [#instrumentdescription]

> `readonly` **instrumentDescription**: `string` | `null`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### marketCountryCode [#marketcountrycode]

> `readonly` **marketCountryCode**: `string`

***

### marketTransaction [#markettransaction]

> `readonly` **marketTransaction**: `boolean`

***

### newHolder [#newholder]

> `readonly` **newHolder**: `string` | `null`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### owner [#owner]

> `readonly` **owner**: `string` | `null`

***

### ownershipChangeFraction [#ownershipchangefraction]

> `readonly` **ownershipChangeFraction**: `number` | `null`

***

### price [#price]

> `readonly` **price**: `number`

***

### quantity [#quantity]

> `readonly` **quantity**: `number`

***

### reportedDate [#reporteddate]

> `readonly` **reportedDate**: `string`

***

### ticker [#ticker]

> `readonly` **ticker**: `string`

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: `number`

***

### transactionDate [#transactiondate]

> `readonly` **transactionDate**: `string`

***

### transactionType [#transactiontype]

> `readonly` **transactionType**: `string`

For example `BUY` or `SELL`.


# Interface: InsiderTradesResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/InsiderTradesResponse)



## Properties [#properties]

### allocationTotalValue [#allocationtotalvalue]

> `readonly` **allocationTotalValue**: `number` | `null`

***

### buyCount [#buycount]

> `readonly` **buyCount**: `number` | `null`

***

### buyTotalValue [#buytotalvalue]

> `readonly` **buyTotalValue**: `number` | `null`

***

### sellCount [#sellcount]

> `readonly` **sellCount**: `number` | `null`

***

### sellTotalValue [#selltotalvalue]

> `readonly` **sellTotalValue**: `number` | `null`

***

### source [#source]

> `readonly` **source**: `string`

***

### transactions [#transactions]

> `readonly` **transactions**: readonly [`InsiderTrade`](./InsiderTrade.md)\[]


# Interface: InsiderTransactionSummary (/avanza-ts/docs/sdk/reference/generated/interfaces/InsiderTransactionSummary)



## Properties [#properties]

### buyCount [#buycount]

> `readonly` **buyCount**: `number`

***

### currencyCode [#currencycode]

> `readonly` **currencyCode**: `string`

***

### netChange [#netchange]

> `readonly` **netChange**: `number`

***

### sellCount [#sellcount]

> `readonly` **sellCount**: `number`

***

### timestamp [#timestamp]

> `readonly` **timestamp**: `number`


# Interface: InsightsInstrumentGroup (/avanza-ts/docs/sdk/reference/generated/interfaces/InsightsInstrumentGroup)



## Properties [#properties]

### instrumentDisplayName [#instrumentdisplayname]

> `readonly` **instrumentDisplayName**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### outcome [#outcome]

> `readonly` **outcome**: [`InsightsOutcome`](./InsightsOutcome.md)

***

### positions [#positions]

> `readonly` **positions**: readonly [`InsightsPosition`](./InsightsPosition.md)\[]


# Interface: InsightsInstrumentLink (/avanza-ts/docs/sdk/reference/generated/interfaces/InsightsInstrumentLink)



## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### linkDisplay [#linkdisplay]

> `readonly` **linkDisplay**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### sellable [#sellable]

> `readonly` **sellable**: `boolean`

***

### shortLinkDisplay [#shortlinkdisplay]

> `readonly` **shortLinkDisplay**: `string`

***

### tradeable [#tradeable]

> `readonly` **tradeable**: `boolean`

***

### type [#type]

> `readonly` **type**: `string`

***

### urlDisplayName [#urldisplayname]

> `readonly` **urlDisplayName**: `string`


# Interface: InsightsOutcome (/avanza-ts/docs/sdk/reference/generated/interfaces/InsightsOutcome)



## Properties [#properties]

### balanceDevelopments? [#balancedevelopments]

> `readonly` `optional` &#x2A;*balanceDevelopments?**: readonly `object`\[]

***

### development [#development]

> `readonly` **development**: `number`

***

### dividends [#dividends]

> `readonly` **dividends**: `number`

***

### total [#total]

> `readonly` **total**: `number`


# Interface: InsightsPosition (/avanza-ts/docs/sdk/reference/generated/interfaces/InsightsPosition)



## Properties [#properties]

### currentPosition [#currentposition]

> `readonly` **currentPosition**: `number`

***

### endValue [#endvalue]

> `readonly` **endValue**: `number`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### link [#link]

> `readonly` **link**: [`InsightsInstrumentLink`](./InsightsInstrumentLink.md)

***

### outcome [#outcome]

> `readonly` **outcome**: [`InsightsOutcome`](./InsightsOutcome.md) & `object`

#### Type Declaration [#type-declaration]

##### developmentPartOfTotalDevelopmentInPercent [#developmentpartoftotaldevelopmentinpercent]

> `readonly` **developmentPartOfTotalDevelopmentInPercent**: `number`

##### dividendsPartOfTotalDevelopmentInPercent [#dividendspartoftotaldevelopmentinpercent]

> `readonly` **dividendsPartOfTotalDevelopmentInPercent**: `number`

##### stake [#stake]

> `readonly` **stake**: `number`

##### totalBuyAmount [#totalbuyamount]

> `readonly` **totalBuyAmount**: `number`

##### totalDevelopmentInPercent [#totaldevelopmentinpercent]

> `readonly` **totalDevelopmentInPercent**: `number`

##### totalOtherAmount [#totalotheramount]

> `readonly` **totalOtherAmount**: `number`

##### totalSellAmount [#totalsellamount]

> `readonly` **totalSellAmount**: `number`

##### totalTurnover [#totalturnover]

> `readonly` **totalTurnover**: `number`

##### transactions [#transactions]

> `readonly` **transactions**: readonly `object`\[]

##### transactionTotals [#transactiontotals]

> `readonly` **transactionTotals**: readonly `object`\[]

***

### shortName [#shortname]

> `readonly` **shortName**: `string`

***

### startValue [#startvalue]

> `readonly` **startValue**: `number`


# Interface: InsightsReport (/avanza-ts/docs/sdk/reference/generated/interfaces/InsightsReport)



What held positions earned over the period, split into price development and dividends.

## Properties [#properties]

### developmentResponse [#developmentresponse]

> `readonly` **developmentResponse**: `object`

#### bestAndWorst [#bestandworst]

> `readonly` **bestAndWorst**: `object`

##### bestAndWorst.bestPositions [#bestandworstbestpositions]

> `readonly` **bestPositions**: readonly [`InsightsInstrumentGroup`](./InsightsInstrumentGroup.md)\[]

##### bestAndWorst.worstPositions [#bestandworstworstpositions]

> `readonly` **worstPositions**: readonly [`InsightsInstrumentGroup`](./InsightsInstrumentGroup.md)\[]

#### chartData [#chartdata]

> `readonly` **chartData**: readonly `object`\[]

#### hasUnlistedInstrument [#hasunlistedinstrument]

> `readonly` **hasUnlistedInstrument**: `boolean`

#### instruments [#instruments]

> `readonly` **instruments**: readonly [`InsightsInstrumentGroup`](./InsightsInstrumentGroup.md)\[]

#### totalOutcome [#totaloutcome]

> `readonly` **totalOutcome**: [`InsightsOutcome`](./InsightsOutcome.md)

#### totalOutcomeForUnknownDevelopments [#totaloutcomeforunknowndevelopments]

> `readonly` **totalOutcomeForUnknownDevelopments**: [`InsightsOutcome`](./InsightsOutcome.md)

#### unknownPositionDevelopments [#unknownpositiondevelopments]

> `readonly` **unknownPositionDevelopments**: readonly `object`\[]

***

### fromDate [#fromdate]

> `readonly` **fromDate**: `string`

***

### otherTransactions [#othertransactions]

> `readonly` **otherTransactions**: `object`

#### otherTransactionsGroups [#othertransactionsgroups]

> `readonly` **otherTransactionsGroups**: readonly `object`\[]

#### total [#total]

> `readonly` **total**: `number`

***

### toDate [#todate]

> `readonly` **toDate**: `string`

***

### totalDevelopment [#totaldevelopment]

> `readonly` **totalDevelopment**: `object`

#### currentValue [#currentvalue]

> `readonly` **currentValue**: `number`

#### startValue [#startvalue]

> `readonly` **startValue**: `number`

#### totalChange [#totalchange]

> `readonly` **totalChange**: `number`

***

### transactionsResponse [#transactionsresponse]

> `readonly` **transactionsResponse**: `object`

#### allTransactions [#alltransactions]

> `readonly` **allTransactions**: readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]

#### chartData [#chartdata-1]

> `readonly` **chartData**: readonly `object`\[]

#### totalAll [#totalall]

> `readonly` **totalAll**: `number`

#### totalAutogiro [#totalautogiro]

> `readonly` **totalAutogiro**: `number`

#### totalDeposits [#totaldeposits]

> `readonly` **totalDeposits**: `number`

#### totalWithdraws [#totalwithdraws]

> `readonly` **totalWithdraws**: `number`


# Interface: InstrumentByIsinResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/InstrumentByIsinResponse)



## Properties [#properties]

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: InstrumentLink (/avanza-ts/docs/sdk/reference/generated/interfaces/InstrumentLink)



## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### linkDisplay [#linkdisplay]

> `readonly` **linkDisplay**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### sellable [#sellable]

> `readonly` **sellable**: `boolean`

***

### shortLinkDisplay [#shortlinkdisplay]

> `readonly` **shortLinkDisplay**: `string`

***

### tradeable [#tradeable]

> `readonly` **tradeable**: `boolean`

***

### tradeStatus [#tradestatus]

> `readonly` **tradeStatus**: `string`

***

### type [#type]

> `readonly` **type**: `string`

***

### urlDisplayName [#urldisplayname]

> `readonly` **urlDisplayName**: `string`


# Interface: InstrumentNewsArticle (/avanza-ts/docs/sdk/reference/generated/interfaces/InstrumentNewsArticle)



## Properties [#properties]

### articleType [#articletype]

> `readonly` **articleType**: `string`

***

### category [#category]

> `readonly` **category**: `string`

***

### externalLink [#externallink]

> `readonly` **externalLink**: `boolean`

***

### fullArticleLink [#fullarticlelink]

> `readonly` **fullArticleLink**: `string`

***

### headline [#headline]

> `readonly` **headline**: `string`

***

### intro [#intro]

> `readonly` **intro**: `string`

***

### newsSource [#newssource]

> `readonly` **newsSource**: `string`

***

### timePublished [#timepublished]

> `readonly` **timePublished**: `string`

***

### timePublishedMillis [#timepublishedmillis]

> `readonly` **timePublishedMillis**: `number`

***

### vignette [#vignette]

> `readonly` **vignette**: `string`


# Interface: InstrumentNewsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/InstrumentNewsResponse)



## Properties [#properties]

### articles [#articles]

> `readonly` **articles**: readonly [`InstrumentNewsArticle`](./InstrumentNewsArticle.md)\[]


# Interface: InstrumentUnderlying (/avanza-ts/docs/sdk/reference/generated/interfaces/InstrumentUnderlying)



## Properties [#properties]

### instrumentSubType [#instrumentsubtype]

> `readonly` **instrumentSubType**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### listing [#listing]

> `readonly` **listing**: [`Listing`](./Listing.md)

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### previousClosingPrice [#previousclosingprice]

> `readonly` **previousClosingPrice**: `number` | `null`

***

### quote [#quote]

> `readonly` **quote**: `Partial`\<[`StockQuote`](./StockQuote.md)>

***

### reference [#reference]

> `readonly` **reference**: `boolean`


# Interface: InstrumentsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/InstrumentsClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### deleteStockScreenerTabs() [#deletestockscreenertabs]

> **deleteStockScreenerTabs**(`signal?`): `Promise`\<`unknown`>

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<`unknown`>

***

### getAllStockSectors() [#getallstocksectors]

> **getAllStockSectors**(`signal?`): `Promise`\<readonly [`StockSectorGroup`](./StockSectorGroup.md)\[]>

#### Parameters [#parameters-1]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<readonly [`StockSectorGroup`](./StockSectorGroup.md)\[]>

***

### getCertificateFilterOptions() [#getcertificatefilteroptions]

> **getCertificateFilterOptions**(`signal?`): `Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

#### Parameters [#parameters-2]

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

***

### getEtfFilterOptions() [#getetffilteroptions]

> **getEtfFilterOptions**(`signal?`): `Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

#### Parameters [#parameters-3]

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

***

### getGainersLosers() [#getgainerslosers]

> **getGainersLosers**(`filter?`, `signal?`): `Promise`\<[`GainersLosersResponse`](./GainersLosersResponse.md)>

#### Parameters [#parameters-4]

##### filter? [#filter]

[`StockFilter`](./StockFilter.md) = `{}`

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`GainersLosersResponse`](./GainersLosersResponse.md)>

***

### getOptionFutureForwardFilterOptions() [#getoptionfutureforwardfilteroptions]

> **getOptionFutureForwardFilterOptions**(`signal?`): `Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

#### Parameters [#parameters-5]

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

***

### getPopularStockSectors() [#getpopularstocksectors]

> **getPopularStockSectors**(`signal?`): `Promise`\<readonly [`PopularStockSector`](./PopularStockSector.md)\[]>

#### Parameters [#parameters-6]

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<readonly [`PopularStockSector`](./PopularStockSector.md)\[]>

***

### getSavedStockFilters() [#getsavedstockfilters]

> **getSavedStockFilters**(`signal?`): `Promise`\<[`SavedStockFiltersResponse`](./SavedStockFiltersResponse.md)>

#### Parameters [#parameters-7]

##### signal? [#signal-7]

`AbortSignal`

#### Returns [#returns-7]

`Promise`\<[`SavedStockFiltersResponse`](./SavedStockFiltersResponse.md)>

***

### getStockFilterOptions() [#getstockfilteroptions]

> **getStockFilterOptions**(`signal?`): `Promise`\<[`StockFilterOptions`](./StockFilterOptions.md)>

#### Parameters [#parameters-8]

##### signal? [#signal-8]

`AbortSignal`

#### Returns [#returns-8]

`Promise`\<[`StockFilterOptions`](./StockFilterOptions.md)>

***

### getStockScreenerMetadata() [#getstockscreenermetadata]

> **getStockScreenerMetadata**(`signal?`): `Promise`\<[`StockScreenerMetadataResponse`](./StockScreenerMetadataResponse.md)>

#### Parameters [#parameters-9]

##### signal? [#signal-9]

`AbortSignal`

#### Returns [#returns-9]

`Promise`\<[`StockScreenerMetadataResponse`](./StockScreenerMetadataResponse.md)>

***

### getStockScreenerTabs() [#getstockscreenertabs]

> **getStockScreenerTabs**(`signal?`): `Promise`\<[`StockScreenerTabsResponse`](./StockScreenerTabsResponse.md)>

#### Parameters [#parameters-10]

##### signal? [#signal-10]

`AbortSignal`

#### Returns [#returns-10]

`Promise`\<[`StockScreenerTabsResponse`](./StockScreenerTabsResponse.md)>

***

### getThemeStocks() [#getthemestocks]

> **getThemeStocks**(`orderbookIds`, `sortBy`, `signal?`): `Promise`\<[`ThemeStocksResponse`](./ThemeStocksResponse.md)>

#### Parameters [#parameters-11]

##### orderbookIds [#orderbookids]

readonly `string`\[]

##### sortBy [#sortby]

[`StockSort`](./StockSort.md)

##### signal? [#signal-11]

`AbortSignal`

#### Returns [#returns-11]

`Promise`\<[`ThemeStocksResponse`](./ThemeStocksResponse.md)>

***

### getWarrantFilterOptions() [#getwarrantfilteroptions]

> **getWarrantFilterOptions**(`signal?`): `Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

#### Parameters [#parameters-12]

##### signal? [#signal-12]

`AbortSignal`

#### Returns [#returns-12]

`Promise`\<`Readonly`\<`Record`\<`string`, readonly [`ListedProductFilterOption`](./ListedProductFilterOption.md)\[]>>>

***

### saveStockFilters() [#savestockfilters]

> **saveStockFilters**(`filters`, `signal?`): `Promise`\<`unknown`>

#### Parameters [#parameters-13]

##### filters [#filters]

readonly [`SavedStockFilter`](./SavedStockFilter.md)\[]

##### signal? [#signal-13]

`AbortSignal`

#### Returns [#returns-13]

`Promise`\<`unknown`>

***

### saveStockScreenerTabs() [#savestockscreenertabs]

> **saveStockScreenerTabs**(`tabs`, `signal?`): `Promise`\<`unknown`>

#### Parameters [#parameters-14]

##### tabs [#tabs]

readonly [`StockScreenerTab`](./StockScreenerTab.md)\[]

##### signal? [#signal-14]

`AbortSignal`

#### Returns [#returns-14]

`Promise`\<`unknown`>

***

### screenCertificates() [#screencertificates]

> **screenCertificates**(`options?`): `Promise`\<[`ScreenCertificatesResponse`](../type-aliases/ScreenCertificatesResponse.md)>

#### Parameters [#parameters-15]

##### options? [#options]

[`ScreenListedProductsOptions`](./ScreenListedProductsOptions.md) = `{}`

#### Returns [#returns-15]

`Promise`\<[`ScreenCertificatesResponse`](../type-aliases/ScreenCertificatesResponse.md)>

***

### screenDerivatives() [#screenderivatives]

> **screenDerivatives**(`options?`): `Promise`\<[`ScreenDerivativesResponse`](../type-aliases/ScreenDerivativesResponse.md)>

Filter keys: `underlyingInstruments`, `optionTypes`, `endDates`, `callIndicators`.

#### Parameters [#parameters-16]

##### options? [#options-1]

[`ScreenListedProductsOptions`](./ScreenListedProductsOptions.md) = `{}`

#### Returns [#returns-16]

`Promise`\<[`ScreenDerivativesResponse`](../type-aliases/ScreenDerivativesResponse.md)>

***

### screenEtfs() [#screenetfs]

> **screenEtfs**(`options?`): `Promise`\<[`ScreenEtfsResponse`](../type-aliases/ScreenEtfsResponse.md)>

#### Parameters [#parameters-17]

##### options? [#options-2]

[`ScreenListedProductsOptions`](./ScreenListedProductsOptions.md) = `{}`

#### Returns [#returns-17]

`Promise`\<[`ScreenEtfsResponse`](../type-aliases/ScreenEtfsResponse.md)>

***

### screenStocks() [#screenstocks]

> **screenStocks**(`options?`): `Promise`\<[`ScreenStocksResponse`](./ScreenStocksResponse.md)>

#### Parameters [#parameters-18]

##### options? [#options-3]

[`ScreenStocksOptions`](./ScreenStocksOptions.md) = `{}`

#### Returns [#returns-18]

`Promise`\<[`ScreenStocksResponse`](./ScreenStocksResponse.md)>

***

### screenWarrants() [#screenwarrants]

> **screenWarrants**(`options?`): `Promise`\<[`ScreenWarrantsResponse`](../type-aliases/ScreenWarrantsResponse.md)>

#### Parameters [#parameters-19]

##### options? [#options-4]

[`ScreenListedProductsOptions`](./ScreenListedProductsOptions.md) = `{}`

#### Returns [#returns-19]

`Promise`\<[`ScreenWarrantsResponse`](../type-aliases/ScreenWarrantsResponse.md)>


# Interface: InsuranceParty (/avanza-ts/docs/sdk/reference/generated/interfaces/InsuranceParty)



## Properties [#properties]

### insuranceCustomerId [#insurancecustomerid]

> `readonly` **insuranceCustomerId**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: LightweightAccount (/avanza-ts/docs/sdk/reference/generated/interfaces/LightweightAccount)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### accountType [#accounttype]

> `readonly` **accountType**: `string`

***

### accountTypeName [#accounttypename]

> `readonly` **accountTypeName**: `string`

***

### isTradable [#istradable]

> `readonly` **isTradable**: `boolean`

***

### name [#name]

> `readonly` **name**: `string`

***

### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`


# Interface: ListedInstrument (/avanza-ts/docs/sdk/reference/generated/interfaces/ListedInstrument)



## Properties [#properties]

### assetCategory? [#assetcategory]

> `readonly` `optional` &#x2A;*assetCategory?**: `string`

***

### category? [#category]

> `readonly` `optional` &#x2A;*category?**: `string`

***

### historicalClosingPrices [#historicalclosingprices]

> `readonly` **historicalClosingPrices**: [`HistoricalClosingPrices`](../type-aliases/HistoricalClosingPrices.md)

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### keyIndicators [#keyindicators]

> `readonly` **keyIndicators**: `object` & `Readonly`\<`Record`\<`string`, `string` | `number` | `boolean`>>

Product-specific, for example `leverage` and `productLink` (certificates),
`barrierLevel` and `financingLevel` (warrants), or `strikePrice`,
`callIndicator`, and `endDate` (options).

#### Type Declaration [#type-declaration]

##### numberOfOwners [#numberofowners]

> `readonly` **numberOfOwners**: `number`

***

### listing [#listing]

> `readonly` **listing**: [`Listing`](./Listing.md)

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### quote [#quote]

> `readonly` **quote**: `Partial`\<[`StockQuote`](./StockQuote.md)>

***

### subCategory? [#subcategory]

> `readonly` `optional` &#x2A;*subCategory?**: `string`

***

### tradable [#tradable]

> `readonly` **tradable**: `string`

***

### type [#type]

> `readonly` **type**: `string`

***

### underlying? [#underlying]

> `readonly` `optional` &#x2A;*underlying?**: [`InstrumentUnderlying`](./InstrumentUnderlying.md)


# Interface: ListedInstrumentDetails (/avanza-ts/docs/sdk/reference/generated/interfaces/ListedInstrumentDetails)



## Properties [#properties]

### brokerTradeSummaries [#brokertradesummaries]

> `readonly` **brokerTradeSummaries**: readonly [`BrokerTradeSummary`](./BrokerTradeSummary.md)\[]

***

### collateralValue [#collateralvalue]

> `readonly` **collateralValue**: `number`

***

### direction? [#direction]

> `readonly` `optional` &#x2A;*direction?**: `string`

***

### documents [#documents]

> `readonly` **documents**: `object`

#### kid? [#kid]

> `readonly` `optional` &#x2A;*kid?**: `string`

#### prospectus? [#prospectus]

> `readonly` `optional` &#x2A;*prospectus?**: `string`

***

### exerciseType? [#exercisetype]

> `readonly` `optional` &#x2A;*exerciseType?**: `string`

***

### issuer? [#issuer]

> `readonly` `optional` &#x2A;*issuer?**: `string`

***

### leverage? [#leverage]

> `readonly` `optional` &#x2A;*leverage?**: `number`

***

### orderDepth [#orderdepth]

> `readonly` **orderDepth**: [`OrderDepth`](./OrderDepth.md) & `object`

#### Type Declaration [#type-declaration]

##### marketMakerLevelInAsk? [#marketmakerlevelinask]

> `readonly` `optional` &#x2A;*marketMakerLevelInAsk?**: `number`

##### marketMakerLevelInBid? [#marketmakerlevelinbid]

> `readonly` `optional` &#x2A;*marketMakerLevelInBid?**: `number`

***

### superInterestApproved? [#superinterestapproved]

> `readonly` `optional` &#x2A;*superInterestApproved?**: `boolean`

***

### trades [#trades]

> `readonly` **trades**: readonly [`MarketTrade`](./MarketTrade.md)\[]

***

### tradingUnit? [#tradingunit]

> `readonly` `optional` &#x2A;*tradingUnit?**: `number`

***

### underlying? [#underlying]

> `readonly` `optional` &#x2A;*underlying?**: [`InstrumentUnderlying`](./InstrumentUnderlying.md)


# Interface: ListedProductFilterOption (/avanza-ts/docs/sdk/reference/generated/interfaces/ListedProductFilterOption)



## Properties [#properties]

### children? [#children]

> `readonly` `optional` &#x2A;*children?**: readonly `ListedProductFilterOption`\[]

***

### displayName [#displayname]

> `readonly` **displayName**: `string`

***

### numberOfOrderbooks [#numberoforderbooks]

> `readonly` **numberOfOrderbooks**: `number`

***

### value [#value]

> `readonly` **value**: `string`


# Interface: Listing (/avanza-ts/docs/sdk/reference/generated/interfaces/Listing)



## Properties [#properties]

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### marketPlaceCode [#marketplacecode]

> `readonly` **marketPlaceCode**: `string`

***

### marketPlaceName [#marketplacename]

> `readonly` **marketPlaceName**: `string`

***

### marketTradesAvailable [#markettradesavailable]

> `readonly` **marketTradesAvailable**: `boolean`

***

### shortName [#shortname]

> `readonly` **shortName**: `string`

***

### tickerSymbol [#tickersymbol]

> `readonly` **tickerSymbol**: `string`

***

### tickSizeListId [#ticksizelistid]

> `readonly` **tickSizeListId**: `string`


# Interface: MarketClient (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### brokerTradeSummaries() [#brokertradesummaries]

> **brokerTradeSummaries**(`orderbookId`, `signal?`): `Promise`\<readonly [`BrokerTradeSummary`](./BrokerTradeSummary.md)\[]>

#### Parameters [#parameters]

##### orderbookId [#orderbookid]

`string`

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<readonly [`BrokerTradeSummary`](./BrokerTradeSummary.md)\[]>

***

### companyEvents() [#companyevents]

> **companyEvents**(`orderbookId`, `period`, `signal?`): `Promise`\<readonly [`CompanyEvent`](./CompanyEvent.md)\[]>

#### Parameters [#parameters-1]

##### orderbookId [#orderbookid-1]

`string`

##### period [#period]

[`PriceChartPeriod`](../type-aliases/PriceChartPeriod.md)

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<readonly [`CompanyEvent`](./CompanyEvent.md)\[]>

***

### etf() [#etf]

> **etf**(`orderbookId`, `signal?`): `Promise`\<[`EtfResponse`](./EtfResponse.md)>

#### Parameters [#parameters-2]

##### orderbookId [#orderbookid-2]

`string`

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`EtfResponse`](./EtfResponse.md)>

***

### etfDetails() [#etfdetails]

> **etfDetails**(`orderbookId`, `signal?`): `Promise`\<[`EtfDetailsResponse`](./EtfDetailsResponse.md)>

#### Parameters [#parameters-3]

##### orderbookId [#orderbookid-3]

`string`

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<[`EtfDetailsResponse`](./EtfDetailsResponse.md)>

***

### headerIndices() [#headerindices]

> **headerIndices**(`signal?`): `Promise`\<[`HeaderIndicesResponse`](./HeaderIndicesResponse.md)>

#### Parameters [#parameters-4]

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`HeaderIndicesResponse`](./HeaderIndicesResponse.md)>

***

### indexConstituents() [#indexconstituents]

> **indexConstituents**(`orderbookId`, `signal?`): `Promise`\<readonly [`IndexConstituent`](./IndexConstituent.md)\[]>

#### Parameters [#parameters-5]

##### orderbookId [#orderbookid-4]

`string`

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<readonly [`IndexConstituent`](./IndexConstituent.md)\[]>

***

### insiderTrades() [#insidertrades]

> **insiderTrades**(`orderbookId`, `signal?`): `Promise`\<[`InsiderTradesResponse`](./InsiderTradesResponse.md)>

Individual insider transactions with the reporting insider.

#### Parameters [#parameters-6]

##### orderbookId [#orderbookid-5]

`string`

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<[`InsiderTradesResponse`](./InsiderTradesResponse.md)>

***

### insiderTransactions() [#insidertransactions]

> **insiderTransactions**(`orderbookId`, `period`, `signal?`): `Promise`\<readonly [`InsiderTransactionSummary`](./InsiderTransactionSummary.md)\[]>

#### Parameters [#parameters-7]

##### orderbookId [#orderbookid-6]

`string`

##### period [#period-1]

[`PriceChartPeriod`](../type-aliases/PriceChartPeriod.md)

##### signal? [#signal-7]

`AbortSignal`

#### Returns [#returns-7]

`Promise`\<readonly [`InsiderTransactionSummary`](./InsiderTransactionSummary.md)\[]>

***

### instrument() [#instrument]

> **instrument**(`type`, `orderbookId`, `signal?`): `Promise`\<[`ListedInstrument`](./ListedInstrument.md)>

#### Parameters [#parameters-8]

##### type [#type]

`"certificate"` | `"warrant"` | `"futureforward"` | `"option"`

##### orderbookId [#orderbookid-7]

`string`

##### signal? [#signal-8]

`AbortSignal`

#### Returns [#returns-8]

`Promise`\<[`ListedInstrument`](./ListedInstrument.md)>

***

### instrumentByIsin() [#instrumentbyisin]

> **instrumentByIsin**(`isin`, `signal?`): `Promise`\<[`InstrumentByIsinResponse`](./InstrumentByIsinResponse.md)>

#### Parameters [#parameters-9]

##### isin [#isin]

`string`

##### signal? [#signal-9]

`AbortSignal`

#### Returns [#returns-9]

`Promise`\<[`InstrumentByIsinResponse`](./InstrumentByIsinResponse.md)>

***

### instrumentDetails() [#instrumentdetails]

> **instrumentDetails**(`type`, `orderbookId`, `signal?`): `Promise`\<[`ListedInstrumentDetails`](./ListedInstrumentDetails.md)>

Issuer, documents, order depth, and trades for a listed product.

#### Parameters [#parameters-10]

##### type [#type-1]

`"certificate"` | `"warrant"` | `"futureforward"` | `"option"`

##### orderbookId [#orderbookid-8]

`string`

##### signal? [#signal-10]

`AbortSignal`

#### Returns [#returns-10]

`Promise`\<[`ListedInstrumentDetails`](./ListedInstrumentDetails.md)>

***

### marketData() [#marketdata]

> **marketData**(`orderbookId`, `signal?`): `Promise`\<[`MarketDataResponse`](./MarketDataResponse.md)>

Requires a session.

#### Parameters [#parameters-11]

##### orderbookId [#orderbookid-9]

`string`

##### signal? [#signal-11]

`AbortSignal`

#### Returns [#returns-11]

`Promise`\<[`MarketDataResponse`](./MarketDataResponse.md)>

***

### marketMakerChart() [#marketmakerchart]

> **marketMakerChart**(`orderbookId`, `period`, `options?`, `signal?`): `Promise`\<[`MarketMakerChartResponse`](./MarketMakerChartResponse.md)>

Price chart with market maker bid and ask, for certificates and warrants.

#### Parameters [#parameters-12]

##### orderbookId [#orderbookid-10]

`string`

##### period [#period-2]

[`PriceChartPeriod`](../type-aliases/PriceChartPeriod.md)

##### options? [#options]

[`PriceChartOptions`](./PriceChartOptions.md) = `{}`

##### signal? [#signal-12]

`AbortSignal`

#### Returns [#returns-12]

`Promise`\<[`MarketMakerChartResponse`](./MarketMakerChartResponse.md)>

***

### marketplace() [#marketplace]

> **marketplace**(`orderbookId`, `signal?`): `Promise`\<[`MarketplaceStatus`](./MarketplaceStatus.md)>

#### Parameters [#parameters-13]

##### orderbookId [#orderbookid-11]

`string`

##### signal? [#signal-13]

`AbortSignal`

#### Returns [#returns-13]

`Promise`\<[`MarketplaceStatus`](./MarketplaceStatus.md)>

***

### news() [#news]

> **news**(`orderbookId`, `signal?`): `Promise`\<[`InstrumentNewsResponse`](./InstrumentNewsResponse.md)>

#### Parameters [#parameters-14]

##### orderbookId [#orderbookid-12]

`string`

##### signal? [#signal-14]

`AbortSignal`

#### Returns [#returns-14]

`Promise`\<[`InstrumentNewsResponse`](./InstrumentNewsResponse.md)>

***

### numberOfOwners() [#numberofowners]

> **numberOfOwners**(`orderbookId`, `signal?`): `Promise`\<[`NumberOfOwnersResponse`](./NumberOfOwnersResponse.md)>

History of how many Avanza customers own the instrument.

#### Parameters [#parameters-15]

##### orderbookId [#orderbookid-13]

`string`

##### signal? [#signal-15]

`AbortSignal`

#### Returns [#returns-15]

`Promise`\<[`NumberOfOwnersResponse`](./NumberOfOwnersResponse.md)>

***

### orderDepth() [#orderdepth]

> **orderDepth**(`orderbookId`, `signal?`): `Promise`\<[`OrderDepth`](./OrderDepth.md)>

#### Parameters [#parameters-16]

##### orderbookId [#orderbookid-14]

`string`

##### signal? [#signal-16]

`AbortSignal`

#### Returns [#returns-16]

`Promise`\<[`OrderDepth`](./OrderDepth.md)>

***

### overviewChart() [#overviewchart]

> **overviewChart**(`orderbookId`, `period`, `signal?`): `Promise`\<[`OverviewChartResponse`](./OverviewChartResponse.md)>

#### Parameters [#parameters-17]

##### orderbookId [#orderbookid-15]

`string`

##### period [#period-3]

`"today"` | `"one_week"` | `"one_month"` | `"three_months"` | `"this_year"` | `"one_year"` | `"three_years"` | `"five_years"` | `"infinity"`

##### signal? [#signal-17]

`AbortSignal`

#### Returns [#returns-17]

`Promise`\<[`OverviewChartResponse`](./OverviewChartResponse.md)>

***

### overviewChartPeriods() [#overviewchartperiods]

> **overviewChartPeriods**(`orderbookId`, `signal?`): `Promise`\<readonly [`ChartPeriodChange`](./ChartPeriodChange.md)\[]>

#### Parameters [#parameters-18]

##### orderbookId [#orderbookid-16]

`string`

##### signal? [#signal-18]

`AbortSignal`

#### Returns [#returns-18]

`Promise`\<readonly [`ChartPeriodChange`](./ChartPeriodChange.md)\[]>

***

### overviews() [#overviews]

> **overviews**(`signal?`): `Promise`\<readonly [`MarketOverview`](./MarketOverview.md)\[]>

#### Parameters [#parameters-19]

##### signal? [#signal-19]

`AbortSignal`

#### Returns [#returns-19]

`Promise`\<readonly [`MarketOverview`](./MarketOverview.md)\[]>

***

### priceChart() [#pricechart]

> **priceChart**(`orderbookId`, `period`, `options?`, `signal?`): `Promise`\<[`PriceChartResponse`](./PriceChartResponse.md)>

#### Parameters [#parameters-20]

##### orderbookId [#orderbookid-17]

`string`

##### period [#period-4]

[`PriceChartPeriod`](../type-aliases/PriceChartPeriod.md)

##### options? [#options-1]

[`PriceChartOptions`](./PriceChartOptions.md) = `{}`

##### signal? [#signal-20]

`AbortSignal`

#### Returns [#returns-20]

`Promise`\<[`PriceChartResponse`](./PriceChartResponse.md)>

***

### quote() [#quote]

> **quote**(`orderbookId`, `signal?`): `Promise`\<[`StockQuote`](./StockQuote.md)>

#### Parameters [#parameters-21]

##### orderbookId [#orderbookid-18]

`string`

##### signal? [#signal-21]

`AbortSignal`

#### Returns [#returns-21]

`Promise`\<[`StockQuote`](./StockQuote.md)>

***

### search() [#search]

> **search**(`query`, `options?`, `signal?`): `Promise`\<[`SearchResponse`](./SearchResponse.md)>

#### Parameters [#parameters-22]

##### query [#query]

`string`

##### options? [#options-2]

[`SearchOptions`](./SearchOptions.md) = `{}`

##### signal? [#signal-22]

`AbortSignal`

#### Returns [#returns-22]

`Promise`\<[`SearchResponse`](./SearchResponse.md)>

***

### shortSelling() [#shortselling]

> **shortSelling**(`orderbookId`, `signal?`): `Promise`\<[`ShortSellingResponse`](./ShortSellingResponse.md)>

#### Parameters [#parameters-23]

##### orderbookId [#orderbookid-19]

`string`

##### signal? [#signal-23]

`AbortSignal`

#### Returns [#returns-23]

`Promise`\<[`ShortSellingResponse`](./ShortSellingResponse.md)>

***

### stock() [#stock]

> **stock**(`orderbookId`, `signal?`): `Promise`\<[`StockInfo`](./StockInfo.md)>

#### Parameters [#parameters-24]

##### orderbookId [#orderbookid-20]

`string`

##### signal? [#signal-24]

`AbortSignal`

#### Returns [#returns-24]

`Promise`\<[`StockInfo`](./StockInfo.md)>

***

### stockAnalysis() [#stockanalysis]

> **stockAnalysis**(`orderbookId`, `signal?`): `Promise`\<[`StockAnalysis`](./StockAnalysis.md)>

Key ratios, financials, and dividends by year and quarter.

#### Parameters [#parameters-25]

##### orderbookId [#orderbookid-21]

`string`

##### signal? [#signal-25]

`AbortSignal`

#### Returns [#returns-25]

`Promise`\<[`StockAnalysis`](./StockAnalysis.md)>

***

### technicalAnalysisPoints() [#technicalanalysispoints]

> **technicalAnalysisPoints**(`orderbookId`, `period`, `points`, `options?`, `signal?`): `Promise`\<readonly [`Ohlc`](./Ohlc.md)\[]>

Returns `points` OHLC points before the period start, used as technical-analysis lookback.

#### Parameters [#parameters-26]

##### orderbookId [#orderbookid-22]

`string`

##### period [#period-5]

[`PriceChartPeriod`](../type-aliases/PriceChartPeriod.md)

##### points [#points]

`number`

##### options? [#options-3]

[`PriceChartOptions`](./PriceChartOptions.md) = `{}`

##### signal? [#signal-26]

`AbortSignal`

#### Returns [#returns-26]

`Promise`\<readonly [`Ohlc`](./Ohlc.md)\[]>

***

### trades() [#trades]

> **trades**(`orderbookId`, `signal?`): `Promise`\<readonly [`MarketTrade`](./MarketTrade.md)\[]>

#### Parameters [#parameters-27]

##### orderbookId [#orderbookid-23]

`string`

##### signal? [#signal-27]

`AbortSignal`

#### Returns [#returns-27]

`Promise`\<readonly [`MarketTrade`](./MarketTrade.md)\[]>


# Interface: MarketDataResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketDataResponse)



## Properties [#properties]

### orderDepth [#orderdepth]

> `readonly` **orderDepth**: [`OrderDepth`](./OrderDepth.md) & `object`

#### Type Declaration [#type-declaration]

##### marketMakerExpected [#marketmakerexpected]

> `readonly` **marketMakerExpected**: `boolean`

***

### quote [#quote]

> `readonly` **quote**: `Omit`\<[`StockQuote`](./StockQuote.md), `"isRealTime"` | `"spread"` | `"timeOfLast"` | `"updated"`> & `object`

#### Type Declaration [#type-declaration-1]

##### timeOfLast [#timeoflast]

> `readonly` **timeOfLast**: `string` | `null`

##### updated [#updated]

> `readonly` **updated**: `string`

***

### trades [#trades]

> `readonly` **trades**: readonly [`MarketTrade`](./MarketTrade.md)\[]


# Interface: MarketMakerChartResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketMakerChartResponse)



## Properties [#properties]

### from [#from]

> `readonly` **from**: `string`

***

### marketMaker [#marketmaker]

> `readonly` **marketMaker**: readonly `object`\[]

***

### metadata [#metadata]

> `readonly` **metadata**: `object`

#### resolution [#resolution]

> `readonly` **resolution**: `object`

##### resolution.availableResolutions [#resolutionavailableresolutions]

> `readonly` **availableResolutions**: readonly (`"minute"` | `"two_minutes"` | `"five_minutes"` | `"ten_minutes"` | `"thirty_minutes"` | `"hour"` | `"day"` | `"week"` | `"month"` | `"quarter"`)\[]

##### resolution.chartResolution [#resolutionchartresolution]

> `readonly` **chartResolution**: `"minute"` | `"two_minutes"` | `"five_minutes"` | `"ten_minutes"` | `"thirty_minutes"` | `"hour"` | `"day"` | `"week"` | `"month"` | `"quarter"`

***

### ohlc [#ohlc]

> `readonly` **ohlc**: readonly [`Ohlc`](./Ohlc.md)\[]

***

### to [#to]

> `readonly` **to**: `string`


# Interface: MarketOverview (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketOverview)



## Properties [#properties]

### active [#active]

> `readonly` **active**: `boolean`

***

### generation [#generation]

> `readonly` **generation**: `number`

***

### hasMap [#hasmap]

> `readonly` **hasMap**: `boolean`

***

### id [#id]

> `readonly` **id**: `string` | `null`

***

### layoutMode [#layoutmode]

> `readonly` **layoutMode**: `string`

***

### title [#title]

> `readonly` **title**: `string`

***

### widgets [#widgets]

> `readonly` **widgets**: readonly [`MarketOverviewWidget`](./MarketOverviewWidget.md)\[]


# Interface: MarketOverviewWidget (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketOverviewWidget)



## Properties [#properties]

### configuration [#configuration]

> `readonly` **configuration**: `unknown`

***

### data [#data]

> `readonly` **data**: `unknown`

***

### name [#name]

> `readonly` **name**: `string`

***

### position [#position]

> `readonly` **position**: `object`

#### x [#x]

> `readonly` **x**: `number`

#### y [#y]

> `readonly` **y**: `number`

***

### settings [#settings]

> `readonly` **settings**: `unknown`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: MarketTrade (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketTrade)



## Properties [#properties]

### buyer [#buyer]

> `readonly` **buyer**: `string`

***

### buyerName? [#buyername]

> `readonly` `optional` &#x2A;*buyerName?**: `string`

***

### cancelled [#cancelled]

> `readonly` **cancelled**: `boolean`

***

### dealTime [#dealtime]

> `readonly` **dealTime**: `number`

***

### matchedOnMarket [#matchedonmarket]

> `readonly` **matchedOnMarket**: `boolean`

***

### price [#price]

> `readonly` **price**: `number`

***

### seller [#seller]

> `readonly` **seller**: `string`

***

### sellerName? [#sellername]

> `readonly` `optional` &#x2A;*sellerName?**: `string`

***

### volume [#volume]

> `readonly` **volume**: `number`


# Interface: MarketplaceStatus (/avanza-ts/docs/sdk/reference/generated/interfaces/MarketplaceStatus)



## Properties [#properties]

### currentStatus [#currentstatus]

> `readonly` **currentStatus**: `string`

For example `OPEN` or `CLOSED`.

***

### marketOpen [#marketopen]

> `readonly` **marketOpen**: `boolean`

***

### marketStateSchedule [#marketstateschedule]

> `readonly` **marketStateSchedule**: readonly `object`\[]

***

### normalClosingTime [#normalclosingtime]

> `readonly` **normalClosingTime**: `string`

***

### openingTime [#openingtime]

> `readonly` **openingTime**: `string`

***

### timeLeftMs [#timeleftms]

> `readonly` **timeLeftMs**: `number`

***

### todayClosingTime [#todayclosingtime]

> `readonly` **todayClosingTime**: `string`


# Interface: MatrixFutureForward (/avanza-ts/docs/sdk/reference/generated/interfaces/MatrixFutureForward)



## Properties [#properties]

### buyPrice? [#buyprice]

> `readonly` `optional` &#x2A;*buyPrice?**: `number`

***

### change? [#change]

> `readonly` `optional` &#x2A;*change?**: `number`

***

### changePercent? [#changepercent]

> `readonly` `optional` &#x2A;*changePercent?**: `number`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### endDate [#enddate]

> `readonly` **endDate**: `string`

***

### hasPosition [#hasposition]

> `readonly` **hasPosition**: `boolean`

***

### highestPrice? [#highestprice]

> `readonly` `optional` &#x2A;*highestPrice?**: `number`

***

### lastPrice? [#lastprice]

> `readonly` `optional` &#x2A;*lastPrice?**: `number`

***

### lowestPrice? [#lowestprice]

> `readonly` `optional` &#x2A;*lowestPrice?**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### sellPrice? [#sellprice]

> `readonly` `optional` &#x2A;*sellPrice?**: `number`

***

### totalVolumeTraded? [#totalvolumetraded]

> `readonly` `optional` &#x2A;*totalVolumeTraded?**: `number`


# Interface: MatrixOption (/avanza-ts/docs/sdk/reference/generated/interfaces/MatrixOption)



## Properties [#properties]

### callIndicator [#callindicator]

> `readonly` **callIndicator**: `string`

`CALL` or `PUT`.

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### hasPosition [#hasposition]

> `readonly` **hasPosition**: `boolean`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### strikePrice [#strikeprice]

> `readonly` **strikePrice**: `number`


# Interface: MoneyAmount (/avanza-ts/docs/sdk/reference/generated/interfaces/MoneyAmount)



## Properties [#properties]

### currency [#currency]

> `readonly` **currency**: `string`

***

### value [#value]

> `readonly` **value**: `number`


# Interface: MoverStock (/avanza-ts/docs/sdk/reference/generated/interfaces/MoverStock)



## Indexable [#indexable]

> \[`key`: `string`]: `unknown`

## Properties [#properties]

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### hasPosition? [#hasposition]

> `readonly` `optional` &#x2A;*hasPosition?**: `boolean`

***

### lastPrice? [#lastprice]

> `readonly` `optional` &#x2A;*lastPrice?**: `number`

***

### lastPriceUpdated? [#lastpriceupdated]

> `readonly` `optional` &#x2A;*lastPriceUpdated?**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### oneDayChangePercent? [#onedaychangepercent]

> `readonly` `optional` &#x2A;*oneDayChangePercent?**: `number`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### totalValueTraded? [#totalvaluetraded]

> `readonly` `optional` &#x2A;*totalValueTraded?**: `number`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: NewsArticle (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsArticle)



## Properties [#properties]

### body [#body]

> `readonly` **body**: `string`

HTML.

***

### orderbooks [#orderbooks]

> `readonly` **orderbooks**: readonly [`NewsArticleOrderbook`](./NewsArticleOrderbook.md)\[]

***

### publishDate [#publishdate]

> `readonly` **publishDate**: `string`

***

### source [#source]

> `readonly` **source**: `string`

***

### title [#title]

> `readonly` **title**: `string`

***

### type [#type]

> `readonly` **type**: `string`

For example `Nyhet` or `Telegram`.

***

### url [#url]

> `readonly` **url**: `string`

***

### vignette [#vignette]

> `readonly` **vignette**: `string`


# Interface: NewsArticleOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsArticleOrderbook)



## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### change [#change]

> `readonly` **change**: `number`

***

### changePercent [#changepercent]

> `readonly` **changePercent**: `number`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### highestPrice [#highestprice]

> `readonly` **highestPrice**: `number`

***

### id [#id]

> `readonly` **id**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### lastPrice [#lastprice]

> `readonly` **lastPrice**: `number`

***

### lowestPrice [#lowestprice]

> `readonly` **lowestPrice**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### sellable [#sellable]

> `readonly` **sellable**: `boolean`

***

### totalVolumeTraded [#totalvolumetraded]

> `readonly` **totalVolumeTraded**: `number`

***

### tradable [#tradable]

> `readonly` **tradable**: `boolean`

***

### updated [#updated]

> `readonly` **updated**: `string`


# Interface: NewsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### article() [#article]

> **article**(`url`, `signal?`): `Promise`\<[`NewsArticle`](./NewsArticle.md)>

`url` is an article URL or path from the news feed, for example `/telegram/avanza/<id>`.

#### Parameters [#parameters]

##### url [#url]

`string`

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`NewsArticle`](./NewsArticle.md)>

***

### calendar() [#calendar]

> **calendar**(`signal?`): `Promise`\<[`CalendarResponse`](../type-aliases/CalendarResponse.md)>

Requires a session. Upcoming dividends, reports, and other events by month.

#### Parameters [#parameters-1]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`CalendarResponse`](../type-aliases/CalendarResponse.md)>

***

### feed() [#feed]

> **feed**(`options?`, `signal?`): `Promise`\<[`NewsFeedResponse`](./NewsFeedResponse.md)>

Requires a session. News for held and watched instruments.

#### Parameters [#parameters-2]

##### options? [#options]

[`NewsFeedOptions`](./NewsFeedOptions.md) = `{}`

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`NewsFeedResponse`](./NewsFeedResponse.md)>

***

### offers() [#offers]

> **offers**(`signal?`): `Promise`\<readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]>

Requires a session. Item fields are unverified; captured lists were empty so far.

#### Parameters [#parameters-3]

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]>


# Interface: NewsFeedItem (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsFeedItem)



## Properties [#properties]

### category [#category]

> `readonly` **category**: `string` | `null`

***

### externalLink [#externallink]

> `readonly` **externalLink**: `boolean`

***

### id [#id]

> `readonly` **id**: `string`

***

### mainCategory [#maincategory]

> `readonly` **mainCategory**: `string`

***

### orderbooks [#orderbooks]

> `readonly` **orderbooks**: readonly [`NewsFeedOrderbook`](./NewsFeedOrderbook.md)\[]

***

### publishDateTime [#publishdatetime]

> `readonly` **publishDateTime**: `string`

***

### source [#source]

> `readonly` **source**: `string`

***

### subject [#subject]

> `readonly` **subject**: `string`

***

### tag [#tag]

> `readonly` **tag**: `string`

***

### text [#text]

> `readonly` **text**: `string`

***

### title [#title]

> `readonly` **title**: `string`

***

### url [#url]

> `readonly` **url**: `string`

Pass to `NewsClient.article()` for the full article.

***

### vignette [#vignette]

> `readonly` **vignette**: `string`


# Interface: NewsFeedOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsFeedOptions)



## Properties [#properties]

### count? [#count]

> `readonly` `optional` &#x2A;*count?**: `number`

***

### maxDays? [#maxdays]

> `readonly` `optional` &#x2A;*maxDays?**: `number`


# Interface: NewsFeedOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsFeedOrderbook)



## Properties [#properties]

### dailyPerformance [#dailyperformance]

> `readonly` **dailyPerformance**: `number`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### id [#id]

> `readonly` **id**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### name [#name]

> `readonly` **name**: `string`


# Interface: NewsFeedResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/NewsFeedResponse)



## Properties [#properties]

### currentDateTime [#currentdatetime]

> `readonly` **currentDateTime**: `string`

***

### news [#news]

> `readonly` **news**: readonly [`NewsFeedItem`](./NewsFeedItem.md)\[]


# Interface: Note (/avanza-ts/docs/sdk/reference/generated/interfaces/Note)



## Properties [#properties]

### color [#color]

> `readonly` **color**: `string`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### createdDate [#createddate]

> `readonly` **createdDate**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### instrumentName [#instrumentname]

> `readonly` **instrumentName**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### lastPrice [#lastprice]

> `readonly` **lastPrice**: `number`

***

### noteId [#noteid]

> `readonly` **noteId**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### originalPrice [#originalprice]

> `readonly` **originalPrice**: `number`

***

### priceDevelopmentPercentage [#pricedevelopmentpercentage]

> `readonly` **priceDevelopmentPercentage**: `number`

***

### reminderDate? [#reminderdate]

> `readonly` `optional` &#x2A;*reminderDate?**: `string` | `null`

***

### text [#text]

> `readonly` **text**: `string`


# Interface: NoteOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/NoteOrderbook)



## Properties [#properties]

### instrumentName [#instrumentname]

> `readonly` **instrumentName**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`


# Interface: NumberOfOwnersResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/NumberOfOwnersResponse)



## Properties [#properties]

### historySummary [#historysummary]

> `readonly` **historySummary**: `object`

#### oneYearChange [#oneyearchange]

> `readonly` **oneYearChange**: `number`

#### oneYearChangePercent [#oneyearchangepercent]

> `readonly` **oneYearChangePercent**: `number`

#### thisYearChange [#thisyearchange]

> `readonly` **thisYearChange**: `number`

#### thisYearChangePercent [#thisyearchangepercent]

> `readonly` **thisYearChangePercent**: `number`

***

### ownersPoints [#ownerspoints]

> `readonly` **ownersPoints**: readonly `object`\[]


# Interface: Ohlc (/avanza-ts/docs/sdk/reference/generated/interfaces/Ohlc)



## Properties [#properties]

### close [#close]

> `readonly` **close**: `number`

***

### high [#high]

> `readonly` **high**: `number`

***

### low [#low]

> `readonly` **low**: `number`

***

### open [#open]

> `readonly` **open**: `number`

***

### timestamp [#timestamp]

> `readonly` **timestamp**: `number`

***

### totalVolumeTraded [#totalvolumetraded]

> `readonly` **totalVolumeTraded**: `number`


# Interface: OrderCount (/avanza-ts/docs/sdk/reference/generated/interfaces/OrderCount)



## Properties [#properties]

### count [#count]

> `readonly` **count**: `number`


# Interface: OrderDepth (/avanza-ts/docs/sdk/reference/generated/interfaces/OrderDepth)



## Properties [#properties]

### levels [#levels]

> `readonly` **levels**: readonly [`OrderDepthLevel`](./OrderDepthLevel.md)\[]

***

### receivedTime [#receivedtime]

> `readonly` **receivedTime**: `number`


# Interface: OrderDepthLevel (/avanza-ts/docs/sdk/reference/generated/interfaces/OrderDepthLevel)



## Properties [#properties]

### buySide [#buyside]

> `readonly` **buySide**: [`OrderDepthSide`](./OrderDepthSide.md) | `null`

***

### sellSide [#sellside]

> `readonly` **sellSide**: [`OrderDepthSide`](./OrderDepthSide.md) | `null`


# Interface: OrderDepthSide (/avanza-ts/docs/sdk/reference/generated/interfaces/OrderDepthSide)



## Properties [#properties]

### price [#price]

> `readonly` **price**: `number`

***

### priceString [#pricestring]

> `readonly` **priceString**: `string`

***

### volume [#volume]

> `readonly` **volume**: `number`


# Interface: OrdersClient (/avanza-ts/docs/sdk/reference/generated/interfaces/OrdersClient)



Read-only order and trading status endpoints. All require a session.

## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### activeOrderIds() [#activeorderids]

> **activeOrderIds**(`signal?`): `Promise`\<readonly `string`\[]>

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<readonly `string`\[]>

***

### bulkOrder() [#bulkorder]

> **bulkOrder**(`bulkOrderId`, `signal?`): `Promise`\<[`BulkOrder`](./BulkOrder.md)>

#### Parameters [#parameters-1]

##### bulkOrderId [#bulkorderid]

`string`

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`BulkOrder`](./BulkOrder.md)>

***

### bulkOrders() [#bulkorders]

> **bulkOrders**(`options?`, `signal?`): `Promise`\<[`BulkOrdersResponse`](./BulkOrdersResponse.md)>

Saved bulk (multi-instrument) orders.

#### Parameters [#parameters-2]

##### options? [#options]

[`BulkOrderOptions`](./BulkOrderOptions.md) = `{}`

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`BulkOrdersResponse`](./BulkOrdersResponse.md)>

***

### deals() [#deals]

> **deals**(`signal?`): `Promise`\<[`DealsResponse`](./DealsResponse.md)>

Today's executed deals, including fund deals.

#### Parameters [#parameters-3]

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<[`DealsResponse`](./DealsResponse.md)>

***

### exchangeRates() [#exchangerates]

> **exchangeRates**(`signal?`): `Promise`\<readonly [`ExchangeRate`](./ExchangeRate.md)\[]>

#### Parameters [#parameters-4]

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<readonly [`ExchangeRate`](./ExchangeRate.md)\[]>

***

### marketStatus() [#marketstatus]

> **marketStatus**(`countryCode`, `date?`, `signal?`): `Promise`\<`string`>

`countryCode` is for example `SE` or `US`; `date` is `yyyy-MM-dd` and defaults to today (UTC).

#### Parameters [#parameters-5]

##### countryCode [#countrycode]

`string`

##### date? [#date]

`string` = `...`

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<`string`>

***

### orderbook() [#orderbook]

> **orderbook**(`orderbookId`, `signal?`): `Promise`\<[`TradingOrderbook`](./TradingOrderbook.md)>

Trading rules for an orderbook: tick sizes, validity range, and supported order features.

#### Parameters [#parameters-6]

##### orderbookId [#orderbookid]

`string`

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<[`TradingOrderbook`](./TradingOrderbook.md)>

***

### orderCount() [#ordercount]

> **orderCount**(`signal?`): `Promise`\<[`OrderCount`](./OrderCount.md)>

#### Parameters [#parameters-7]

##### signal? [#signal-7]

`AbortSignal`

#### Returns [#returns-7]

`Promise`\<[`OrderCount`](./OrderCount.md)>

***

### orders() [#orders]

> **orders**(`signal?`): `Promise`\<[`OrdersResponse`](./OrdersResponse.md)>

Open, fund, and cancelled orders.

#### Parameters [#parameters-8]

##### signal? [#signal-8]

`AbortSignal`

#### Returns [#returns-8]

`Promise`\<[`OrdersResponse`](./OrdersResponse.md)>

***

### stopLoss() [#stoploss]

> **stopLoss**(`accountId`, `stopLossId`, `signal?`): `Promise`\<[`StopLoss`](./StopLoss.md)>

`accountId` is an account URL parameter ID.

#### Parameters [#parameters-9]

##### accountId [#accountid]

`string`

##### stopLossId [#stoplossid]

`string`

##### signal? [#signal-9]

`AbortSignal`

#### Returns [#returns-9]

`Promise`\<[`StopLoss`](./StopLoss.md)>

***

### stopLosses() [#stoplosses]

> **stopLosses**(`options?`, `signal?`): `Promise`\<readonly [`StopLoss`](./StopLoss.md)\[]>

#### Parameters [#parameters-10]

##### options? [#options-1]

[`StopLossOptions`](./StopLossOptions.md) = `{}`

##### signal? [#signal-10]

`AbortSignal`

#### Returns [#returns-10]

`Promise`\<readonly [`StopLoss`](./StopLoss.md)\[]>


# Interface: OrdersResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/OrdersResponse)



## Properties [#properties]

### cancelledOrders [#cancelledorders]

> `readonly` **cancelledOrders**: readonly [`OrderItem`](../type-aliases/OrderItem.md)\[]

***

### fundOrders [#fundorders]

> `readonly` **fundOrders**: readonly [`OrderItem`](../type-aliases/OrderItem.md)\[]

***

### orders [#orders]

> `readonly` **orders**: readonly [`OrderItem`](../type-aliases/OrderItem.md)\[]


# Interface: OverviewChartResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/OverviewChartResponse)



## Properties [#properties]

### dataSerie [#dataserie]

> `readonly` **dataSerie**: readonly `object`\[]

***

### fromDate [#fromdate]

> `readonly` **fromDate**: `string`

***

### id [#id]

> `readonly` **id**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbook [#orderbook]

> `readonly` **orderbook**: `object`

#### closingPrice [#closingprice]

> `readonly` **closingPrice**: `number` | `null`

#### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

#### currency [#currency]

> `readonly` **currency**: `string`

#### instrumentSubType [#instrumentsubtype]

> `readonly` **instrumentSubType**: `string` | `null`

#### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

#### lastPrice [#lastprice]

> `readonly` **lastPrice**: `number` | `null`

#### name [#name-1]

> `readonly` **name**: `string`

#### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

#### priceStartOfYear [#pricestartofyear]

> `readonly` **priceStartOfYear**: `number` | `null`

#### priceThreeMonthsAgo [#pricethreemonthsago]

> `readonly` **priceThreeMonthsAgo**: `number` | `null`

#### updated [#updated]

> `readonly` **updated**: `number`

***

### shortName [#shortname]

> `readonly` **shortName**: `string`

***

### toDate [#todate]

> `readonly` **toDate**: `string`


# Interface: PendingTransactionsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/PendingTransactionsResponse)



## Properties [#properties]

### internalTransfers [#internaltransfers]

> `readonly` **internalTransfers**: readonly `object`\[]

***

### withdrawals [#withdrawals]

> `readonly` **withdrawals**: readonly `object`\[]


# Interface: PensionDetails (/avanza-ts/docs/sdk/reference/generated/interfaces/PensionDetails)



## Properties [#properties]

### accountName [#accountname]

> `readonly` **accountName**: `string`

***

### accountType [#accounttype]

> `readonly` **accountType**: `string`

For example `TJP`.

***

### beneficiaries [#beneficiaries]

> `readonly` **beneficiaries**: `object`

#### beneficiaries [#beneficiaries-1]

> `readonly` **beneficiaries**: readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]

#### beneficiaryType [#beneficiarytype]

> `readonly` **beneficiaryType**: `string`

#### irrevocable [#irrevocable]

> `readonly` **irrevocable**: `boolean`

#### privateProperty [#privateproperty]

> `readonly` **privateProperty**: `boolean`

#### text [#text]

> `readonly` **text**: readonly `string`\[]

#### type [#type]

> `readonly` **type**: `string`

***

### childControlDetails [#childcontroldetails]

> `readonly` **childControlDetails**: `unknown`

***

### companyOwnedDetails [#companyowneddetails]

> `readonly` **companyOwnedDetails**: `unknown`

***

### encryptedAccountId [#encryptedaccountid]

> `readonly` **encryptedAccountId**: `string`

***

### insured [#insured]

> `readonly` **insured**: [`InsuranceParty`](./InsuranceParty.md)

***

### isOwner [#isowner]

> `readonly` **isOwner**: `boolean`

***

### managementForm [#managementform]

> `readonly` **managementForm**: `string`

***

### paymentPlan [#paymentplan]

> `readonly` **paymentPlan**: `object`

#### guaranteedMinAmount [#guaranteedminamount]

> `readonly` **guaranteedMinAmount**: `boolean`

#### start [#start]

> `readonly` **start**: `unknown`

#### startMonth [#startmonth]

> `readonly` **startMonth**: `unknown`

#### status [#status]

> `readonly` **status**: `string`

***

### policyOwner [#policyowner]

> `readonly` **policyOwner**: [`InsuranceParty`](./InsuranceParty.md)

***

### repaymentProtection [#repaymentprotection]

> `readonly` **repaymentProtection**: `string`

***

### startDate [#startdate]

> `readonly` **startDate**: `string`

***

### status [#status-1]

> `readonly` **status**: `string`

***

### tax [#tax]

> `readonly` **tax**: `unknown`


# Interface: PensionDistribution (/avanza-ts/docs/sdk/reference/generated/interfaces/PensionDistribution)



## Properties [#properties]

### currentAllocation [#currentallocation]

> `readonly` **currentAllocation**: readonly `object`\[]

***

### nextAutoDistribution [#nextautodistribution]

> `readonly` **nextAutoDistribution**: `unknown`


# Interface: PerformanceChartOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/PerformanceChartOptions)



## Properties [#properties]

### accountIds? [#accountids]

> `readonly` `optional` &#x2A;*accountIds?**: readonly `string`\[]

***

### includeClosedAccounts? [#includeclosedaccounts]

> `readonly` `optional` &#x2A;*includeClosedAccounts?**: `boolean`


# Interface: PerformanceChartResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/PerformanceChartResponse)



## Properties [#properties]

### absoluteSeries [#absoluteseries]

> `readonly` **absoluteSeries**: readonly [`PerformancePoint`](./PerformancePoint.md)\[]

***

### earliestAvailableDate [#earliestavailabledate]

> `readonly` **earliestAvailableDate**: `string`

***

### interval [#interval]

> `readonly` **interval**: [`PerformanceDateRange`](./PerformanceDateRange.md) & `object`

#### Type Declaration [#type-declaration]

##### timePeriod [#timeperiod]

> `readonly` **timePeriod**: `string`

***

### relativeSeries [#relativeseries]

> `readonly` **relativeSeries**: readonly [`PerformancePoint`](./PerformancePoint.md)\[]

***

### timePeriod [#timeperiod-1]

> `readonly` **timePeriod**: `string`

***

### valueSeries [#valueseries]

> `readonly` **valueSeries**: readonly [`PerformancePoint`](./PerformancePoint.md)\[]


# Interface: PerformanceClient (/avanza-ts/docs/sdk/reference/generated/interfaces/PerformanceClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### chart() [#chart]

> **chart**(`period`, `options?`, `signal?`): `Promise`\<[`PerformanceChartResponse`](./PerformanceChartResponse.md)>

Omitted or empty `accountIds` include all accounts.

#### Parameters [#parameters]

##### period [#period]

`"TODAY"` | `"ONE_WEEK"` | `"ONE_MONTH"` | `"THREE_MONTHS"` | `"THIS_YEAR"` | `"ONE_YEAR"` | `"THREE_YEARS"` | `"FIVE_YEARS"` | `"ALL_TIME"` | [`PerformanceDateRange`](./PerformanceDateRange.md)

##### options? [#options]

[`PerformanceChartOptions`](./PerformanceChartOptions.md) = `{}`

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`PerformanceChartResponse`](./PerformanceChartResponse.md)>

***

### insights() [#insights]

> **insights**(`timePeriod`, `ids?`, `signal?`): `Promise`\<[`InsightsReport`](./InsightsReport.md)>

Omitted or empty `accountIds` include all accounts.

#### Parameters [#parameters-1]

##### timePeriod [#timeperiod]

`"TODAY"` | `"ONE_WEEK"` | `"THIS_YEAR"` | `"THREE_YEARS_ROLLING"`

##### ids? [#ids]

readonly `string`\[]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`InsightsReport`](./InsightsReport.md)>

***

### totalValues() [#totalvalues]

> **totalValues**(`ids?`, `signal?`): `Promise`\<[`TotalValuesResponse`](./TotalValuesResponse.md)>

Omitted or empty `ids` include all accounts.

#### Parameters [#parameters-2]

##### ids? [#ids-1]

readonly `string`\[]

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`TotalValuesResponse`](./TotalValuesResponse.md)>


# Interface: PerformanceDateRange (/avanza-ts/docs/sdk/reference/generated/interfaces/PerformanceDateRange)



## Properties [#properties]

### from [#from]

> `readonly` **from**: `string`

***

### to [#to]

> `readonly` **to**: `string`


# Interface: PerformanceDevelopment (/avanza-ts/docs/sdk/reference/generated/interfaces/PerformanceDevelopment)



## Properties [#properties]

### absolute [#absolute]

> `readonly` **absolute**: [`AccountAmount`](./AccountAmount.md)

***

### relative [#relative]

> `readonly` **relative**: [`AccountAmount`](./AccountAmount.md)


# Interface: PerformancePoint (/avanza-ts/docs/sdk/reference/generated/interfaces/PerformancePoint)



## Properties [#properties]

### performance [#performance]

> `readonly` **performance**: [`AccountAmount`](./AccountAmount.md)

***

### timestamp [#timestamp]

> `readonly` **timestamp**: `number`


# Interface: PeriodicSavingsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/PeriodicSavingsResponse)



## Properties [#properties]

### periodicSavings [#periodicsavings]

> `readonly` **periodicSavings**: readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]


# Interface: PopularStockSector (/avanza-ts/docs/sdk/reference/generated/interfaces/PopularStockSector)



## Extends [#extends]

* [`StockSector`](./StockSector.md)

## Properties [#properties]

### illustrationName [#illustrationname]

> `readonly` **illustrationName**: `string`

***

### sectorId [#sectorid]

> `readonly` **sectorId**: `string`

#### Inherited from [#inherited-from]

[`StockSector`](./StockSector.md).[`sectorId`](./StockSector.md#sectorid)

***

### sectorName [#sectorname]

> `readonly` **sectorName**: `string`

#### Inherited from [#inherited-from-1]

[`StockSector`](./StockSector.md).[`sectorName`](./StockSector.md#sectorname)


# Interface: PositionCategoriesResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/PositionCategoriesResponse)



## Properties [#properties]

### categoryStatistics [#categorystatistics]

> `readonly` **categoryStatistics**: readonly `object`\[]

***

### cloud [#cloud]

> `readonly` **cloud**: `boolean`


# Interface: PositionCountryAllocation (/avanza-ts/docs/sdk/reference/generated/interfaces/PositionCountryAllocation)



## Properties [#properties]

### allocations [#allocations]

> `readonly` **allocations**: readonly `object`\[]

***

### positionId [#positionid]

> `readonly` **positionId**: `string`


# Interface: PositionOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/PositionOrderbook)



## Properties [#properties]

### currency [#currency]

> `readonly` **currency**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string` | `null`

***

### id [#id]

> `readonly` **id**: `string`

***

### instrumentId [#instrumentid]

> `readonly` **instrumentId**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### name [#name]

> `readonly` **name**: `string`


# Interface: PositionPopularCategoriesResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/PositionPopularCategoriesResponse)



## Properties [#properties]

### cloud [#cloud]

> `readonly` **cloud**: `boolean`

***

### popularCategories [#popularcategories]

> `readonly` **popularCategories**: readonly `object`\[]


# Interface: PositionsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/PositionsClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### activeTools() [#activetools]

> **activeTools**(`signal?`): `Promise`\<[`ActivePositionToolsResponse`](../type-aliases/ActivePositionToolsResponse.md)>

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`ActivePositionToolsResponse`](../type-aliases/ActivePositionToolsResponse.md)>

***

### categories() [#categories]

> **categories**(`orderbookId`, `signal?`): `Promise`\<[`PositionCategoriesResponse`](./PositionCategoriesResponse.md)>

#### Parameters [#parameters-1]

##### orderbookId [#orderbookid]

`string`

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`PositionCategoriesResponse`](./PositionCategoriesResponse.md)>

***

### countries() [#countries]

> **countries**(`accountId?`, `signal?`): `Promise`\<[`PositionCountriesResponse`](../type-aliases/PositionCountriesResponse.md)>

#### Parameters [#parameters-2]

##### accountId? [#accountid]

`string`

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`PositionCountriesResponse`](../type-aliases/PositionCountriesResponse.md)>

***

### list() [#list]

> **list**(`accountId?`, `signal?`): `Promise`\<\{\[`key`: `string`]: `unknown`; `cashPositions`: `object`\[]; `withCreditAccount`: `boolean`; `withOrderbook`: `object`\[]; `withoutOrderbook`: `object`\[]; }>

#### Parameters [#parameters-3]

##### accountId? [#accountid-1]

`string`

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<\{\[`key`: `string`]: `unknown`; `cashPositions`: `object`\[]; `withCreditAccount`: `boolean`; `withOrderbook`: `object`\[]; `withoutOrderbook`: `object`\[]; }>

***

### orderbooks() [#orderbooks]

> **orderbooks**(`orderbookIds`, `signal?`): `Promise`\<[`PositionOrderbooksResponse`](../type-aliases/PositionOrderbooksResponse.md)>

#### Parameters [#parameters-4]

##### orderbookIds [#orderbookids]

readonly `string`\[]

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`PositionOrderbooksResponse`](../type-aliases/PositionOrderbooksResponse.md)>

***

### popularCategories() [#popularcategories]

> **popularCategories**(`orderbookId`, `signal?`): `Promise`\<[`PositionPopularCategoriesResponse`](./PositionPopularCategoriesResponse.md)>

#### Parameters [#parameters-5]

##### orderbookId [#orderbookid-1]

`string`

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<[`PositionPopularCategoriesResponse`](./PositionPopularCategoriesResponse.md)>


# Interface: PriceChartOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/PriceChartOptions)



## Properties [#properties]

### resolution? [#resolution]

> `readonly` `optional` &#x2A;*resolution?**: `"minute"` | `"two_minutes"` | `"five_minutes"` | `"ten_minutes"` | `"thirty_minutes"` | `"hour"` | `"day"` | `"week"` | `"month"` | `"quarter"`

Available resolutions depend on the period; see `metadata.resolution`.


# Interface: PriceChartResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/PriceChartResponse)



## Properties [#properties]

### from [#from]

> `readonly` **from**: `string`

***

### metadata [#metadata]

> `readonly` **metadata**: `object`

#### resolution [#resolution]

> `readonly` **resolution**: `object`

##### resolution.availableResolutions [#resolutionavailableresolutions]

> `readonly` **availableResolutions**: readonly (`"minute"` | `"two_minutes"` | `"five_minutes"` | `"ten_minutes"` | `"thirty_minutes"` | `"hour"` | `"day"` | `"week"` | `"month"` | `"quarter"`)\[]

##### resolution.chartResolution [#resolutionchartresolution]

> `readonly` **chartResolution**: `"minute"` | `"two_minutes"` | `"five_minutes"` | `"ten_minutes"` | `"thirty_minutes"` | `"hour"` | `"day"` | `"week"` | `"month"` | `"quarter"`

***

### ohlc [#ohlc]

> `readonly` **ohlc**: readonly [`Ohlc`](./Ohlc.md)\[]

***

### previousClosingPrice [#previousclosingprice]

> `readonly` **previousClosingPrice**: `number` | `null`

***

### to [#to]

> `readonly` **to**: `string`


# Interface: RecurringDepositsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/RecurringDepositsResponse)



## Properties [#properties]

### autogiroResponseList [#autogiroresponselist]

> `readonly` **autogiroResponseList**: readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]


# Interface: SavedStockFilter (/avanza-ts/docs/sdk/reference/generated/interfaces/SavedStockFilter)



## Properties [#properties]

### filter [#filter]

> `readonly` **filter**: [`StockFilter`](./StockFilter.md)

***

### name [#name]

> `readonly` **name**: `string`


# Interface: SavedStockFiltersResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/SavedStockFiltersResponse)



## Properties [#properties]

### filters [#filters]

> `readonly` **filters**: readonly [`SavedStockFilter`](./SavedStockFilter.md)\[]


# Interface: SavingsCategory (/avanza-ts/docs/sdk/reference/generated/interfaces/SavingsCategory)



## Properties [#properties]

### accounts [#accounts]

> `readonly` **accounts**: readonly [`SavingsCategoryAccount`](./SavingsCategoryAccount.md)\[]

***

### categoryId [#categoryid]

> `readonly` **categoryId**: `string`

***

### categoryType [#categorytype]

> `readonly` **categoryType**: `string`

For example `SAVINGS_GOAL` or `DEFAULT`.

***

### name [#name]

> `readonly` **name**: `string`

***

### sortOrder [#sortorder]

> `readonly` **sortOrder**: `number`

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: `number`


# Interface: SavingsCategoryAccount (/avanza-ts/docs/sdk/reference/generated/interfaces/SavingsCategoryAccount)



## Properties [#properties]

### accountDomain [#accountdomain]

> `readonly` **accountDomain**: `string`

***

### accountType [#accounttype]

> `readonly` **accountType**: `string`

***

### externalAccountNumber [#externalaccountnumber]

> `readonly` **externalAccountNumber**: `object`

#### value [#value]

> `readonly` **value**: `string`

***

### id [#id]

> `readonly` **id**: `number`

***

### isHidden [#ishidden]

> `readonly` **isHidden**: `boolean`

***

### isValidForSharedGoal [#isvalidforsharedgoal]

> `readonly` **isValidForSharedGoal**: `boolean`

***

### name [#name]

> `readonly` **name**: `string`

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: `number`

***

### validForSharedGoal [#validforsharedgoal]

> `readonly` **validForSharedGoal**: `boolean`


# Interface: SavingsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/SavingsClient)



Read-only recurring savings, savings goals, credit, and pension data. All require a session.

## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### categories() [#categories]

> **categories**(`signal?`): `Promise`\<readonly [`SavingsCategory`](./SavingsCategory.md)\[]>

Accounts grouped into savings goals and other categories.

#### Parameters [#parameters]

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<readonly [`SavingsCategory`](./SavingsCategory.md)\[]>

***

### creditAccounts() [#creditaccounts]

> **creditAccounts**(`signal?`): `Promise`\<[`CreditAccountsResponse`](./CreditAccountsResponse.md)>

Accounts available for securities credit.

#### Parameters [#parameters-1]

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`CreditAccountsResponse`](./CreditAccountsResponse.md)>

***

### creditInfo() [#creditinfo]

> **creditInfo**(`type`, `signal?`): `Promise`\<[`CreditInfoResponse`](./CreditInfoResponse.md)>

Credit limit, used credit, interest, and leverage per account.

#### Parameters [#parameters-2]

##### type [#type]

[`CreditType`](../type-aliases/CreditType.md)

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`CreditInfoResponse`](./CreditInfoResponse.md)>

***

### goalHealth() [#goalhealth]

> **goalHealth**(`categoryId`, `signal?`): `Promise`\<[`SavingsGoalHealth`](./SavingsGoalHealth.md)>

#### Parameters [#parameters-3]

##### categoryId [#categoryid]

`string`

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<[`SavingsGoalHealth`](./SavingsGoalHealth.md)>

***

### goalPerformance() [#goalperformance]

> **goalPerformance**(`categoryId`, `timePeriod`, `signal?`): `Promise`\<[`SavingsGoalPerformance`](./SavingsGoalPerformance.md)>

#### Parameters [#parameters-4]

##### categoryId [#categoryid-1]

`string`

##### timePeriod [#timeperiod]

`"ONE_WEEK"` | `"ONE_MONTH"` | `"THREE_MONTHS"` | `"THIS_YEAR"` | `"ONE_YEAR"` | `"THREE_YEARS"` | `"INFINITY"`

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`SavingsGoalPerformance`](./SavingsGoalPerformance.md)>

***

### payoutPlan() [#payoutplan]

> **payoutPlan**(`accountId`, `signal?`): `Promise`\<`Readonly`\<`Record`\<`string`, `unknown`>> | `null`>

Resolves to `null` when the account has no payout plan (HTTP 204).

#### Parameters [#parameters-5]

##### accountId [#accountid]

`string`

##### signal? [#signal-5]

`AbortSignal`

#### Returns [#returns-5]

`Promise`\<`Readonly`\<`Record`\<`string`, `unknown`>> | `null`>

***

### payoutPlans() [#payoutplans]

> **payoutPlans**(`signal?`): `Promise`\<readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]>

#### Parameters [#parameters-6]

##### signal? [#signal-6]

`AbortSignal`

#### Returns [#returns-6]

`Promise`\<readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]>

***

### pensionDetails() [#pensiondetails]

> **pensionDetails**(`accountId`, `signal?`): `Promise`\<[`PensionDetails`](./PensionDetails.md)>

`accountId` is the numeric account ID of a pension or insurance account.

#### Parameters [#parameters-7]

##### accountId [#accountid-1]

`string`

##### signal? [#signal-7]

`AbortSignal`

#### Returns [#returns-7]

`Promise`\<[`PensionDetails`](./PensionDetails.md)>

***

### pensionDistribution() [#pensiondistribution]

> **pensionDistribution**(`accountId`, `signal?`): `Promise`\<[`PensionDistribution`](./PensionDistribution.md)>

Current and next fund allocation for new pension premiums.

#### Parameters [#parameters-8]

##### accountId [#accountid-2]

`string`

##### signal? [#signal-8]

`AbortSignal`

#### Returns [#returns-8]

`Promise`\<[`PensionDistribution`](./PensionDistribution.md)>

***

### periodicSavings() [#periodicsavings]

> **periodicSavings**(`signal?`): `Promise`\<[`PeriodicSavingsResponse`](./PeriodicSavingsResponse.md)>

#### Parameters [#parameters-9]

##### signal? [#signal-9]

`AbortSignal`

#### Returns [#returns-9]

`Promise`\<[`PeriodicSavingsResponse`](./PeriodicSavingsResponse.md)>

***

### recurringDeposits() [#recurringdeposits]

> **recurringDeposits**(`signal?`): `Promise`\<[`RecurringDepositsResponse`](./RecurringDepositsResponse.md)>

#### Parameters [#parameters-10]

##### signal? [#signal-10]

`AbortSignal`

#### Returns [#returns-10]

`Promise`\<[`RecurringDepositsResponse`](./RecurringDepositsResponse.md)>


# Interface: SavingsGoalHealth (/avanza-ts/docs/sdk/reference/generated/interfaces/SavingsGoalHealth)



## Properties [#properties]

### averageMonthlySavings [#averagemonthlysavings]

> `readonly` **averageMonthlySavings**: `number`

***

### averageMonthlySavingsTarget [#averagemonthlysavingstarget]

> `readonly` **averageMonthlySavingsTarget**: `number`

***

### averageYearlyPerformance [#averageyearlyperformance]

> `readonly` **averageYearlyPerformance**: `number`

***

### averageYearlyPerformanceTarget [#averageyearlyperformancetarget]

> `readonly` **averageYearlyPerformanceTarget**: `number`

***

### totalPerformanceTarget [#totalperformancetarget]

> `readonly` **totalPerformanceTarget**: `number`


# Interface: SavingsGoalPerformance (/avanza-ts/docs/sdk/reference/generated/interfaces/SavingsGoalPerformance)



## Properties [#properties]

### goalAggregatedPerformance [#goalaggregatedperformance]

> `readonly` **goalAggregatedPerformance**: readonly [`SavingsGoalPoint`](./SavingsGoalPoint.md)\[]

***

### goalAggregatedPerformanceCash [#goalaggregatedperformancecash]

> `readonly` **goalAggregatedPerformanceCash**: readonly [`SavingsGoalPoint`](./SavingsGoalPoint.md)\[]

***

### goalTotalPerformance [#goaltotalperformance]

> `readonly` **goalTotalPerformance**: `number`

***

### goalTotalPerformanceCash [#goaltotalperformancecash]

> `readonly` **goalTotalPerformanceCash**: `number`

***

### graphResolution [#graphresolution]

> `readonly` **graphResolution**: `string`

For example `MONTH`.

***

### memberPerformanceDataPoints [#memberperformancedatapoints]

> `readonly` **memberPerformanceDataPoints**: readonly `Readonly`\<`Record`\<`string`, `unknown`>>\[]

Per-member series for shared goals.


# Interface: SavingsGoalPoint (/avanza-ts/docs/sdk/reference/generated/interfaces/SavingsGoalPoint)



## Properties [#properties]

### timestamp [#timestamp]

> `readonly` **timestamp**: `number`

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: `number`

***

### value [#value]

> `readonly` **value**: `number`

Change in percent (`goalAggregatedPerformance`) or cash (`goalAggregatedPerformanceCash`).


# Interface: ScreenListedProductsOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenListedProductsOptions)



## Properties [#properties]

### filter? [#filter]

> `readonly` `optional` &#x2A;*filter?**: `Readonly`\<`Record`\<`string`, `string` | `boolean` | readonly `string`\[]>>

***

### limit? [#limit]

> `readonly` `optional` &#x2A;*limit?**: `number`

***

### offset? [#offset]

> `readonly` `optional` &#x2A;*offset?**: `number`

***

### signal? [#signal]

> `readonly` `optional` &#x2A;*signal?**: `AbortSignal`

***

### sortBy? [#sortby]

> `readonly` `optional` &#x2A;*sortBy?**: [`StockSort`](./StockSort.md)


# Interface: ScreenStocksOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenStocksOptions)



## Properties [#properties]

### filter? [#filter]

> `readonly` `optional` &#x2A;*filter?**: [`StockFilter`](./StockFilter.md)

***

### limit? [#limit]

> `readonly` `optional` &#x2A;*limit?**: `number`

***

### offset? [#offset]

> `readonly` `optional` &#x2A;*offset?**: `number`

***

### signal? [#signal]

> `readonly` `optional` &#x2A;*signal?**: `AbortSignal`

***

### sortBy? [#sortby]

> `readonly` `optional` &#x2A;*sortBy?**: [`StockSort`](./StockSort.md)


# Interface: ScreenStocksResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenStocksResponse)



## Properties [#properties]

### filter [#filter]

> `readonly` **filter**: [`StockFilter`](./StockFilter.md)

***

### filterOptions [#filteroptions]

> `readonly` **filterOptions**: [`StockFilterOptions`](./StockFilterOptions.md)

***

### pagination [#pagination]

> `readonly` **pagination**: `object`

#### limit [#limit]

> `readonly` **limit**: `number`

#### offset [#offset]

> `readonly` **offset**: `number`

***

### sortBy [#sortby]

> `readonly` **sortBy**: [`StockSort`](./StockSort.md)

***

### stocks [#stocks]

> `readonly` **stocks**: readonly [`ScreenedStock`](./ScreenedStock.md)\[]

***

### totalNumberOfOrderbooks [#totalnumberoforderbooks]

> `readonly` **totalNumberOfOrderbooks**: `number`


# Interface: ScreenedCertificate (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenedCertificate)



## Properties [#properties]

### buyPrice [#buyprice]

> `readonly` **buyPrice**: `number` | `null`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### direction [#direction]

> `readonly` **direction**: `string`

***

### hasPosition [#hasposition]

> `readonly` **hasPosition**: `boolean`

***

### issuer [#issuer]

> `readonly` **issuer**: `string`

***

### leverage [#leverage]

> `readonly` **leverage**: `number` | `null`

***

### marketplaceCode [#marketplacecode]

> `readonly` **marketplaceCode**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### sellPrice [#sellprice]

> `readonly` **sellPrice**: `number` | `null`

***

### spread [#spread]

> `readonly` **spread**: `number` | `null`

***

### totalValueTraded [#totalvaluetraded]

> `readonly` **totalValueTraded**: `number`

***

### underlyingInstrument [#underlyinginstrument]

> `readonly` **underlyingInstrument**: [`UnderlyingInstrument`](./UnderlyingInstrument.md) | `null`


# Interface: ScreenedEtf (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenedEtf)



## Properties [#properties]

### collateralValue [#collateralvalue]

> `readonly` **collateralValue**: `number` | `null`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### hasPosition [#hasposition]

> `readonly` **hasPosition**: `boolean`

***

### managementFee [#managementfee]

> `readonly` **managementFee**: `number` | `null`

***

### name [#name]

> `readonly` **name**: `string`

***

### numberOfOwners [#numberofowners]

> `readonly` **numberOfOwners**: `number`

***

### oneDayChangePercent [#onedaychangepercent]

> `readonly` **oneDayChangePercent**: `number` | `null`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### productFee [#productfee]

> `readonly` **productFee**: `number` | `null`

***

### riskScore [#riskscore]

> `readonly` **riskScore**: `number` | `null`


# Interface: ScreenedStock (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenedStock)



## Extends [#extends]

* `Readonly`\<`Partial`\<`Record`\<[`StockMetric`](../type-aliases/StockMetric.md), `number` | `undefined`>>>

## Indexable [#indexable]

> \[`key`: `string`]: `unknown`

## Properties [#properties]

### beta? [#beta]

> `optional` &#x2A;*beta?**: `number`

#### Inherited from [#inherited-from]

`ScreenedStock`.[`beta`](#beta)

***

### bollingerDistanceLower? [#bollingerdistancelower]

> `optional` &#x2A;*bollingerDistanceLower?**: `number`

#### Inherited from [#inherited-from-1]

`ScreenedStock`.[`bollingerDistanceLower`](#bollingerdistancelower)

***

### bollingerDistanceUpper? [#bollingerdistanceupper]

> `optional` &#x2A;*bollingerDistanceUpper?**: `number`

#### Inherited from [#inherited-from-2]

`ScreenedStock`.[`bollingerDistanceUpper`](#bollingerdistanceupper)

***

### bollingerDistanceUpperToLower? [#bollingerdistanceuppertolower]

> `optional` &#x2A;*bollingerDistanceUpperToLower?**: `number`

#### Inherited from [#inherited-from-3]

`ScreenedStock`.[`bollingerDistanceUpperToLower`](#bollingerdistanceuppertolower)

***

### buyPrice? [#buyprice]

> `optional` &#x2A;*buyPrice?**: `number`

#### Inherited from [#inherited-from-4]

`ScreenedStock`.[`buyPrice`](#buyprice)

***

### collateralValue? [#collateralvalue]

> `optional` &#x2A;*collateralValue?**: `number`

#### Inherited from [#inherited-from-5]

`ScreenedStock`.[`collateralValue`](#collateralvalue)

***

### companyId [#companyid]

> `readonly` **companyId**: `string`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### debtToEquityRatio? [#debttoequityratio]

> `optional` &#x2A;*debtToEquityRatio?**: `number`

#### Inherited from [#inherited-from-6]

`ScreenedStock`.[`debtToEquityRatio`](#debttoequityratio)

***

### directYield? [#directyield]

> `optional` &#x2A;*directYield?**: `number`

#### Inherited from [#inherited-from-7]

`ScreenedStock`.[`directYield`](#directyield)

***

### dividendPerShare? [#dividendpershare]

> `optional` &#x2A;*dividendPerShare?**: `number`

#### Inherited from [#inherited-from-8]

`ScreenedStock`.[`dividendPerShare`](#dividendpershare)

***

### dividendRatio? [#dividendratio]

> `optional` &#x2A;*dividendRatio?**: `number`

#### Inherited from [#inherited-from-9]

`ScreenedStock`.[`dividendRatio`](#dividendratio)

***

### dividendsPerYear? [#dividendsperyear]

> `optional` &#x2A;*dividendsPerYear?**: `number`

#### Inherited from [#inherited-from-10]

`ScreenedStock`.[`dividendsPerYear`](#dividendsperyear)

***

### earningsPerShare? [#earningspershare]

> `optional` &#x2A;*earningsPerShare?**: `number`

#### Inherited from [#inherited-from-11]

`ScreenedStock`.[`earningsPerShare`](#earningspershare)

***

### equityPerShare? [#equitypershare]

> `optional` &#x2A;*equityPerShare?**: `number`

#### Inherited from [#inherited-from-12]

`ScreenedStock`.[`equityPerShare`](#equitypershare)

***

### evEbitRatio? [#evebitratio]

> `optional` &#x2A;*evEbitRatio?**: `number`

#### Inherited from [#inherited-from-13]

`ScreenedStock`.[`evEbitRatio`](#evebitratio)

***

### fiveYearsChangePercent? [#fiveyearschangepercent]

> `optional` &#x2A;*fiveYearsChangePercent?**: `number`

#### Inherited from [#inherited-from-14]

`ScreenedStock`.[`fiveYearsChangePercent`](#fiveyearschangepercent)

***

### hasAnalysis? [#hasanalysis]

> `readonly` `optional` &#x2A;*hasAnalysis?**: `boolean`

***

### hasPosition? [#hasposition]

> `readonly` `optional` &#x2A;*hasPosition?**: `boolean`

***

### highestPrice? [#highestprice]

> `optional` &#x2A;*highestPrice?**: `number`

#### Inherited from [#inherited-from-15]

`ScreenedStock`.[`highestPrice`](#highestprice)

***

### infinityChangePercent? [#infinitychangepercent]

> `optional` &#x2A;*infinityChangePercent?**: `number`

#### Inherited from [#inherited-from-16]

`ScreenedStock`.[`infinityChangePercent`](#infinitychangepercent)

***

### lastPrice? [#lastprice]

> `optional` &#x2A;*lastPrice?**: `number`

#### Inherited from [#inherited-from-17]

`ScreenedStock`.[`lastPrice`](#lastprice)

***

### lastPriceUpdated? [#lastpriceupdated]

> `optional` &#x2A;*lastPriceUpdated?**: `number`

#### Inherited from [#inherited-from-18]

`ScreenedStock`.[`lastPriceUpdated`](#lastpriceupdated)

***

### lowestPrice? [#lowestprice]

> `optional` &#x2A;*lowestPrice?**: `number`

#### Inherited from [#inherited-from-19]

`ScreenedStock`.[`lowestPrice`](#lowestprice)

***

### macdHistogram? [#macdhistogram]

> `optional` &#x2A;*macdHistogram?**: `number`

#### Inherited from [#inherited-from-20]

`ScreenedStock`.[`macdHistogram`](#macdhistogram)

***

### macdSignal? [#macdsignal]

> `optional` &#x2A;*macdSignal?**: `number`

#### Inherited from [#inherited-from-21]

`ScreenedStock`.[`macdSignal`](#macdsignal)

***

### macdValue? [#macdvalue]

> `optional` &#x2A;*macdValue?**: `number`

#### Inherited from [#inherited-from-22]

`ScreenedStock`.[`macdValue`](#macdvalue)

***

### marketCap? [#marketcap]

> `optional` &#x2A;*marketCap?**: `number`

#### Inherited from [#inherited-from-23]

`ScreenedStock`.[`marketCap`](#marketcap)

***

### marketCapitalization? [#marketcapitalization]

> `optional` &#x2A;*marketCapitalization?**: `number`

#### Inherited from [#inherited-from-24]

`ScreenedStock`.[`marketCapitalization`](#marketcapitalization)

***

### marketPlaceCode [#marketplacecode]

> `readonly` **marketPlaceCode**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### netDebtEbitdaRatio? [#netdebtebitdaratio]

> `optional` &#x2A;*netDebtEbitdaRatio?**: `number`

#### Inherited from [#inherited-from-25]

`ScreenedStock`.[`netDebtEbitdaRatio`](#netdebtebitdaratio)

***

### netProfit? [#netprofit]

> `optional` &#x2A;*netProfit?**: `number`

#### Inherited from [#inherited-from-26]

`ScreenedStock`.[`netProfit`](#netprofit)

***

### nextCompanyReport? [#nextcompanyreport]

> `readonly` `optional` &#x2A;*nextCompanyReport?**: `string`

***

### nextDividend? [#nextdividend]

> `readonly` `optional` &#x2A;*nextDividend?**: `string`

***

### numberOfOwners? [#numberofowners]

> `optional` &#x2A;*numberOfOwners?**: `number`

#### Inherited from [#inherited-from-27]

`ScreenedStock`.[`numberOfOwners`](#numberofowners)

***

### oneDayChangePercent? [#onedaychangepercent]

> `optional` &#x2A;*oneDayChangePercent?**: `number`

#### Inherited from [#inherited-from-28]

`ScreenedStock`.[`oneDayChangePercent`](#onedaychangepercent)

***

### oneMonthChangePercent? [#onemonthchangepercent]

> `optional` &#x2A;*oneMonthChangePercent?**: `number`

#### Inherited from [#inherited-from-29]

`ScreenedStock`.[`oneMonthChangePercent`](#onemonthchangepercent)

***

### oneWeekChangePercent? [#oneweekchangepercent]

> `optional` &#x2A;*oneWeekChangePercent?**: `number`

#### Inherited from [#inherited-from-30]

`ScreenedStock`.[`oneWeekChangePercent`](#oneweekchangepercent)

***

### oneYearChangePercent? [#oneyearchangepercent]

> `optional` &#x2A;*oneYearChangePercent?**: `number`

#### Inherited from [#inherited-from-31]

`ScreenedStock`.[`oneYearChangePercent`](#oneyearchangepercent)

***

### operatingCashFlow? [#operatingcashflow]

> `optional` &#x2A;*operatingCashFlow?**: `number`

#### Inherited from [#inherited-from-32]

`ScreenedStock`.[`operatingCashFlow`](#operatingcashflow)

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### ownersChangeOneDay? [#ownerschangeoneday]

> `optional` &#x2A;*ownersChangeOneDay?**: `number`

#### Inherited from [#inherited-from-33]

`ScreenedStock`.[`ownersChangeOneDay`](#ownerschangeoneday)

***

### ownersChangeOneDayAbsolute? [#ownerschangeonedayabsolute]

> `optional` &#x2A;*ownersChangeOneDayAbsolute?**: `number`

#### Inherited from [#inherited-from-34]

`ScreenedStock`.[`ownersChangeOneDayAbsolute`](#ownerschangeonedayabsolute)

***

### ownersChangeOneMonth? [#ownerschangeonemonth]

> `optional` &#x2A;*ownersChangeOneMonth?**: `number`

#### Inherited from [#inherited-from-35]

`ScreenedStock`.[`ownersChangeOneMonth`](#ownerschangeonemonth)

***

### ownersChangeOneMonthAbsolute? [#ownerschangeonemonthabsolute]

> `optional` &#x2A;*ownersChangeOneMonthAbsolute?**: `number`

#### Inherited from [#inherited-from-36]

`ScreenedStock`.[`ownersChangeOneMonthAbsolute`](#ownerschangeonemonthabsolute)

***

### ownersChangeOneWeek? [#ownerschangeoneweek]

> `optional` &#x2A;*ownersChangeOneWeek?**: `number`

#### Inherited from [#inherited-from-37]

`ScreenedStock`.[`ownersChangeOneWeek`](#ownerschangeoneweek)

***

### ownersChangeOneWeekAbsolute? [#ownerschangeoneweekabsolute]

> `optional` &#x2A;*ownersChangeOneWeekAbsolute?**: `number`

#### Inherited from [#inherited-from-38]

`ScreenedStock`.[`ownersChangeOneWeekAbsolute`](#ownerschangeoneweekabsolute)

***

### ownersChangeOneYear? [#ownerschangeoneyear]

> `optional` &#x2A;*ownersChangeOneYear?**: `number`

#### Inherited from [#inherited-from-39]

`ScreenedStock`.[`ownersChangeOneYear`](#ownerschangeoneyear)

***

### ownersChangeOneYearAbsolute? [#ownerschangeoneyearabsolute]

> `optional` &#x2A;*ownersChangeOneYearAbsolute?**: `number`

#### Inherited from [#inherited-from-40]

`ScreenedStock`.[`ownersChangeOneYearAbsolute`](#ownerschangeoneyearabsolute)

***

### ownersChangeThisYear? [#ownerschangethisyear]

> `optional` &#x2A;*ownersChangeThisYear?**: `number`

#### Inherited from [#inherited-from-41]

`ScreenedStock`.[`ownersChangeThisYear`](#ownerschangethisyear)

***

### ownersChangeThisYearAbsolute? [#ownerschangethisyearabsolute]

> `optional` &#x2A;*ownersChangeThisYearAbsolute?**: `number`

#### Inherited from [#inherited-from-42]

`ScreenedStock`.[`ownersChangeThisYearAbsolute`](#ownerschangethisyearabsolute)

***

### ownersChangeThreeMonths? [#ownerschangethreemonths]

> `optional` &#x2A;*ownersChangeThreeMonths?**: `number`

#### Inherited from [#inherited-from-43]

`ScreenedStock`.[`ownersChangeThreeMonths`](#ownerschangethreemonths)

***

### ownersChangeThreeMonthsAbsolute? [#ownerschangethreemonthsabsolute]

> `optional` &#x2A;*ownersChangeThreeMonthsAbsolute?**: `number`

#### Inherited from [#inherited-from-44]

`ScreenedStock`.[`ownersChangeThreeMonthsAbsolute`](#ownerschangethreemonthsabsolute)

***

### priceBookRatio? [#pricebookratio]

> `optional` &#x2A;*priceBookRatio?**: `number`

#### Inherited from [#inherited-from-45]

`ScreenedStock`.[`priceBookRatio`](#pricebookratio)

***

### priceEarningsRatio? [#priceearningsratio]

> `optional` &#x2A;*priceEarningsRatio?**: `number`

#### Inherited from [#inherited-from-46]

`ScreenedStock`.[`priceEarningsRatio`](#priceearningsratio)

***

### pricePerSaleRatio? [#pricepersaleratio]

> `optional` &#x2A;*pricePerSaleRatio?**: `number`

#### Inherited from [#inherited-from-47]

`ScreenedStock`.[`pricePerSaleRatio`](#pricepersaleratio)

***

### priceSalesRatio? [#pricesalesratio]

> `optional` &#x2A;*priceSalesRatio?**: `number`

#### Inherited from [#inherited-from-48]

`ScreenedStock`.[`priceSalesRatio`](#pricesalesratio)

***

### profitMargin? [#profitmargin]

> `optional` &#x2A;*profitMargin?**: `number`

#### Inherited from [#inherited-from-49]

`ScreenedStock`.[`profitMargin`](#profitmargin)

***

### returnOnAssets? [#returnonassets]

> `optional` &#x2A;*returnOnAssets?**: `number`

#### Inherited from [#inherited-from-50]

`ScreenedStock`.[`returnOnAssets`](#returnonassets)

***

### returnOnCapitalEmployed? [#returnoncapitalemployed]

> `optional` &#x2A;*returnOnCapitalEmployed?**: `number`

#### Inherited from [#inherited-from-51]

`ScreenedStock`.[`returnOnCapitalEmployed`](#returnoncapitalemployed)

***

### returnOnEquity? [#returnonequity]

> `optional` &#x2A;*returnOnEquity?**: `number`

#### Inherited from [#inherited-from-52]

`ScreenedStock`.[`returnOnEquity`](#returnonequity)

***

### rsi14? [#rsi14]

> `optional` &#x2A;*rsi14?**: `number`

#### Inherited from [#inherited-from-53]

`ScreenedStock`.[`rsi14`](#rsi14)

***

### rsiTrendFiveDays? [#rsitrendfivedays]

> `optional` &#x2A;*rsiTrendFiveDays?**: `number`

#### Inherited from [#inherited-from-54]

`ScreenedStock`.[`rsiTrendFiveDays`](#rsitrendfivedays)

***

### rsiTrendThreeDays? [#rsitrendthreedays]

> `optional` &#x2A;*rsiTrendThreeDays?**: `number`

#### Inherited from [#inherited-from-55]

`ScreenedStock`.[`rsiTrendThreeDays`](#rsitrendthreedays)

***

### sales? [#sales]

> `optional` &#x2A;*sales?**: `number`

#### Inherited from [#inherited-from-56]

`ScreenedStock`.[`sales`](#sales)

***

### sellPrice? [#sellprice]

> `optional` &#x2A;*sellPrice?**: `number`

#### Inherited from [#inherited-from-57]

`ScreenedStock`.[`sellPrice`](#sellprice)

***

### shortName [#shortname]

> `readonly` **shortName**: `string`

***

### shortSellingRatio? [#shortsellingratio]

> `optional` &#x2A;*shortSellingRatio?**: `number`

#### Inherited from [#inherited-from-58]

`ScreenedStock`.[`shortSellingRatio`](#shortsellingratio)

***

### sixMonthsChangePercent? [#sixmonthschangepercent]

> `optional` &#x2A;*sixMonthsChangePercent?**: `number`

#### Inherited from [#inherited-from-59]

`ScreenedStock`.[`sixMonthsChangePercent`](#sixmonthschangepercent)

***

### sma20? [#sma20]

> `optional` &#x2A;*sma20?**: `number`

#### Inherited from [#inherited-from-60]

`ScreenedStock`.[`sma20`](#sma20)

***

### sma200? [#sma200]

> `optional` &#x2A;*sma200?**: `number`

#### Inherited from [#inherited-from-61]

`ScreenedStock`.[`sma200`](#sma200)

***

### sma50? [#sma50]

> `optional` &#x2A;*sma50?**: `number`

#### Inherited from [#inherited-from-62]

`ScreenedStock`.[`sma50`](#sma50)

***

### smaBetween50and200? [#smabetween50and200]

> `optional` &#x2A;*smaBetween50and200?**: `number`

#### Inherited from [#inherited-from-63]

`ScreenedStock`.[`smaBetween50and200`](#smabetween50and200)

***

### startOfYearChangePercent? [#startofyearchangepercent]

> `optional` &#x2A;*startOfYearChangePercent?**: `number`

#### Inherited from [#inherited-from-64]

`ScreenedStock`.[`startOfYearChangePercent`](#startofyearchangepercent)

***

### tenYearsChangePercent? [#tenyearschangepercent]

> `optional` &#x2A;*tenYearsChangePercent?**: `number`

#### Inherited from [#inherited-from-65]

`ScreenedStock`.[`tenYearsChangePercent`](#tenyearschangepercent)

***

### threeMonthsChangePercent? [#threemonthschangepercent]

> `optional` &#x2A;*threeMonthsChangePercent?**: `number`

#### Inherited from [#inherited-from-66]

`ScreenedStock`.[`threeMonthsChangePercent`](#threemonthschangepercent)

***

### threeYearsChangePercent? [#threeyearschangepercent]

> `optional` &#x2A;*threeYearsChangePercent?**: `number`

#### Inherited from [#inherited-from-67]

`ScreenedStock`.[`threeYearsChangePercent`](#threeyearschangepercent)

***

### totalAssets? [#totalassets]

> `optional` &#x2A;*totalAssets?**: `number`

#### Inherited from [#inherited-from-68]

`ScreenedStock`.[`totalAssets`](#totalassets)

***

### totalLiabilities? [#totalliabilities]

> `optional` &#x2A;*totalLiabilities?**: `number`

#### Inherited from [#inherited-from-69]

`ScreenedStock`.[`totalLiabilities`](#totalliabilities)

***

### totalValueTraded? [#totalvaluetraded]

> `optional` &#x2A;*totalValueTraded?**: `number`

#### Inherited from [#inherited-from-70]

`ScreenedStock`.[`totalValueTraded`](#totalvaluetraded)

***

### totalVolumeTraded? [#totalvolumetraded]

> `optional` &#x2A;*totalVolumeTraded?**: `number`

#### Inherited from [#inherited-from-71]

`ScreenedStock`.[`totalVolumeTraded`](#totalvolumetraded)

***

### turnoverPerShare? [#turnoverpershare]

> `optional` &#x2A;*turnoverPerShare?**: `number`

#### Inherited from [#inherited-from-72]

`ScreenedStock`.[`turnoverPerShare`](#turnoverpershare)

***

### type [#type]

> `readonly` **type**: `string`

***

### volatility? [#volatility]

> `optional` &#x2A;*volatility?**: `number`

#### Inherited from [#inherited-from-73]

`ScreenedStock`.[`volatility`](#volatility)


# Interface: ScreenedWarrant (/avanza-ts/docs/sdk/reference/generated/interfaces/ScreenedWarrant)



## Properties [#properties]

### buyPrice [#buyprice]

> `readonly` **buyPrice**: `number` | `null`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### direction [#direction]

> `readonly` **direction**: `string`

***

### hasPosition [#hasposition]

> `readonly` **hasPosition**: `boolean`

***

### issuer [#issuer]

> `readonly` **issuer**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### oneDayChangePercent [#onedaychangepercent]

> `readonly` **oneDayChangePercent**: `number` | `null`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### sellPrice [#sellprice]

> `readonly` **sellPrice**: `number` | `null`

***

### spread [#spread]

> `readonly` **spread**: `number` | `null`

***

### subType [#subtype]

> `readonly` **subType**: `string`

***

### totalValueTraded [#totalvaluetraded]

> `readonly` **totalValueTraded**: `number`

***

### underlyingInstrument [#underlyinginstrument]

> `readonly` **underlyingInstrument**: [`UnderlyingInstrument`](./UnderlyingInstrument.md) | `null`


# Interface: SearchHit (/avanza-ts/docs/sdk/reference/generated/interfaces/SearchHit)



## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### description [#description]

> `readonly` **description**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string` | `null`

***

### fundTags [#fundtags]

> `readonly` **fundTags**: readonly `unknown`\[]

***

### highlightedDescription [#highlighteddescription]

> `readonly` **highlightedDescription**: `string`

***

### highlightedSubType [#highlightedsubtype]

> `readonly` **highlightedSubType**: `string` | `null`

***

### highlightedTitle [#highlightedtitle]

> `readonly` **highlightedTitle**: `string`

***

### marketPlaceName [#marketplacename]

> `readonly` **marketPlaceName**: `string` | `null`

***

### orderBookId [#orderbookid]

> `readonly` **orderBookId**: `string` | `null`

***

### path [#path]

> `readonly` **path**: `string` | `null`

***

### price [#price]

> `readonly` **price**: [`SearchHitPrice`](./SearchHitPrice.md) | `null`

***

### sellable [#sellable]

> `readonly` **sellable**: `boolean`

***

### stockSectors [#stocksectors]

> `readonly` **stockSectors**: readonly [`SearchHitSector`](./SearchHitSector.md)\[]

***

### subType [#subtype]

> `readonly` **subType**: `string` | `null`

***

### title [#title]

> `readonly` **title**: `string`

***

### tradeable [#tradeable]

> `readonly` **tradeable**: `boolean`

***

### type [#type]

> `readonly` **type**: `"STOCK"` | `"INDEX"` | `"FUND"` | `"EXCHANGE_TRADED_FUND"` | `"CERTIFICATE"` | `"WARRANT"` | `"TRADING_CURRENCY"` | `"BOND"` | `"PREMIUM_BOND"` | `"EQUITY_LINKED_BOND"` | `"OPTION"` | `"SUBSCRIPTION_OPTION"` | `"CONVERTIBLE"` | `"FUTURE_FORWARD"` | `"RIGHT"` | `"PAGE"` | `"FAQ"` | `"UNKNOWN"`

***

### urlSlugName [#urlslugname]

> `readonly` **urlSlugName**: `string` | `null`


# Interface: SearchHitPrice (/avanza-ts/docs/sdk/reference/generated/interfaces/SearchHitPrice)



## Properties [#properties]

### currency [#currency]

> `readonly` **currency**: `string` | `null`

***

### last [#last]

> `readonly` **last**: `string` | `null`

***

### spread [#spread]

> `readonly` **spread**: `string` | `null`

***

### threeMonthsAgoChangeDirection [#threemonthsagochangedirection]

> `readonly` **threeMonthsAgoChangeDirection**: `number`

***

### threeMonthsAgoChangePercent [#threemonthsagochangepercent]

> `readonly` **threeMonthsAgoChangePercent**: `string` | `null`

***

### todayChangeDirection [#todaychangedirection]

> `readonly` **todayChangeDirection**: `number`

***

### todayChangePercent [#todaychangepercent]

> `readonly` **todayChangePercent**: `string` | `null`

***

### todayChangeValue [#todaychangevalue]

> `readonly` **todayChangeValue**: `string` | `null`


# Interface: SearchHitSector (/avanza-ts/docs/sdk/reference/generated/interfaces/SearchHitSector)



## Properties [#properties]

### englishName [#englishname]

> `readonly` **englishName**: `string`

***

### highlightedName [#highlightedname]

> `readonly` **highlightedName**: `string` | `null`

***

### id [#id]

> `readonly` **id**: `number`

***

### level [#level]

> `readonly` **level**: `number`

***

### name [#name]

> `readonly` **name**: `string`


# Interface: SearchOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/SearchOptions)



## Properties [#properties]

### from? [#from]

> `readonly` `optional` &#x2A;*from?**: `number`

***

### size? [#size]

> `readonly` `optional` &#x2A;*size?**: `number`

***

### types? [#types]

> `readonly` `optional` &#x2A;*types?**: readonly (`"STOCK"` | `"INDEX"` | `"FUND"` | `"EXCHANGE_TRADED_FUND"` | `"CERTIFICATE"` | `"WARRANT"` | `"TRADING_CURRENCY"` | `"BOND"` | `"PREMIUM_BOND"` | `"EQUITY_LINKED_BOND"` | `"OPTION"` | `"SUBSCRIPTION_OPTION"` | `"CONVERTIBLE"` | `"FUTURE_FORWARD"` | `"RIGHT"` | `"PAGE"` | `"FAQ"`)\[]


# Interface: SearchResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/SearchResponse)



## Properties [#properties]

### facets [#facets]

> `readonly` **facets**: `object`

#### types [#types]

> `readonly` **types**: readonly `object`\[]

***

### hits [#hits]

> `readonly` **hits**: readonly [`SearchHit`](./SearchHit.md)\[]

***

### pagination [#pagination]

> `readonly` **pagination**: `object`

#### from [#from]

> `readonly` **from**: `number`

#### size [#size]

> `readonly` **size**: `number`

***

### searchFilter [#searchfilter]

> `readonly` **searchFilter**: `object`

#### types [#types-1]

> `readonly` **types**: readonly (`"STOCK"` | `"INDEX"` | `"FUND"` | `"EXCHANGE_TRADED_FUND"` | `"CERTIFICATE"` | `"WARRANT"` | `"TRADING_CURRENCY"` | `"BOND"` | `"PREMIUM_BOND"` | `"EQUITY_LINKED_BOND"` | `"OPTION"` | `"SUBSCRIPTION_OPTION"` | `"CONVERTIBLE"` | `"FUTURE_FORWARD"` | `"RIGHT"` | `"PAGE"` | `"FAQ"`)\[]

***

### searchQuery [#searchquery]

> `readonly` **searchQuery**: `string`

***

### totalNumberOfHits [#totalnumberofhits]

> `readonly` **totalNumberOfHits**: `number`


# Interface: SessionInfoResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/SessionInfoResponse)



## Properties [#properties]

### invalidSessionId [#invalidsessionid]

> `readonly` **invalidSessionId**: `string`

***

### isContextVerifiedWithBackend? [#iscontextverifiedwithbackend]

> `readonly` `optional` &#x2A;*isContextVerifiedWithBackend?**: `boolean`

***

### user [#user]

> `readonly` **user**: `object`

#### company [#company]

> `readonly` **company**: `boolean`

#### customerGroup [#customergroup]

> `readonly` **customerGroup**: `string`

#### greetingName [#greetingname]

> `readonly` **greetingName**: `string`

#### id [#id]

> `readonly` **id**: `string`

#### loggedIn [#loggedin]

> `readonly` **loggedIn**: `boolean`

#### minor [#minor]

> `readonly` **minor**: `boolean`

#### pushBaseUrl [#pushbaseurl]

> `readonly` **pushBaseUrl**: `string`

#### pushSubscriptionId [#pushsubscriptionid]

> `readonly` **pushSubscriptionId**: `string`

#### securityToken [#securitytoken]

> `readonly` **securityToken**: `string`

#### start [#start]

> `readonly` **start**: `boolean`


# Interface: ShortSellingPoint (/avanza-ts/docs/sdk/reference/generated/interfaces/ShortSellingPoint)



## Properties [#properties]

### ratio [#ratio]

> `readonly` **ratio**: `number`

***

### timestamp [#timestamp]

> `readonly` **timestamp**: `number`


# Interface: ShortSellingResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/ShortSellingResponse)



## Properties [#properties]

### shortSellingHistory [#shortsellinghistory]

> `readonly` **shortSellingHistory**: readonly [`ShortSellingPoint`](./ShortSellingPoint.md)\[]


# Interface: StartBankIdOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/StartBankIdOptions)



## Properties [#properties]

### signal? [#signal]

> `readonly` `optional` &#x2A;*signal?**: `AbortSignal`


# Interface: StockAnalysis (/avanza-ts/docs/sdk/reference/generated/interfaces/StockAnalysis)



`ByQuarterTTM` series are trailing twelve months; `ByQuarterQuarter`
series cover the single quarter.

## Properties [#properties]

### companyFinancialsByQuarter [#companyfinancialsbyquarter]

> `readonly` **companyFinancialsByQuarter**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyFinancialsByQuarterQuarter [#companyfinancialsbyquarterquarter]

> `readonly` **companyFinancialsByQuarterQuarter**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyFinancialsByQuarterTTM [#companyfinancialsbyquarterttm]

> `readonly` **companyFinancialsByQuarterTTM**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyFinancialsByYear [#companyfinancialsbyyear]

> `readonly` **companyFinancialsByYear**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyKeyRatiosByQuarter [#companykeyratiosbyquarter]

> `readonly` **companyKeyRatiosByQuarter**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyKeyRatiosByQuarterQuarter [#companykeyratiosbyquarterquarter]

> `readonly` **companyKeyRatiosByQuarterQuarter**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyKeyRatiosByQuarterTTM [#companykeyratiosbyquarterttm]

> `readonly` **companyKeyRatiosByQuarterTTM**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### companyKeyRatiosByYear [#companykeyratiosbyyear]

> `readonly` **companyKeyRatiosByYear**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### dividendsByYear [#dividendsbyyear]

> `readonly` **dividendsByYear**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### keyRatiosByQuarter [#keyratiosbyquarter]

> `readonly` **keyRatiosByQuarter**: [`AnalysisSummary`](../type-aliases/AnalysisSummary.md)

***

### keyRatiosByQuarterQuarter [#keyratiosbyquarterquarter]

> `readonly` **keyRatiosByQuarterQuarter**: [`AnalysisSummary`](../type-aliases/AnalysisSummary.md)

***

### keyRatiosByQuarterTTM [#keyratiosbyquarterttm]

> `readonly` **keyRatiosByQuarterTTM**: [`AnalysisSummary`](../type-aliases/AnalysisSummary.md)

***

### keyRatiosByYear [#keyratiosbyyear]

> `readonly` **keyRatiosByYear**: [`AnalysisSummary`](../type-aliases/AnalysisSummary.md)

***

### stockKeyRatiosByQuarter [#stockkeyratiosbyquarter]

> `readonly` **stockKeyRatiosByQuarter**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### stockKeyRatiosByQuarterQuarter [#stockkeyratiosbyquarterquarter]

> `readonly` **stockKeyRatiosByQuarterQuarter**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### stockKeyRatiosByQuarterTTM [#stockkeyratiosbyquarterttm]

> `readonly` **stockKeyRatiosByQuarterTTM**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)

***

### stockKeyRatiosByYear [#stockkeyratiosbyyear]

> `readonly` **stockKeyRatiosByYear**: [`AnalysisSeries`](../type-aliases/AnalysisSeries.md)


# Interface: StockFilter (/avanza-ts/docs/sdk/reference/generated/interfaces/StockFilter)



## Indexable [#indexable]

> \[`key`: `string`]: `unknown`

## Properties [#properties]

### countryCodes? [#countrycodes]

> `readonly` `optional` &#x2A;*countryCodes?**: readonly `string`\[]

***

### marketCapitalization? [#marketcapitalization]

> `readonly` `optional` &#x2A;*marketCapitalization?**: [`StockFilterRange`](./StockFilterRange.md)

***

### marketPlaceCodes? [#marketplacecodes]

> `readonly` `optional` &#x2A;*marketPlaceCodes?**: readonly `string`\[]

***

### marketPlaces? [#marketplaces]

> `readonly` `optional` &#x2A;*marketPlaces?**: readonly `string`\[]

***

### nameQuery? [#namequery]

> `readonly` `optional` &#x2A;*nameQuery?**: `string`

***

### numberOfOwners? [#numberofowners]

> `readonly` `optional` &#x2A;*numberOfOwners?**: [`StockFilterRange`](./StockFilterRange.md)

***

### onlyDirectYield? [#onlydirectyield]

> `readonly` `optional` &#x2A;*onlyDirectYield?**: `boolean`

***

### onlyHasAnalysis? [#onlyhasanalysis]

> `readonly` `optional` &#x2A;*onlyHasAnalysis?**: `boolean`

***

### onlySuperloanApproved? [#onlysuperloanapproved]

> `readonly` `optional` &#x2A;*onlySuperloanApproved?**: `boolean`

***

### priceEarningsRatio? [#priceearningsratio]

> `readonly` `optional` &#x2A;*priceEarningsRatio?**: [`StockFilterRange`](./StockFilterRange.md)

***

### sectors? [#sectors]

> `readonly` `optional` &#x2A;*sectors?**: readonly `string`\[]


# Interface: StockFilterOption (/avanza-ts/docs/sdk/reference/generated/interfaces/StockFilterOption)



## Properties [#properties]

### children? [#children]

> `readonly` `optional` &#x2A;*children?**: readonly `StockFilterOption`\[]

***

### displayName [#displayname]

> `readonly` **displayName**: `string`

***

### numberOfOrderbooks [#numberoforderbooks]

> `readonly` **numberOfOrderbooks**: `string`

***

### value [#value]

> `readonly` **value**: `string`


# Interface: StockFilterOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/StockFilterOptions)



## Properties [#properties]

### countryCodes [#countrycodes]

> `readonly` **countryCodes**: readonly [`StockFilterOption`](./StockFilterOption.md)\[]

***

### marketPlaces [#marketplaces]

> `readonly` **marketPlaces**: readonly [`StockFilterOption`](./StockFilterOption.md)\[]

***

### sectors [#sectors]

> `readonly` **sectors**: readonly [`StockFilterOption`](./StockFilterOption.md)\[]


# Interface: StockFilterRange (/avanza-ts/docs/sdk/reference/generated/interfaces/StockFilterRange)



## Indexable [#indexable]

> \[`key`: `string`]: `unknown`

## Properties [#properties]

### maxValue? [#maxvalue]

> `readonly` `optional` &#x2A;*maxValue?**: `number`

***

### minValue? [#minvalue]

> `readonly` `optional` &#x2A;*minValue?**: `number`


# Interface: StockInfo (/avanza-ts/docs/sdk/reference/generated/interfaces/StockInfo)



## Properties [#properties]

### historicalClosingPrices [#historicalclosingprices]

> `readonly` **historicalClosingPrices**: [`HistoricalClosingPrices`](../type-aliases/HistoricalClosingPrices.md)

***

### instrumentId [#instrumentid]

> `readonly` **instrumentId**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### keyIndicators [#keyindicators]

> `readonly` **keyIndicators**: `object`

#### beta? [#beta]

> `readonly` `optional` &#x2A;*beta?**: `number`

#### capitalTurnover? [#capitalturnover]

> `readonly` `optional` &#x2A;*capitalTurnover?**: `number`

#### directYield? [#directyield]

> `readonly` `optional` &#x2A;*directYield?**: `number`

#### dividend? [#dividend]

> `readonly` `optional` &#x2A;*dividend?**: `object`

##### dividend.amount [#dividendamount]

> `readonly` **amount**: `number`

##### dividend.currencyCode [#dividendcurrencycode]

> `readonly` **currencyCode**: `string`

##### dividend.exDate [#dividendexdate]

> `readonly` **exDate**: `string`

##### dividend.exDateStatus [#dividendexdatestatus]

> `readonly` **exDateStatus**: `string`

##### dividend.paymentDate? [#dividendpaymentdate]

> `readonly` `optional` &#x2A;*paymentDate?**: `string`

#### dividendsPerYear? [#dividendsperyear]

> `readonly` `optional` &#x2A;*dividendsPerYear?**: `number`

#### earningsPerShare? [#earningspershare]

> `readonly` `optional` &#x2A;*earningsPerShare?**: [`MoneyAmount`](./MoneyAmount.md)

#### equityPerShare? [#equitypershare]

> `readonly` `optional` &#x2A;*equityPerShare?**: [`MoneyAmount`](./MoneyAmount.md)

#### equityRatio? [#equityratio]

> `readonly` `optional` &#x2A;*equityRatio?**: `number`

#### evEbitRatio? [#evebitratio]

> `readonly` `optional` &#x2A;*evEbitRatio?**: `number`

#### grossMargin? [#grossmargin]

> `readonly` `optional` &#x2A;*grossMargin?**: `number`

#### interestCoverageRatio? [#interestcoverageratio]

> `readonly` `optional` &#x2A;*interestCoverageRatio?**: `number`

#### marketCapital? [#marketcapital]

> `readonly` `optional` &#x2A;*marketCapital?**: [`MoneyAmount`](./MoneyAmount.md)

#### netMargin? [#netmargin]

> `readonly` `optional` &#x2A;*netMargin?**: `number`

#### nextReport? [#nextreport]

> `readonly` `optional` &#x2A;*nextReport?**: [`CompanyReport`](./CompanyReport.md)

#### numberOfOwners [#numberofowners]

> `readonly` **numberOfOwners**: `number`

#### operatingCashFlow? [#operatingcashflow]

> `readonly` `optional` &#x2A;*operatingCashFlow?**: [`MoneyAmount`](./MoneyAmount.md)

#### operatingProfitMargin? [#operatingprofitmargin]

> `readonly` `optional` &#x2A;*operatingProfitMargin?**: `number`

#### ordinaryDirectYield? [#ordinarydirectyield]

> `readonly` `optional` &#x2A;*ordinaryDirectYield?**: `number`

#### previousReport? [#previousreport]

> `readonly` `optional` &#x2A;*previousReport?**: [`CompanyReport`](./CompanyReport.md)

#### priceBookRatio? [#pricebookratio]

> `readonly` `optional` &#x2A;*priceBookRatio?**: `number`

#### priceEarningsRatio? [#priceearningsratio]

> `readonly` `optional` &#x2A;*priceEarningsRatio?**: `number`

#### priceSalesRatio? [#pricesalesratio]

> `readonly` `optional` &#x2A;*priceSalesRatio?**: `number`

#### reportDate [#reportdate]

> `readonly` **reportDate**: `string`

#### returnOnCapitalEmployed? [#returnoncapitalemployed]

> `readonly` `optional` &#x2A;*returnOnCapitalEmployed?**: `number`

#### returnOnEquity? [#returnonequity]

> `readonly` `optional` &#x2A;*returnOnEquity?**: `number`

#### returnOnTotalAssets? [#returnontotalassets]

> `readonly` `optional` &#x2A;*returnOnTotalAssets?**: `number`

#### shortSellingRatio? [#shortsellingratio]

> `readonly` `optional` &#x2A;*shortSellingRatio?**: `number`

#### totalDirectYield? [#totaldirectyield]

> `readonly` `optional` &#x2A;*totalDirectYield?**: `number`

#### turnoverPerShare? [#turnoverpershare]

> `readonly` `optional` &#x2A;*turnoverPerShare?**: [`MoneyAmount`](./MoneyAmount.md)

#### volatility? [#volatility]

> `readonly` `optional` &#x2A;*volatility?**: `number`

***

### listing [#listing]

> `readonly` **listing**: [`Listing`](./Listing.md) & `object`

#### Type Declaration [#type-declaration]

##### marketListName? [#marketlistname]

> `readonly` `optional` &#x2A;*marketListName?**: `string`

***

### marketPlace [#marketplace]

> `readonly` **marketPlace**: [`MarketplaceStatus`](./MarketplaceStatus.md)

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### quote [#quote]

> `readonly` **quote**: [`StockQuote`](./StockQuote.md)

***

### sectors [#sectors]

> `readonly` **sectors**: readonly `object`\[]

***

### tradable [#tradable]

> `readonly` **tradable**: `string`

***

### type [#type]

> `readonly` **type**: `string`


# Interface: StockQuote (/avanza-ts/docs/sdk/reference/generated/interfaces/StockQuote)



## Properties [#properties]

### buy [#buy]

> `readonly` **buy**: `number` | `null`

***

### change [#change]

> `readonly` **change**: `number` | `null`

***

### changePercent [#changepercent]

> `readonly` **changePercent**: `number` | `null`

***

### highest [#highest]

> `readonly` **highest**: `number` | `null`

***

### isRealTime [#isrealtime]

> `readonly` **isRealTime**: `boolean`

***

### last [#last]

> `readonly` **last**: `number` | `null`

***

### lowest [#lowest]

> `readonly` **lowest**: `number` | `null`

***

### sell [#sell]

> `readonly` **sell**: `number` | `null`

***

### spread [#spread]

> `readonly` **spread**: `number` | `null`

***

### timeOfLast [#timeoflast]

> `readonly` **timeOfLast**: `number` | `null`

***

### totalValueTraded [#totalvaluetraded]

> `readonly` **totalValueTraded**: `number` | `null`

***

### totalVolumeTraded [#totalvolumetraded]

> `readonly` **totalVolumeTraded**: `number` | `null`

***

### updated [#updated]

> `readonly` **updated**: `number`

***

### volumeWeightedAveragePrice [#volumeweightedaverageprice]

> `readonly` **volumeWeightedAveragePrice**: `number` | `null`


# Interface: StockScreenerMetadataResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/StockScreenerMetadataResponse)



## Properties [#properties]

### metadata [#metadata]

> `readonly` **metadata**: `Readonly`\<`Record`\<`string`, `unknown`>>


# Interface: StockScreenerTab (/avanza-ts/docs/sdk/reference/generated/interfaces/StockScreenerTab)



## Properties [#properties]

### columns [#columns]

> `readonly` **columns**: readonly `string`\[]

***

### name [#name]

> `readonly` **name**: `string`


# Interface: StockScreenerTabsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/StockScreenerTabsResponse)



## Properties [#properties]

### tabs [#tabs]

> `readonly` **tabs**: readonly [`StockScreenerTab`](./StockScreenerTab.md)\[]


# Interface: StockSector (/avanza-ts/docs/sdk/reference/generated/interfaces/StockSector)



## Extended by [#extended-by]

* [`PopularStockSector`](./PopularStockSector.md)

## Properties [#properties]

### sectorId [#sectorid]

> `readonly` **sectorId**: `string`

***

### sectorName [#sectorname]

> `readonly` **sectorName**: `string`


# Interface: StockSectorGroup (/avanza-ts/docs/sdk/reference/generated/interfaces/StockSectorGroup)



## Properties [#properties]

### children [#children]

> `readonly` **children**: readonly [`StockSector`](./StockSector.md)\[]

***

### sector [#sector]

> `readonly` **sector**: [`StockSector`](./StockSector.md)


# Interface: StockSort (/avanza-ts/docs/sdk/reference/generated/interfaces/StockSort)



## Properties [#properties]

### field [#field]

> `readonly` **field**: `string`

***

### order [#order]

> `readonly` **order**: `"asc"` | `"desc"`


# Interface: StopLoss (/avanza-ts/docs/sdk/reference/generated/interfaces/StopLoss)



Field names follow the web app's stop-loss model; no captured response
contained a stop-loss yet.

## Properties [#properties]

### account [#account]

> `readonly` **account**: `object` & `Readonly`\<`Record`\<`string`, `unknown`>>

#### Type Declaration [#type-declaration]

##### id? [#id]

> `readonly` `optional` &#x2A;*id?**: `string`

##### urlParameterId? [#urlparameterid]

> `readonly` `optional` &#x2A;*urlParameterId?**: `string`

***

### deletable [#deletable]

> `readonly` **deletable**: `boolean`

***

### editable [#editable]

> `readonly` **editable**: `boolean`

***

### id [#id-1]

> `readonly` **id**: `string`

***

### message? [#message]

> `readonly` `optional` &#x2A;*message?**: `string` | `null`

***

### order? [#order]

> `readonly` `optional` &#x2A;*order?**: \{ `price`: `number`; `priceType`: `string`; `shortSellingAllowed?`: `boolean`; `type`: `string`; `validDays?`: `number` | `null`; `volume`: `number`; } | `null`

#### Union Members [#union-members]

##### Type Literal [#type-literal]

\{ `price`: `number`; `priceType`: `string`; `shortSellingAllowed?`: `boolean`; `type`: `string`; `validDays?`: `number` | `null`; `volume`: `number`; }

##### price [#price]

> `readonly` **price**: `number`

##### priceType [#pricetype]

> `readonly` **priceType**: `string`

`MONETARY` or `PERCENTAGE`.

##### shortSellingAllowed? [#shortsellingallowed]

> `readonly` `optional` &#x2A;*shortSellingAllowed?**: `boolean`

##### type [#type]

> `readonly` **type**: `string`

##### validDays? [#validdays]

> `readonly` `optional` &#x2A;*validDays?**: `number` | `null`

##### volume [#volume]

> `readonly` **volume**: `number`

***

`null`

***

### orderbook? [#orderbook]

> `readonly` `optional` &#x2A;*orderbook?**: `object` & `Readonly`\<`Record`\<`string`, `unknown`>>

#### Type Declaration [#type-declaration-1]

##### currency? [#currency]

> `readonly` `optional` &#x2A;*currency?**: `string`

##### id? [#id-2]

> `readonly` `optional` &#x2A;*id?**: `string`

##### name? [#name]

> `readonly` `optional` &#x2A;*name?**: `string`

***

### status [#status]

> `readonly` **status**: `string` | `null`

***

### trigger? [#trigger]

> `readonly` `optional` &#x2A;*trigger?**: \{ `extremePrice?`: `number` | `null`; `triggerOnMarketMakerQuote?`: `boolean`; `type`: `string`; `validDays?`: `number` | `null`; `validUntil?`: `string` | `null`; `value`: `number`; `valueType`: `string`; } | `null`

#### Union Members [#union-members-1]

##### Type Literal [#type-literal-1]

\{ `extremePrice?`: `number` | `null`; `triggerOnMarketMakerQuote?`: `boolean`; `type`: `string`; `validDays?`: `number` | `null`; `validUntil?`: `string` | `null`; `value`: `number`; `valueType`: `string`; }

##### extremePrice? [#extremeprice]

> `readonly` `optional` &#x2A;*extremePrice?**: `number` | `null`

##### triggerOnMarketMakerQuote? [#triggeronmarketmakerquote]

> `readonly` `optional` &#x2A;*triggerOnMarketMakerQuote?**: `boolean`

##### type [#type-1]

> `readonly` **type**: `string`

##### validDays? [#validdays-1]

> `readonly` `optional` &#x2A;*validDays?**: `number` | `null`

##### validUntil? [#validuntil]

> `readonly` `optional` &#x2A;*validUntil?**: `string` | `null`

##### value [#value]

> `readonly` **value**: `number`

##### valueType [#valuetype]

> `readonly` **valueType**: `string`

`MONETARY` or `PERCENTAGE`.

***

`null`


# Interface: StopLossOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/StopLossOptions)



## Properties [#properties]

### accountId? [#accountid]

> `readonly` `optional` &#x2A;*accountId?**: `string`

***

### orderbookId? [#orderbookid]

> `readonly` `optional` &#x2A;*orderbookId?**: `string`


# Interface: ThemeStocksResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/ThemeStocksResponse)



## Properties [#properties]

### sortBy [#sortby]

> `readonly` **sortBy**: [`StockSort`](./StockSort.md)

***

### stocks [#stocks]

> `readonly` **stocks**: readonly [`ScreenedStock`](./ScreenedStock.md)\[]


# Interface: TotalValue (/avanza-ts/docs/sdk/reference/generated/interfaces/TotalValue)



## Properties [#properties]

### accruedCreditInterest [#accruedcreditinterest]

> `readonly` **accruedCreditInterest**: [`AccountAmount`](./AccountAmount.md)

***

### accruedDebitInterest [#accrueddebitinterest]

> `readonly` **accruedDebitInterest**: [`AccountAmount`](./AccountAmount.md)

***

### accruedInterest [#accruedinterest]

> `readonly` **accruedInterest**: [`AccountAmount`](./AccountAmount.md)

***

### balanceOnSavingsAccounts [#balanceonsavingsaccounts]

> `readonly` **balanceOnSavingsAccounts**: [`AccountAmount`](./AccountAmount.md)

***

### balanceOnTradingAccounts [#balanceontradingaccounts]

> `readonly` **balanceOnTradingAccounts**: [`AccountAmount`](./AccountAmount.md)

***

### currencyBalances [#currencybalances]

> `readonly` **currencyBalances**: readonly [`CurrencyBalance`](./CurrencyBalance.md)\[]

***

### forwardBalance [#forwardbalance]

> `readonly` **forwardBalance**: [`AccountAmount`](./AccountAmount.md)

***

### positionValue [#positionvalue]

> `readonly` **positionValue**: [`AccountAmount`](./AccountAmount.md)

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: [`AccountAmount`](./AccountAmount.md)


# Interface: TotalValuesAccount (/avanza-ts/docs/sdk/reference/generated/interfaces/TotalValuesAccount)



## Properties [#properties]

### buyingPower [#buyingpower]

> `readonly` **buyingPower**: [`BuyingPower`](./BuyingPower.md)

***

### info [#info]

> `readonly` **info**: `object`

#### discretionaryPortfolio [#discretionaryportfolio]

> `readonly` **discretionaryPortfolio**: `boolean`

#### hasCredit [#hascredit]

> `readonly` **hasCredit**: `boolean`

#### id [#id]

> `readonly` **id**: `string`

#### name [#name]

> `readonly` **name**: `string`

#### type [#type]

> `readonly` **type**: `string`

#### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`

***

### isTradable [#istradable]

> `readonly` **isTradable**: `boolean`

***

### overdrawn [#overdrawn]

> `readonly` **overdrawn**: readonly `object`\[]

***

### overmortgaged [#overmortgaged]

> `readonly` **overmortgaged**: `object` | `null`

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: [`TotalValue`](./TotalValue.md)


# Interface: TotalValuesResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/TotalValuesResponse)



## Properties [#properties]

### accounts [#accounts]

> `readonly` **accounts**: readonly [`TotalValuesAccount`](./TotalValuesAccount.md)\[]

***

### buyingPower [#buyingpower]

> `readonly` **buyingPower**: [`BuyingPower`](./BuyingPower.md)

***

### hasCredit [#hascredit]

> `readonly` **hasCredit**: `boolean`

***

### totalDevelopment [#totaldevelopment]

> `readonly` **totalDevelopment**: `Readonly`\<`Partial`\<`Record`\<[`PerformancePeriod`](../type-aliases/PerformancePeriod.md), [`PerformanceDevelopment`](./PerformanceDevelopment.md)>>>

***

### totalValue [#totalvalue]

> `readonly` **totalValue**: [`TotalValue`](./TotalValue.md)


# Interface: TotpCodeLoginOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/TotpCodeLoginOptions)



## Extends [#extends]

* `TotpLoginBase`

## Properties [#properties]

### maxInactiveMinutes? [#maxinactiveminutes]

> `readonly` `optional` &#x2A;*maxInactiveMinutes?**: `number`

#### Inherited from [#inherited-from]

`TotpLoginBase.maxInactiveMinutes`

***

### password [#password]

> `readonly` **password**: `string`

#### Inherited from [#inherited-from-1]

`TotpLoginBase.password`

***

### retryWithNextCode? [#retrywithnextcode]

> `readonly` `optional` &#x2A;*retryWithNextCode?**: `boolean`

#### Inherited from [#inherited-from-2]

`TotpLoginBase.retryWithNextCode`

***

### signal? [#signal]

> `readonly` `optional` &#x2A;*signal?**: `AbortSignal`

#### Inherited from [#inherited-from-3]

`TotpLoginBase.signal`

***

### totpCode [#totpcode]

> `readonly` **totpCode**: `string`

***

### totpSecret? [#totpsecret]

> `readonly` `optional` &#x2A;*totpSecret?**: `undefined`

***

### username [#username]

> `readonly` **username**: `string`

#### Inherited from [#inherited-from-4]

`TotpLoginBase.username`


# Interface: TotpSecretLoginOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/TotpSecretLoginOptions)



## Extends [#extends]

* `TotpLoginBase`

## Properties [#properties]

### maxInactiveMinutes? [#maxinactiveminutes]

> `readonly` `optional` &#x2A;*maxInactiveMinutes?**: `number`

#### Inherited from [#inherited-from]

`TotpLoginBase.maxInactiveMinutes`

***

### password [#password]

> `readonly` **password**: `string`

#### Inherited from [#inherited-from-1]

`TotpLoginBase.password`

***

### retryWithNextCode? [#retrywithnextcode]

> `readonly` `optional` &#x2A;*retryWithNextCode?**: `boolean`

#### Inherited from [#inherited-from-2]

`TotpLoginBase.retryWithNextCode`

***

### signal? [#signal]

> `readonly` `optional` &#x2A;*signal?**: `AbortSignal`

#### Inherited from [#inherited-from-3]

`TotpLoginBase.signal`

***

### totpCode? [#totpcode]

> `readonly` `optional` &#x2A;*totpCode?**: `undefined`

***

### totpSecret [#totpsecret]

> `readonly` **totpSecret**: `string`

***

### username [#username]

> `readonly` **username**: `string`

#### Inherited from [#inherited-from-4]

`TotpLoginBase.username`


# Interface: TotpSession (/avanza-ts/docs/sdk/reference/generated/interfaces/TotpSession)



## Properties [#properties]

### authenticationSession [#authenticationsession]

> `readonly` **authenticationSession**: `string`

***

### cookies? [#cookies]

> `readonly` `optional` &#x2A;*cookies?**: readonly [`AvanzaCookie`](./AvanzaCookie.md)\[]

***

### customerId? [#customerid]

> `readonly` `optional` &#x2A;*customerId?**: `string`

***

### mode [#mode]

> `readonly` **mode**: `"totp"`

***

### pushSubscriptionId? [#pushsubscriptionid]

> `readonly` `optional` &#x2A;*pushSubscriptionId?**: `string`

***

### securityToken [#securitytoken]

> `readonly` **securityToken**: `string`


# Interface: TradingAccount (/avanza-ts/docs/sdk/reference/generated/interfaces/TradingAccount)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### accountType [#accounttype]

> `readonly` **accountType**: `string`

***

### accountTypeName [#accounttypename]

> `readonly` **accountTypeName**: `string`

***

### availableCredit [#availablecredit]

> `readonly` **availableCredit**: `number`

***

### availableForPurchase [#availableforpurchase]

> `readonly` **availableForPurchase**: `number`

***

### availableForPurchaseWithoutCredit [#availableforpurchasewithoutcredit]

> `readonly` **availableForPurchaseWithoutCredit**: `number`

***

### currencyBalances [#currencybalances]

> `readonly` **currencyBalances**: readonly `object`\[]

***

### hasCredit [#hascredit]

> `readonly` **hasCredit**: `boolean`

***

### isDiscretionaryAccount [#isdiscretionaryaccount]

> `readonly` **isDiscretionaryAccount**: `boolean`

***

### isHidden [#ishidden]

> `readonly` **isHidden**: `boolean`

***

### isOverdrawn [#isoverdrawn]

> `readonly` **isOverdrawn**: `boolean`

***

### isOvermortgaged [#isovermortgaged]

> `readonly` **isOvermortgaged**: `boolean`

***

### isShortSellable [#isshortsellable]

> `readonly` **isShortSellable**: `boolean`

***

### isTradable [#istradable]

> `readonly` **isTradable**: `boolean`

***

### name [#name]

> `readonly` **name**: `string`

***

### positions [#positions]

> `readonly` **positions**: readonly [`TradingPosition`](./TradingPosition.md)\[]

***

### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`


# Interface: TradingOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/TradingOrderbook)



## Properties [#properties]

### collateralValue [#collateralvalue]

> `readonly` **collateralValue**: `number`

***

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### featureSupport [#featuresupport]

> `readonly` **featureSupport**: `Readonly`\<`Record`\<`string`, `boolean`>>

***

### id [#id]

> `readonly` **id**: `string`

***

### instrumentId [#instrumentid]

> `readonly` **instrumentId**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### marketPlace [#marketplace]

> `readonly` **marketPlace**: `string`

***

### maxValidUntil [#maxvaliduntil]

> `readonly` **maxValidUntil**: `string`

***

### minValidUntil [#minvaliduntil]

> `readonly` **minValidUntil**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### priceType [#pricetype]

> `readonly` **priceType**: `string`

***

### tickerSymbol [#tickersymbol]

> `readonly` **tickerSymbol**: `string`

***

### tickSizeList [#ticksizelist]

> `readonly` **tickSizeList**: `object`

#### tickSizeEntries [#ticksizeentries]

> `readonly` **tickSizeEntries**: readonly `object`\[]

***

### tradingUnit [#tradingunit]

> `readonly` **tradingUnit**: `number`

***

### volumeFactor [#volumefactor]

> `readonly` **volumeFactor**: `number`


# Interface: TradingPosition (/avanza-ts/docs/sdk/reference/generated/interfaces/TradingPosition)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### marketValue [#marketvalue]

> `readonly` **marketValue**: `number`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`

***

### price [#price]

> `readonly` **price**: `number`

***

### volume [#volume]

> `readonly` **volume**: `number`


# Interface: Transaction (/avanza-ts/docs/sdk/reference/generated/interfaces/Transaction)



## Properties [#properties]

### account [#account]

> `readonly` **account**: `object`

#### id [#id]

> `readonly` **id**: `string`

#### name [#name]

> `readonly` **name**: `string`

#### type [#type]

> `readonly` **type**: `string`

#### urlParameterId [#urlparameterid]

> `readonly` **urlParameterId**: `string`

***

### amount [#amount]

> `readonly` **amount**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### availabilityDate [#availabilitydate]

> `readonly` **availabilityDate**: `string` | `null`

***

### backofficeType [#backofficetype]

> `readonly` **backofficeType**: `string`

***

### backofficeTypeText [#backofficetypetext]

> `readonly` **backofficeTypeText**: `string`

***

### cancelDate [#canceldate]

> `readonly` **cancelDate**: `string` | `null`

***

### cancelled [#cancelled]

> `readonly` **cancelled**: `boolean`

***

### commission [#commission]

> `readonly` **commission**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### currencyRate [#currencyrate]

> `readonly` **currencyRate**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### date [#date]

> `readonly` **date**: `string`

***

### description [#description]

> `readonly` **description**: `string`

***

### foreignTaxRate [#foreigntaxrate]

> `readonly` **foreignTaxRate**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### id [#id-1]

> `readonly` **id**: `string`

***

### instrumentName [#instrumentname]

> `readonly` **instrumentName**: `string` | `null`

***

### intraday [#intraday]

> `readonly` **intraday**: `boolean`

***

### isin [#isin]

> `readonly` **isin**: `string` | `null`

***

### noteId [#noteid]

> `readonly` **noteId**: `string` | `null`

***

### onCreditAccount [#oncreditaccount]

> `readonly` **onCreditAccount**: `boolean`

***

### orderbook [#orderbook]

> `readonly` **orderbook**: [`TransactionOrderbook`](./TransactionOrderbook.md) | `null`

***

### priceInTradedCurrency [#priceintradedcurrency]

> `readonly` **priceInTradedCurrency**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### priceInTransactionCurrency [#priceintransactioncurrency]

> `readonly` **priceInTransactionCurrency**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### result [#result]

> `readonly` **result**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### settlementDate [#settlementdate]

> `readonly` **settlementDate**: `string`

***

### tradeDate [#tradedate]

> `readonly` **tradeDate**: `string` | `null`

***

### type [#type-1]

> `readonly` **type**: `string`

***

### verificationNumber [#verificationnumber]

> `readonly` **verificationNumber**: `string`

***

### volume [#volume]

> `readonly` **volume**: [`AccountAmount`](./AccountAmount.md) | `null`

***

### volumeFactor [#volumefactor]

> `readonly` **volumeFactor**: `number` | `null`


# Interface: TransactionListFilter (/avanza-ts/docs/sdk/reference/generated/interfaces/TransactionListFilter)



## Properties [#properties]

### accountIds? [#accountids]

> `readonly` `optional` &#x2A;*accountIds?**: readonly `string`\[]

***

### from? [#from]

> `readonly` `optional` &#x2A;*from?**: `string`

`yyyy-MM-dd`; the API defaults to one year before `to`.

***

### includeCancelled? [#includecancelled]

> `readonly` `optional` &#x2A;*includeCancelled?**: `boolean`

***

### includeClosedAccounts? [#includeclosedaccounts]

> `readonly` `optional` &#x2A;*includeClosedAccounts?**: `boolean`

***

### isin? [#isin]

> `readonly` `optional` &#x2A;*isin?**: `string`

***

### to? [#to]

> `readonly` `optional` &#x2A;*to?**: `string`

`yyyy-MM-dd`; the API defaults to today.

***

### transactionTypes? [#transactiontypes]

> `readonly` `optional` &#x2A;*transactionTypes?**: readonly `string`\[]

For example `BUY`, `SELL`, `DIVIDEND`, `DEPOSIT`, or `WITHDRAW`.


# Interface: TransactionListResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/TransactionListResponse)



## Properties [#properties]

### firstTransactionDate [#firsttransactiondate]

> `readonly` **firstTransactionDate**: `string`

***

### transactions [#transactions]

> `readonly` **transactions**: readonly [`Transaction`](./Transaction.md)\[]

***

### transactionsAfterFiltering [#transactionsafterfiltering]

> `readonly` **transactionsAfterFiltering**: `number`

***

### transactionsFilter [#transactionsfilter]

> `readonly` **transactionsFilter**: `object`

#### accountIds [#accountids]

> `readonly` **accountIds**: readonly `string`\[] | `null`

#### dateRange [#daterange]

> `readonly` **dateRange**: `object`

##### dateRange.from [#daterangefrom]

> `readonly` **from**: `string`

##### dateRange.to [#daterangeto]

> `readonly` **to**: `string`

#### includeCancelled [#includecancelled]

> `readonly` **includeCancelled**: `boolean`

#### includeClosedAccounts [#includeclosedaccounts]

> `readonly` **includeClosedAccounts**: `boolean`

#### isin [#isin]

> `readonly` **isin**: `string` | `null`

#### transactionTypes [#transactiontypes]

> `readonly` **transactionTypes**: readonly `string`\[] | `null`


# Interface: TransactionOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/TransactionOrderbook)



## Properties [#properties]

### currency [#currency]

> `readonly` **currency**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string` | `null`

***

### id [#id]

> `readonly` **id**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### marketplace [#marketplace]

> `readonly` **marketplace**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### type [#type]

> `readonly` **type**: `string`

***

### volumeFactor [#volumefactor]

> `readonly` **volumeFactor**: `number`


# Interface: TransactionsClient (/avanza-ts/docs/sdk/reference/generated/interfaces/TransactionsClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`

## Methods [#methods]

### dividends() [#dividends]

> **dividends**(`options?`, `signal?`): `Promise`\<[`DividendsResponse`](../type-aliases/DividendsResponse.md)>

#### Parameters [#parameters]

##### options? [#options]

[`DividendOptions`](./DividendOptions.md) = `{}`

##### signal? [#signal]

`AbortSignal`

#### Returns [#returns]

`Promise`\<[`DividendsResponse`](../type-aliases/DividendsResponse.md)>

***

### list() [#list]

> **list**(`filter?`, `signal?`): `Promise`\<[`TransactionListResponse`](./TransactionListResponse.md)>

#### Parameters [#parameters-1]

##### filter? [#filter]

[`TransactionListFilter`](./TransactionListFilter.md) = `{}`

##### signal? [#signal-1]

`AbortSignal`

#### Returns [#returns-1]

`Promise`\<[`TransactionListResponse`](./TransactionListResponse.md)>

***

### pending() [#pending]

> **pending**(`signal?`): `Promise`\<[`PendingTransactionsResponse`](./PendingTransactionsResponse.md)>

#### Parameters [#parameters-2]

##### signal? [#signal-2]

`AbortSignal`

#### Returns [#returns-2]

`Promise`\<[`PendingTransactionsResponse`](./PendingTransactionsResponse.md)>

***

### transaction() [#transaction]

> **transaction**(`accountId`, `transactionId`, `signal?`): `Promise`\<[`Transaction`](./Transaction.md)>

`accountId` is an account ID or URL parameter ID.

#### Parameters [#parameters-3]

##### accountId [#accountid]

`string`

##### transactionId [#transactionid]

`string`

##### signal? [#signal-3]

`AbortSignal`

#### Returns [#returns-3]

`Promise`\<[`Transaction`](./Transaction.md)>

***

### upcomingDividends() [#upcomingdividends]

> **upcomingDividends**(`accountId?`, `signal?`): `Promise`\<[`UpcomingDividendsResponse`](../type-aliases/UpcomingDividendsResponse.md)>

Upcoming dividends for held positions, optionally for one account URL parameter ID.

#### Parameters [#parameters-4]

##### accountId? [#accountid-1]

`string`

##### signal? [#signal-4]

`AbortSignal`

#### Returns [#returns-4]

`Promise`\<[`UpcomingDividendsResponse`](../type-aliases/UpcomingDividendsResponse.md)>


# Interface: UnderlyingInstrument (/avanza-ts/docs/sdk/reference/generated/interfaces/UnderlyingInstrument)



## Properties [#properties]

### countryCode [#countrycode]

> `readonly` **countryCode**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookId [#orderbookid]

> `readonly` **orderbookId**: `string`


# Interface: UpcomingDividend (/avanza-ts/docs/sdk/reference/generated/interfaces/UpcomingDividend)



## Properties [#properties]

### accountId [#accountid]

> `readonly` **accountId**: `string`

***

### amount [#amount]

> `readonly` **amount**: [`DividendAmount`](./DividendAmount.md)

***

### amountInSek [#amountinsek]

> `readonly` **amountInSek**: `number`

***

### amountPerShare [#amountpershare]

> `readonly` **amountPerShare**: [`DividendAmount`](./DividendAmount.md)

***

### amountPerShareInSek [#amountpershareinsek]

> `readonly` **amountPerShareInSek**: `number`

***

### date [#date]

> `readonly` **date**: `string`

***

### encryptedAccountId [#encryptedaccountid]

> `readonly` **encryptedAccountId**: `string`

***

### exDate [#exdate]

> `readonly` **exDate**: `string`

***

### instrumentName [#instrumentname]

> `readonly` **instrumentName**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### orderbook [#orderbook]

> `readonly` **orderbook**: `Omit`\<[`TransactionOrderbook`](./TransactionOrderbook.md), `"volumeFactor"`> & `object`

#### Type Declaration [#type-declaration]

##### volumeFactor [#volumefactor]

> `readonly` **volumeFactor**: `number` | `null`

***

### status [#status]

> `readonly` **status**: `string`

For example `CONFIRMED` or `PRELIMINARY`.

***

### volume [#volume]

> `readonly` **volume**: `number`


# Interface: Watchlist (/avanza-ts/docs/sdk/reference/generated/interfaces/Watchlist)



## Properties [#properties]

### created [#created]

> `readonly` **created**: `string`

***

### customerId [#customerid]

> `readonly` **customerId**: `object`

#### id [#id]

> `readonly` **id**: `number`

***

### modified [#modified]

> `readonly` **modified**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### orderbookIds [#orderbookids]

> `readonly` **orderbookIds**: readonly `string`\[]

***

### watchListId [#watchlistid]

> `readonly` **watchListId**: `string`

***

### watchListItems [#watchlistitems]

> `readonly` **watchListItems**: readonly `object`\[]


# Interface: WatchlistNewsItem (/avanza-ts/docs/sdk/reference/generated/interfaces/WatchlistNewsItem)



## Properties [#properties]

### category [#category]

> `readonly` **category**: `string`

***

### orderbooks [#orderbooks]

> `readonly` **orderbooks**: readonly [`WatchlistOrderbook`](./WatchlistOrderbook.md)\[]

***

### publishDateTime [#publishdatetime]

> `readonly` **publishDateTime**: `string`

***

### sourceName [#sourcename]

> `readonly` **sourceName**: `string`

***

### teaser [#teaser]

> `readonly` **teaser**: `string`

***

### title [#title]

> `readonly` **title**: `string`

***

### url [#url]

> `readonly` **url**: `string`

Pass to `NewsClient.article()` for the full article.

***

### vignette [#vignette]

> `readonly` **vignette**: `string`


# Interface: WatchlistNewsOptions (/avanza-ts/docs/sdk/reference/generated/interfaces/WatchlistNewsOptions)



## Properties [#properties]

### categories? [#categories]

> `readonly` `optional` &#x2A;*categories?**: readonly `string`\[]


# Interface: WatchlistNewsResponse (/avanza-ts/docs/sdk/reference/generated/interfaces/WatchlistNewsResponse)



## Properties [#properties]

### currentDateTime [#currentdatetime]

> `readonly` **currentDateTime**: `string`

***

### news [#news]

> `readonly` **news**: readonly [`WatchlistNewsItem`](./WatchlistNewsItem.md)\[]


# Interface: WatchlistOrderbook (/avanza-ts/docs/sdk/reference/generated/interfaces/WatchlistOrderbook)



## Extended by [#extended-by]

* [`WatchlistRow`](./WatchlistRow.md)

## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

***

### currency [#currency]

> `readonly` **currency**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

***

### id [#id]

> `readonly` **id**: `string`

***

### instrumentId [#instrumentid]

> `readonly` **instrumentId**: `string`

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

***

### isin [#isin]

> `readonly` **isin**: `string`

***

### name [#name]

> `readonly` **name**: `string`

***

### sellable [#sellable]

> `readonly` **sellable**: `boolean`

***

### shortName [#shortname]

> `readonly` **shortName**: `string`

***

### tradable [#tradable]

> `readonly` **tradable**: `boolean`


# Interface: WatchlistRow (/avanza-ts/docs/sdk/reference/generated/interfaces/WatchlistRow)



Sections other than `quote` and `tools` depend on the requested data points.

## Extends [#extends]

* [`WatchlistOrderbook`](./WatchlistOrderbook.md)

## Properties [#properties]

### buyable [#buyable]

> `readonly` **buyable**: `boolean`

#### Inherited from [#inherited-from]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`buyable`](./WatchlistOrderbook.md#buyable)

***

### currency [#currency]

> `readonly` **currency**: `string`

#### Inherited from [#inherited-from-1]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`currency`](./WatchlistOrderbook.md#currency)

***

### dateWhenAdded? [#datewhenadded]

> `readonly` `optional` &#x2A;*dateWhenAdded?**: `string`

***

### flagCode [#flagcode]

> `readonly` **flagCode**: `string`

#### Inherited from [#inherited-from-2]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`flagCode`](./WatchlistOrderbook.md#flagcode)

***

### id [#id]

> `readonly` **id**: `string`

#### Inherited from [#inherited-from-3]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`id`](./WatchlistOrderbook.md#id)

***

### instrumentId [#instrumentid]

> `readonly` **instrumentId**: `string`

#### Inherited from [#inherited-from-4]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`instrumentId`](./WatchlistOrderbook.md#instrumentid)

***

### instrumentType [#instrumenttype]

> `readonly` **instrumentType**: `string`

#### Inherited from [#inherited-from-5]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`instrumentType`](./WatchlistOrderbook.md#instrumenttype)

***

### isin [#isin]

> `readonly` **isin**: `string`

#### Inherited from [#inherited-from-6]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`isin`](./WatchlistOrderbook.md#isin)

***

### keyIndicators [#keyindicators]

> `readonly` **keyIndicators**: `Readonly`\<`Record`\<`string`, `boolean` | `number` | `string`>>

For example `numberOfOwners`, `priceEarningsRatio`, or `nextDividendDate`.

***

### name [#name]

> `readonly` **name**: `string`

#### Inherited from [#inherited-from-7]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`name`](./WatchlistOrderbook.md#name)

***

### performance? [#performance]

> `readonly` `optional` &#x2A;*performance?**: `Readonly`\<`Record`\<`string`, `number`>>

Change in percent keyed by period, for example `ONE_YEAR`.

***

### priceWhenAdded? [#pricewhenadded]

> `readonly` `optional` &#x2A;*priceWhenAdded?**: `number`

***

### quote [#quote]

> `readonly` **quote**: `object`

#### buyPrice [#buyprice]

> `readonly` **buyPrice**: `number`

#### change [#change]

> `readonly` **change**: `number`

#### changePercent [#changepercent]

> `readonly` **changePercent**: `number`

#### closingPrice [#closingprice]

> `readonly` **closingPrice**: `number`

#### highestPrice [#highestprice]

> `readonly` **highestPrice**: `number`

#### lastPrice [#lastprice]

> `readonly` **lastPrice**: `number`

#### lastPriceUpdated [#lastpriceupdated]

> `readonly` **lastPriceUpdated**: `string`

#### lowestPrice [#lowestprice]

> `readonly` **lowestPrice**: `number`

#### sellPrice [#sellprice]

> `readonly` **sellPrice**: `number`

#### spread [#spread]

> `readonly` **spread**: `number`

#### totalValueTraded [#totalvaluetraded]

> `readonly` **totalValueTraded**: `number`

#### totalVolumeTraded [#totalvolumetraded]

> `readonly` **totalVolumeTraded**: `number`

#### updated [#updated]

> `readonly` **updated**: `string`

***

### sellable [#sellable]

> `readonly` **sellable**: `boolean`

#### Inherited from [#inherited-from-8]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`sellable`](./WatchlistOrderbook.md#sellable)

***

### shortName [#shortname]

> `readonly` **shortName**: `string`

#### Inherited from [#inherited-from-9]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`shortName`](./WatchlistOrderbook.md#shortname)

***

### tools [#tools]

> `readonly` **tools**: `object`

#### hasAlert [#hasalert]

> `readonly` **hasAlert**: `boolean`

#### hasNote [#hasnote]

> `readonly` **hasNote**: `boolean`

***

### tradable [#tradable]

> `readonly` **tradable**: `boolean`

#### Inherited from [#inherited-from-10]

[`WatchlistOrderbook`](./WatchlistOrderbook.md).[`tradable`](./WatchlistOrderbook.md#tradable)


# Interface: WebSocketClient (/avanza-ts/docs/sdk/reference/generated/interfaces/WebSocketClient)



## Properties [#properties]

### context [#context]

> `protected` `readonly` **context**: `ClientContext`