# @balancer-team/usps-v3 中文文档

规范地址：https://npmcn.com/package/%40balancer-team/usps-v3/

版本：0\.0\.9
npm 元数据更新时间：2026-04-30T19:54:50.059Z
中文译文更新时间：2026-11-07T23:55:42.103Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40balancer-team/usps-v3
原文对照：https://npmcn.com/package/%40balancer-team/usps-v3/?lang=original
项目主页：https://www.balancer.team/
源码仓库：https://github.com/balancer-team/usps-v3-js

弃用说明：This package has moved to @nextform/usps-v3\. Please update your dependencies\.

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

- 包体积（解压后）：8.9 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-04-30T23:09:54.155Z
- 最新版本发布：2025-05-29T19:24:00.090Z
- 近 30 天下载量：1969（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

用于与USPS v3 API接口的库.

## 安装

```sh
npm install @balancer-team/usps-v3
```

也可以使用：`pnpm add @balancer-team/usps-v3`、`yarn add @balancer-team/usps-v3`、`bun add @balancer-team/usps-v3`

## README

# USPS v3 API JavaScript 库

用于与USPS v3 API接口的库. USPS v3 API取代了遗留的Web Tools API.

### 安装

```bash
npm i @balancer-team/usps-v3
```

### 使用量

导入和配置库

```javascript
import { USPS } from '@balancer-team/usps-v3'

const usps = new USPS({
  clientId: USPS_CLIENT_ID,
  clientSecret: USPS_CLIENT_SECRET,
})
```

验证地址

```javascript
const data = await usps.getAddress({
  streetAddress: '302 Riverside Drive',
  city: 'Melbourne Beach',
  state: 'FL',
})

// Response:
//
// {
//   firm: '',
//   address: {
//     streetAddress: '302 RIVERSIDE DR',
//     streetAddressAbbreviation: '302 RIVERSIDE DR',
//     secondaryAddress: '',
//     cityAbbreviation: 'MELBOURNE BCH',
//     city: 'MELBOURNE BCH',
//     state: 'FL',
//     ZIPCode: '32951',
//     ZIPPlus4: '2142',
//     urbanization: ''
//   },
//   additionalInfo: {
//     deliveryPoint: '02',
//     carrierRoute: 'C001',
//     DPVConfirmation: 'Y',
//     DPVCMRA: 'N',
//     business: 'N',
//     centralDeliveryPoint: 'N',
//     vacant: 'N'
//   },
//   corrections: [ { code: '', text: '' } ],
//   matches: [ { code: '31', text: 'Single Response - exact match' } ]
// }
```

以 ZIP 代码查找城市/ 状态

```javascript
const data = await usps.getCityState({
  ZIPCode: '90210',
})

// Response:
//
// {
//    city: 'BEVERLY HILLS',
//    state: 'CA',
//    ZIPCode: '90210'
// }
```

### 标题大小写转换

USPS v3 API 默认返回地址字段的所有封顶 。 这个库如果需要,可以自动将字段转换为更人可读的标题大小写. 要启用此特性,请设置 `useTitleCase` 选项到 `true` 创建 USPS 实例时.

```javascript
const usps = new USPS({
  clientId: USPS_CLIENT_ID,
  clientSecret: USPS_CLIENT_SECRET,
  useTitleCase: true,
})

const data = await usps.getAddress({
  streetAddress: '302 Riverside Drive',
  city: 'Melbourne Beach',
  state: 'FL',
})

// Response:
//
// {
//   firm: '',
//   address: {
//     streetAddress: '302 Riverside Dr',
//     ...

const data = await usps.getCityState({
  ZIPCode: '90210',
})

// Response:
//
// {
//    city: 'Beverly Hills',
//    ...
```

## 常见问题

### @balancer-team/usps-v3 是什么？

用于与USPS v3 API接口的库\.注意：该包已被作者标记为弃用——This package has moved to @nextform/usps-v3\. Please update your dependencies\.

### 如何安装 @balancer-team/usps-v3？

在项目目录运行 npm install @balancer-team/usps-v3，或使用 pnpm add / yarn add / bun add。

### @balancer-team/usps-v3 支持 TypeScript 吗？

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

### @balancer-team/usps-v3 支持 ESM 还是 CommonJS？

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

### @balancer-team/usps-v3 可以商用吗？

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

### @balancer-team/usps-v3 的下载量有多少？

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

### @balancer-team/usps-v3 还在维护吗？

最新版本 0\.0\.9 发布于 2025/05/30（1\.4 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/05/01。作者已将其标记为弃用，新项目建议寻找替代方案。