# @flightradar24/fr24sdk 中文文档

规范地址：https://npmcn.com/package/%40flightradar24/fr24sdk/

版本：0\.1\.1
npm 元数据更新时间：2025-11-04T11:58:14.386Z
中文译文更新时间：2026-11-15T01:08:13.041Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flightradar24/fr24sdk
原文对照：https://npmcn.com/package/%40flightradar24/fr24sdk/?lang=original
项目主页：https://fr24api.flightradar24.com/
源码仓库：https://github.com/Flightradar24/fr24api-sdk-js

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

- 包体积（解压后）：1 MB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2025-10-20T13:44:09.879Z
- 最新版本发布：2025-11-04T11:58:13.938Z
- 近 30 天下载量：2301（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

Flightradar24 API的官方节点.js SDK

## 安装

```sh
npm install @flightradar24/fr24sdk
```

也可以使用：`pnpm add @flightradar24/fr24sdk`、`yarn add @flightradar24/fr24sdk`、`bun add @flightradar24/fr24sdk`

## README

# Flightradar24 节点 SDK (fr24sdk)

节点.js SDK [飞行雷达24 API](https://fr24api.flightradar24.com/)。 。 。 .

## 特征

-   访问所有 Flightradar24 API v1 端点.
-   直观客户端界面 : `client.airports.getFull("WAW")`
-   处理自定义例外的强烈错误 .
-   常用参数的轻量级输入验证.
-   返回普通 JavaScript 对象和类,以便于数据访问.

## 安装

### 发布版本( 建议用户使用)

```bash
npm install @flightradar24/fr24sdk
```

### 开发版本(建议贡献者)

如果您想要为 SDK 做出贡献或使用最新的未释放的更改 :

```bash
git clone https://github.com/flightradar24/fr24api-sdk-node.git
cd fr24api-sdk-node
```

## SDK 使用指南

本指南全面概述了如何使用SDK与Flightradar24 API互动.

### 1\. 客户初始化

这个 `Client` 类是您访问 API 的主要切入点.

**使用环境变量( 建议):**

确定您安装了 dotenv, 然后创建 `.env` 在工程根中添加您的 API 令牌 :

```
FR24_API_TOKEN=your_api_token_here
```

然后,初始化客户端:

```js
require('dotenv').config();
const SDK = require('@flightradar24/fr24sdk');

const client = new SDK.Client({
  apiToken: process.env.FR24_API_TOKEN,
  apiVersion: 'v1', // optional, defaults to 'v1'
});
```

您也可以使用无害环境管理

```js
import SDK from '@flightradar24/fr24sdk';

const client = new SDK.Client({
  apiToken: process.env.FR24_API_TOKEN,
  apiVersion: 'v1', // optional, defaults to 'v1'
});
```

### 2\. 获取API资源

客户端提供访问不同API资源作为属性. 例如:

-   `client.airlines`:获取航空公司详情.
-   `client.airports`:获取机场细节.
-   `client.live`:获取活飞行数据,包括特定地域范围内的飞行.
-   `client.historic`:查询历史飞行信息.
-   `client.flightSummary`:检索特定飞行的摘要.
-   `client.flightTracks`: 访问飞行轨道数据.
-   `client.usage`: 请检查您的 API 使用统计 .

每个资源对象都有获取该资源相关数据的方法.

### 3\. 资源实例

**获取机场细节**

这一例子表明,为机场(如华沙肖邦机场)获取了详细信息并获取了机场的属性.

```js
require('dotenv').config();
const SDK = require('@flightradar24/fr24sdk');

const client = new SDK.Client({
  apiToken: process.env.FR24_API_TOKEN,
  apiVersion: 'v1',
});

(async () => {
  try {
    const airport = await client.airports.getFull('WAW');
    console.log('Airport (WAW) Full:', airport);
    // Access properties, e.g.:
    // console.log(airport.name);
    // console.log(airport.timezone.name);
  } catch (err) {
    console.error(err);
  } finally {
    client.close();
  }
})();
```

**其他实例**

见 [实例.js](https://npmcn.com/package/%40flightradar24/fr24sdk/examples.js) 用于更多使用模式,包括:

-   获取飞行摘要
-   获取航空公司详情
-   获得现场直播和历史性飞行位置
-   获取飞行轨道
-   检查 API 使用情况

### 4\. 处理答复

API方法返回 JavaScript 对象或类例,代表API的JSON响应. 您可以使用点标记访问数据, 例如 :

```js
const airport = await client.airports.getFull('JFK');
console.log(airport.name); // Airport name
console.log(airport.timezone.name); // Timezone name
```

一些端点返回数组或响应包类(如, `UsageLogSummaryResponse`, (中文(简体) ), `FlightTracksResponse`) (中文(简体) ).

### 5\. 处理错误

SDK使用自定义例外表示出错. 基础例外是 `Fr24SdkError`。更具体的错误,例如 `ApiError`, (中文(简体) ), `AuthenticationError`, (中文(简体) ), `RateLimitError`等,从中继承.

实例错误处理 :

```js
const SDK = require('@flightradar24/fr24sdk');
const { ApiError, AuthenticationError, Fr24SdkError } = require('./src/exceptions');

const client = new SDK.Client({ apiToken: process.env.FR24_API_TOKEN });

(async () => {
  try {
    // Example: Intentionally try to get a non-existent airport
    const airport = await client.airports.getFull('INVALID_IATA');
    if (airport) {
      console.log(airport.name);
    }
  } catch (err) {
    if (err instanceof AuthenticationError) {
      console.error('Authentication failed. Please check your API token.');
    } else if (err instanceof ApiError) {
      console.error('API Error occurred:', err.getMessage());
      console.error('Details:', err.getDetails());
    } else if (err instanceof Fr24SdkError) {
      console.error('An SDK-specific error occurred:', err.message);
    } else {
      console.error('An unexpected error occurred:', err);
    }
  } finally {
    client.close();
  }
})();
```

## 捐款

欢迎捐款! 请看 `CONTRIBUTING.md` (待定)准则.

## 许可证

这个项目根据麻省理工学院许可证颁发——见 `LICENSE` 详细文件.

## 常见问题

### @flightradar24/fr24sdk 是什么？

Flightradar24 API的官方节点\.js SDK

### 如何安装 @flightradar24/fr24sdk？

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

### @flightradar24/fr24sdk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/flightradar24\_\_fr24sdk 是否存在。

### @flightradar24/fr24sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flightradar24/fr24sdk 可以商用吗？

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

### @flightradar24/fr24sdk 的下载量有多少？

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

### @flightradar24/fr24sdk 还在维护吗？

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