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

# Getting started

> Getting started with Krono Core - A facade and utilities for managing Kraken WebSocket connections and orderbook state.

The `@krono/core` SDK makes it easier to connect to the Kraken Websocket API and store / retrieve historical data for time traveling.
You can find the `@krono/core` SDK source code on Github.
To get started, install the required packages.

<CodeGroup>
  ```pnpm pnpm theme={null}
  pnpm add @krono/core
  ```

  ```npm npm theme={null}
  npm install @krono/core
  ```

  ```yarn yarn theme={null}
  yarn add @krono/core
  ```

  ```bun bun theme={null}
  bun add @krono/core
  ```
</CodeGroup>

## Orderbook

The `Orderbook` class is the main entry point for real-time market data.

```typescript create-orderbook.ts theme={null}
import { Orderbook } from '@krono/core'

export const orderbook = new Orderbook({
    symbol: "BTC/USD",
    limit: 25,
    depth: 500,
    debug: true
})
```

<ParamField body="config" type="OrderbookConfigOptions" required={true}>
  The configuration object to initialize the orderbook.

  [View full Orderbook Configuration](/docs/core/configuration/orderbook)

  ```ts theme={null}
  type OrderbookConfigOptions = {
  symbol: string;
  limit?: number;
  depth?: 10 | 25 | 100 | 500 | 1000;
  // ... other partial options
  }
  ```
</ParamField>

## AssetPairs

The `AssetPairs` class handles fetching available trading pairs and their metadata (like icons and display names).

```typescript create-assets.ts theme={null}
import { AssetPairs } from '@krono/core'

export const assetPairs = new AssetPairs({
    topN: 50,
    autoFetch: true,
    debug: false
})
```

<ParamField body="config" type="AssetPairsConfig" required={false}>
  Configuration for the asset fetcher.

  [View full AssetPairs Configuration](/docs/core/configuration/asset-pairs)

  ```ts theme={null}
  type AssetPairsConfig = {
  topN?: number;
  autoFetch?: boolean;
  debug?: boolean;
  }
  ```
</ParamField>
