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

# Balances and assets

> Read balances, holdings, and metadata.

Use `client = createArksatClient(provider)`. Example variables are supplied by the application.

## getBalance

BTC values are integer sats. available is spendable; total includes other holdings.

**Parameters**

```ts theme={null}
// No parameters
```

**Returns**

```ts theme={null}
Promise<ArksatBalance>
```

**Example**

```ts theme={null}
const balance = await client.getBalance()
```

## getAssets

Returns held assets. rawAmount is exact; use displayAmountText for exact display.

**Parameters**

```ts theme={null}
// No parameters
```

**Returns**

```ts theme={null}
Promise<ArksatAssetBalance[]>
```

**Example**

```ts theme={null}
const assets = await client.getAssets()
```

## getAssetDetails

Searches current holdings. Null does not indicate global nonexistence.

**Parameters**

```ts theme={null}
{ assetId: string }
```

**Returns**

```ts theme={null}
Promise<ArksatAssetBalance | null>
```

**Example**

```ts theme={null}
const asset = await client.getAssetDetails({ assetId })
```

## getAssetMetadata

Returns metadata, supply, and optional control-asset information.

**Parameters**

```ts theme={null}
{ assetId: string }
```

**Returns**

```ts theme={null}
Promise<ArksatAssetDetails>
```

**Example**

```ts theme={null}
const metadata = await client.getAssetMetadata({ assetId })
```

## Units

Token transaction amounts are atomic-unit strings. Check metadataPending and verified decimals before accepting decimal input. [Amounts](https://docs.arksat.xyz/en/amounts.md).

[Errors](https://docs.arksat.xyz/en/errors.md) · [Type definitions](https://docs.arksat.xyz/en/reference/types.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.