> ## 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.

# 余额与资产

> 查询 BTC 余额、持有代币与资产元数据。

示例使用 `createArksatClient(provider)`。

## getBalance

BTC 金额单位为 satoshi（sats）。区分 available 与 total，不用总额代替可用额。

**参数**

无参数。

**返回**

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

**示例**

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

## getAssets

获取当前钱包持有资产。rawAmount 为精确的最小单位字符串；展示优先使用 displayAmountText。

**参数**

无参数。

**返回**

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

**示例**

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

## getAssetDetails

在当前钱包持有资产中查找。null 不代表该资产在全网不存在。

**参数**

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

**返回**

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

**示例**

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

## getAssetMetadata

查询元数据、供应量和控制资产信息。

**参数**

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

**返回**

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

**示例**

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

## 金额单位

代币 amount 使用最小单位的整数字符串。metadataPending 为 true 时，名称或小数位仍未确认，不应猜测 decimals。详见[查询资产](https://docs.arksat.xyz/assets.md)与[金额精度](https://docs.arksat.xyz/amounts.md)。

[错误处理](https://docs.arksat.xyz/errors.md) · [完整 TypeScript 类型](https://docs.arksat.xyz/reference/types.md)


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