一、安装

Python

pip install mairui

JavaScript / TypeScript

npm i @mairuiapi/mairui

Java（Maven / Gradle）

implementation 'io.github.mairuiapi:mairui:1.2.0'

Go

go get github.com/MaiRuiApi/mairui-go@v1.2.0

C#（NuGet）

dotnet add package MairuiSdk --version 1.2.0
# 支持：.NET Framework 4.6.2+ / .NET Standard 2.0 / .NET 8

PyPI  |  npm  |  Maven Central  |  NuGet  |  GitHub： Python / JS / Java / Go / C#

二、本站直接下载

除包管理器安装外，也可从本站下载离线包后本地安装（多数语言 1.2.0；C# 1.2.0）：

Python

pip install ./mairui-1.2.0-py3-none-any.whl

JavaScript / TypeScript

npm install ./mairui-1.2.0.tgz

Java

# 将 mairui-1.2.0.jar 加入工程 classpath
# 或本地 install：mvn install:install-file -Dfile=mairui-1.2.0.jar -DgroupId=io.github.mairuiapi -DartifactId=mairui -Dversion=1.2.0 -Dpackaging=jar

Go

# 解压源码包后，在 go.mod 中替换为本地路径，例如：
# replace github.com/MaiRuiApi/mairui-go => ../mairui-go

C#（包版本 1.2.0，兼容 net462 / netstandard2.0 / net8.0）

dotnet add package MairuiSdk --source ./
# 或：将 MairuiSdk.1.2.0.nupkg 放入本地 NuGet 源目录后引用

三、30 秒上手

Python

from mairui import Client

with Client(licence="您的证书UUID") as api:
    stocks = api.stock_list()
    bars = api.stock_history("000001.SZ", "d", "n", st="20240101", et="20241231")
    tick = api.stock_real_time("000001")

JavaScript

import { Client } from "@mairuiapi/mairui";

const api = new Client({ licence: "您的证书UUID" });
const stocks = await api.stock_list();
const bars = await api.stock_history("000001.SZ", "d", "n", { st: "20240101", et: "20241231" });
api.close();

Java

import com.mairui.MairuiClient;

MairuiClient api = new MairuiClient("您的证书UUID");
Object stocks = api.stockList();
MairuiClient.TimeRangeQuery q = new MairuiClient.TimeRangeQuery();
q.st = "20240101"; q.et = "20241231";
Object bars = api.stockHistory("000001.SZ", "d", "n", q);
api.close();

Go

import mairui "github.com/MaiRuiApi/mairui-go"

api, _ := mairui.NewClient(mairui.ClientOptions{Licence: "您的证书UUID"})
defer api.Close()
stocks, _ := api.StockList()
st, et := "20240101", "20241231"
bars, _ := api.StockHistory("000001.SZ", "d", "n", mairui.TimeRangeQuery{St: &st, Et: &et})

C#

using MairuiSdk;

using var api = new MairuiClient("您的证书UUID");
var stocks = await api.StockListAsync();
var bars = await api.StockHistoryAsync("000001.SZ", "d", "n",
    new TimeRangeQuery { St = "20240101", Et = "20241231" });

只需绑定一次 licence，后续方法会自动拼接到请求路径末段； 鉴权与限流规则与直接 HTTP 调用完全一致。证书可在 证书获取 页面申请。 各语言完整 README 见上方 GitHub 链接；文档页每个接口另有「HTTP / SDK」对照示例。

四、能力与文档

• 覆盖官网文档中的公开接口（列表、K 线与指标、实时、财务、F10、股池、指数、北交所、基金、科创等）。
• 内置连接池、Gzip、有限自动重试；提供 api.map(...) 便于多标的批量拉取。
• 查询参数与文档一致：st / et（起止时间）、lt（最新条数）。

文档页每个接口的「代码示例」选项卡可切换语言，并同时展示 GET 请求与 SDK 调用示例，方法名与下表一致。 接口字段说明请查阅 沪深 A 股 API 文档 （同站指数、基金等文档页同样适用）。 接入流程亦可参考 接入方法。

接口 → SDK 方法对照

方法名经 SDK 源码校验（API 对齐 v1.2.0；C# 包 v1.2.0）；下表为高频接口速查，完整示例见各文档页接入选项卡。