首页
/ Stock_Quote 项目技术文档

Stock_Quote 项目技术文档

2024-12-26 11:33:07作者:齐添朝

本文档旨在帮助用户了解并使用Stock_Quote项目,该项目提供了实时股票数据和历史定价信息。以下是关于项目的安装指南、使用说明以及API使用文档。

1. 安装指南

要安装Stock_Quote Ruby gem,请在命令行中执行以下命令:

gem install stock_quote

如果要在Rails应用程序中使用该gem,请在Gemfile中添加以下代码:

gem "stock_quote", "~> 3.0.0"

然后运行bundle install命令以安装gem。

2. 项目使用说明

初始化

要全局初始化StockQuote,需要使用有效的API_KEY。可以通过以下方式完成:

StockQuote::Stock.new(api_key: YOUR_API_KEY)

也可以在任何StockQuote::Stock方法中提供api_key属性。

获取股票报价

StockQuote::Stock.quote(symbol)是获取股票报价的主要方法,返回一个包含以下属性(在v2.0.0版本中新增)的StockQuote::Stock实例:

  • symbol
  • company_name
  • primary_exchange
  • sector
  • calculation_price
  • open
  • open_time
  • close
  • close_time
  • high
  • low
  • latest_price
  • latest_source
  • latest_time
  • latest_update
  • latest_volume
  • iex_realtime_price
  • iex_realtime_size
  • iex_last_updated
  • delayed_price
  • delayed_price_time
  • previous_close
  • change
  • change_percent
  • iex_market_percent
  • iex_volume
  • avg_total_volume
  • iex_bid_price
  • iex_bid_size
  • iex_ask_price
  • iex_ask_size
  • market_cap
  • pe_ratio
  • week52_high
  • week52_low
  • ytd_change
  • chart

可以通过以下语法获取当前报价:

stock = StockQuote::Stock.quote("symbol")

其中,symbol代表您想要获取报价的公司股票代码,例如,"aapl"代表苹果公司。

您可以通过逗号(或数组)分隔的符号搜索多个股票:

stocks = StockQuote::Stock.quote("aapl,tsla")

这些查询将返回一个Stock对象或一个Stock对象数组,您可以遍历它们。

注意:您可以通过以下语法接收原始json哈希响应:

stocks = StockQuote::Stock.raw_quote("aapl,tsla")

raw_方法适用于所有支持的方法。

其他方法

StockQuote 3.0.0版本镜像了IEXCLOUD.IO API,提供了多种方法:

  • book
  • chart
  • company
  • delayed_quote
  • dividends
  • earnings
  • financials
  • stats
  • logo
  • news
  • ohlc
  • peers
  • previous
  • price
  • quote
  • relevant
  • splits
  • volume_by_venue

所有这些方法都可以在StockQuote::Stock上使用。

例如:

StockQuote::Stock.company('aapl')

获取公司信息。

例如:

StockQuote::Stock.dividends('aapl')

获取分红信息。

对于任何方法,都可以通过在方法名前加上raw_来获取原始json哈希响应。

例如:

StockQuote::Stock.raw_dividends('aapl')

获取原始分红信息。

批量请求

批量请求允许您将多个请求组合在一起。StockQuote中的所有方法都使用批量请求。

批量的语法如下:

StockQuote::Stock.batch(type, symbol, range)

其中type可以是上述方法的组合,symbol可以是公司代码的数组,range可以应用于chart方法,包括以下范围:

  • 5y
  • 2y
  • 1y
  • ytd
  • 6m
  • 3m
  • 1m
  • 1d

3. 项目API使用文档

StockQuote项目API的使用已在上述使用说明中详细描述。API提供了获取股票报价、公司信息、历史价格等多种功能。每个方法的使用方式已在相应的部分中说明。

请按照上述指南和示例代码进行API调用,以获取所需的数据。

4. 项目安装方式

项目的安装方式已在安装指南中说明。您可以通过Ruby gem包管理器安装Stock_Quote gem,并在您的Rails应用程序中配置使用。

以上就是Stock_Quote项目的技术文档,希望对您的使用有所帮助。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
116
200
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
503
398
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
62
144
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
295
1.01 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
97
251
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
381
37
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
692
91
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
97
74
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
357
341