#sdk #uplink #api-bindings #api-access #upstox

upstox-rust-sdk

SDK用于以编程方式访问Upstox的Uplink v2 API

4个版本

0.1.3 2024年8月24日
0.1.2 2024年7月8日
0.1.1 2024年7月7日
0.1.0 2024年7月5日

#493 in 异步

27 每月下载量

MPL-2.0 许可证

145KB
3.5K SLoC

Upstox Rust SDK for API v2

简介

Rust客户端,用于与Upstox API通信。

Upstox API是一组REST API,提供构建完整投资和交易平台所需的数据。使用此crate实时执行订单、管理用户投资组合、流式传输实时市场数据(使用Websocket)等。

  • API版本:v2

环境变量

这些环境变量根据要使用的功能在SDK中可选使用。

  • EMAIL_ID:用于Upstox账户的电子邮件,如 "[email protected]"(只有在自动化登录时需要)。
  • GOOGLE_AUTHORIZATION_CODE:在Google OAuth 2.0身份验证过程中获得的授权代码,有效期为1小时。只有当需要跳过手动登录页面时才提供新获取的值(只有在自动化获取OTP和使用Gmail时需要)。
  • GOOGLE_CLIENT_ID:用于Google Gmail API访问的Google客户端ID(只有在自动化获取OTP和使用Gmail时需要)。
  • GOOGLE_CLIENT_SECRET:用于Google Gmail API访问的Google客户端密钥(只有在自动化获取OTP和使用Gmail时需要)。
  • MOBILE_NUMBER:用于Upstox账户的手机号码(只有在自动化登录时需要)。
  • LOGIN_PIN:Upstox账户的登录PIN(只有在自动化登录时需要)。
  • REDIRECT_PORT:用于Upstox API和Gmail API重定向的本地端口,如8080。如果需要授权端点的访问,则提供给Upstox和Google的重定向URL必须是 "http://127.0.0.1:$REDIRECT_PORT"。
  • UPLINK_API_KEY:Upstox API密钥。授权API访问所需(在此处生成)。
  • UPLINK_API_SECRET:Upstox API密钥。授权API访问所需(在此处生成)。
  • WEBDRIVER_SOCKET:chromedriver或geckodriver运行的本地套接字。它们默认在 "http://127.0.0.1:4444" 上运行(只有在自动化登录时需要)。

示例

  • login-usage:使用登录功能获取访问令牌的示例,自动化登录,自动获取OTP,自动重新登录。
  • fetch-instruments:示例:在启动时获取可用工具并每日刷新。
  • ws-usage:示例:使用WebSocket并通过回调处理WebSocket数据,在WebSocket中使用时处理应用程序退出。
  • api-usage:示例:通过ApiClient使用Upstox的REST API端点。

许可证

根据MPL 2.0许可。

联系

通过电子邮件[email protected]与我联系。

依赖关系

~26–42MB
~766K SLoC