# @balldontlie/sdk 中文文档

规范地址：https://npmcn.com/package/%40balldontlie/sdk/

版本：1\.2\.2
npm 元数据更新时间：2024-12-21T01:27:32.613Z
中文译文更新时间：2026-11-07T23:40:38.580Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40balldontlie/sdk
原文对照：https://npmcn.com/package/%40balldontlie/sdk/?lang=original
项目主页：https://github.com/balldontlie-api/typescript#readme
源码仓库：https://github.com/balldontlie-api/typescript

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：136 kB，34 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-11-26T22:12:03.128Z
- 最新版本发布：2024-12-21T01:27:32.424Z
- 近 30 天下载量：2013（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

用于 balldontlie API 的官方类型SDK 脚本/ JavaScript

## 安装

```sh
npm install @balldontlie/sdk
```

也可以使用：`pnpm add @balldontlie/sdk`、`yarn add @balldontlie/sdk`、`bun add @balldontlie/sdk`

## README

# 布莱多莉·艾比

官方TypeScript/JavaScript SDK为BALLDONTLIE API. 请访问NBA,NFL,以及MLB的统计数据和数据. 请检查date=中的日期值 (帮助) 官方网站 [这里](https://app.balldontlie.io/)。 。 。 .

## 安装

```bash
# npm
npm install @balldontlie/sdk

# yarn
yarn add @balldontlie/sdk

# pnpm
pnpm add @balldontlie/sdk
```

## 使用量

### 脚本/ ES 模块

```typescript
import { BalldontlieAPI } from "@balldontlie/sdk";

const api = new BalldontlieAPI({ apiKey: "your-api-key" });

// Using async/await
async function getTeams() {
  try {
    const teams = await api.nba.getTeams();
    console.log(teams.data);
  } catch (error) {
    console.error(error);
  }
}

// Using promises
api.nba
  .getPlayers({ search: "James" })
  .then((response) => console.log(response.data))
  .catch((error) => console.error(error));
```

### 常见JS

```javascript
const { BalldontlieAPI } = require("@balldontlie/sdk");

const api = new BalldontlieAPI({ apiKey: "your-api-key" });
```

## 示例使用

### NBA (英语)

```typescript
// Get all NBA teams
const teams = await api.nba.getTeams();

// Get a specific team
const team = await api.nba.getTeam(1);

// Search for players
const players = await api.nba.getPlayers({
  search: "James",
});

// Get season averages
const stats = await api.nba.getSeasonAverages({
  season: 2023,
  player_id: 1,
});
```

### NFL 国家橄榄球联盟

```typescript
// Get NFL teams
const teams = await api.nfl.getTeams({ conference: "AFC" });

// Get player stats
const stats = await api.nfl.getStats({
  player_ids: [1],
  seasons: [2023],
});

// Get advanced stats
const rushingStats = await api.nfl.getAdvancedRushingStats({
  season: 2023,
  player_id: 1,
});
```

### 劳工局

```typescript
// Get MLB teams
const teams = await api.mlb.getTeams({ league: "American" });

// Get season stats
const seasonStats = await api.mlb.getSeasonStats({
  season: 2023,
  player_ids: [1],
});

// Get team season stats
const teamStats = await api.mlb.getTeamSeasonStats({
  season: 2023,
  team_id: 1,
});
```

## API 参考

查看源代码以查看类型和函数名 : [https://github.com/balldontlie-api/ts-sdk/tree/master/src 页面存档备份,存于互联网档案馆](https://github.com/balldontlie-api/ts-sdk/tree/master/src)

检查完整的 API 文档 : [NBA (英语)](https://nba.balldontlie.io/) [NFL 国家橄榄球联盟](https://nfl.balldontlie.io/) [劳工局](https://mlb.balldontlie.io/)

## 处理错误

```typescript
try {
  const data = await api.nba.getTeam(999999);
} catch (error) {
  if (error.status === 404) {
    console.error("Team not found");
  } else {
    console.error("API Error:", error.message);
  }
}
```

## 常见问题

### @balldontlie/sdk 是什么？

用于 balldontlie API 的官方类型SDK 脚本/ JavaScript

### 如何安装 @balldontlie/sdk？

在项目目录运行 npm install @balldontlie/sdk，或使用 pnpm add / yarn add / bun add。

### @balldontlie/sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @balldontlie/sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @balldontlie/sdk 可以商用吗？

@balldontlie/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @balldontlie/sdk 的下载量有多少？

根据 npm 官方下载统计，@balldontlie/sdk 在 2026/10/08 – 2026/11/06 这 30 天内被下载 2,013 次，日均约 67 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @balldontlie/sdk 还在维护吗？

最新版本 1\.2\.2 发布于 2024/12/21（1\.9 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/11/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。