@apicity/binance

中文文档

0.27.0发布于 2026/11/06MITTypeScriptES Module近 30 天下载 3724

Binance Spot, USD-M Futures, COIN-M Futures, and Options public REST API provider.

文档目录25 节

Installation
Quick Start
Public Market Data
API Reference
aggTrades
avgPrice
coinMFutures
dapi
depth
eapi
exchangeInfo
executionRules
fapi
futures
historicalBlockTrades
historicalTrades
klines
ping
public
referencePrice
ticker
time
trades
uiKlines
License

@apicity/binance

Binance Spot, USD-M Futures, COIN-M Futures, and Options public REST API provider.

Binance coverage is focused on public REST market-data reads across Spot, USD-M Futures, COIN-M Futures, and Options. The COIN-M Old Trades Lookup endpoint (GET /dapi/v1/historicalTrades) is intentionally not exposed because Binance requires an API key for it. USD-M Old Trades Lookup (GET /fapi/v1/historicalTrades), signed trade, account, and user endpoints are out of scope.

Runtime dependencies:

zod@^4.6.6 — request schemas attached to every POST endpoint as .schema

Installation

npm install @apicity/binance
# or
pnpm add @apicity/binance

Quick Start

import { createBinance } from "@apicity/binance";

const binance = createBinance();

Public Market Data

createBinance() works without credentials for the public market-data surface. Pass apiKey only when you intentionally call a Binance endpoint that is documented as API-key or MARKET_DATA; signed trade, account, and user-data-stream endpoints are not exposed by this package.

Surface	Namespace	Default host	Auth
Spot REST	`binance.api.v3.*`	`https://api.binance.com`	No key for public market data; optional `apiKey` header when supplied
Spot market-data-only REST	`binance.api.v3.*` with `spotBaseURL`	`https://data-api.binance.vision`	No key
USD-M Futures	`binance.fapi.v1.`, `binance.fapi.v2.`, `binance.futures.data.*`	`https://fapi.binance.com`	No key for exposed endpoints
COIN-M Futures	`binance.dapi.v1.`, `binance.coinMFutures.data.`	`https://dapi.binance.com`	No key for exposed endpoints
Options	`binance.eapi.v1.*`	`https://eapi.binance.com`	No key for exposed endpoints

To send existing Spot public calls to Binance's market-data-only host, override the Spot base URL. This keeps the same api.v3 method paths while changing the host:

const binance = createBinance({
  spotBaseURL: "https://data-api.binance.vision",
});

const exchangeInfo = await binance.api.v3.exchangeInfo({
  symbol: "BTCUSDT",
  showPermissionSets: false,
});

You can also configure every public host explicitly:

const binance = createBinance({
  publicBaseURLs: {
    spot: "https://data-api.binance.vision",
    spotData: "https://data-api.binance.vision",
    fapi: "https://fapi.binance.com",
    dapi: "https://dapi.binance.com",
    eapi: "https://eapi.binance.com",
  },
});

binance.public.* contains explicit no-auth smoke aliases for each public surface, and binance.public.coinMFutures.* mirrors the COIN-M public REST tree. Use the top-level namespaces above for the full implemented market-data surface.

The https://data.binance.vision static archive serves public ZIP and checksum files for historical Spot, USD-M, and COIN-M datasets. It is intentionally outside this JSON REST provider; archive downloads need separate binary/checksum handling and tests.

API Reference

93 endpoints across 20 groups. Each method mirrors an upstream URL path.

aggTrades

GET binance.api.v3.aggTrades

GET https://api.binance.com/api/v3/aggTrades{query}

Cost tier: cheap

版本	发布日期	距今
`0.27.0`latest	2026/11/06	今天
`0.26.0`	2026/11/05	1 天前
`0.25.0`	2026/11/03	3 天前
`0.24.1`	2026/11/02	4 天前
`0.24.0`	2026/11/01	4 天前
`0.23.1`	2026/11/01	5 天前

@apicity/binance

@apicity/binance

Installation

Quick Start

Public Market Data

API Reference

aggTrades

avgPrice

coinMFutures

dapi

depth

eapi

exchangeInfo

executionRules

fapi

futures

historicalBlockTrades

historicalTrades

klines

ping

public

referencePrice

ticker

time

trades

uiKlines

License

版本与发布记录

关于 @apicity/binance 的常见问题

@apicity/binance 是什么？

如何安装 @apicity/binance？

@apicity/binance 支持 TypeScript 吗？

@apicity/binance 支持 ESM 还是 CommonJS？

@apicity/binance 需要什么版本的 Node.js？

@apicity/binance 可以商用吗？

@apicity/binance 的下载量有多少？

@apicity/binance 还在维护吗？