Project

fugle

0.0
No release in over 3 years
Low commit activity in last 3 years
The Fugle.tw API Client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.17
~> 0.51.0
~> 10.0
~> 3.0
~> 0.76.0
 Project Readme

Fugle API

This is Ruby gem implement Realtime API client for Fugle.tw

Installation

Add this line to your application's Gemfile:

gem 'fugle'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fugle

Usage

Currently only support HTTP API as below, for better use the API the result structure is modified.

Config

Fugle.config do |c|
  c.api_token = 'XXX'
end

The token also loaded from FUGLE_API_TOKEN environment variable

You can temporary change config by Fugle.use

config = Fugle::Config.new(api_token: 'XXX')

Fugle.use(config) do
  Fugle.intraday.meta(symbol: '0050')
end

Chart

Fugle.intraday.chart(symbol: '0050').body.each do |item|
  puts "Open: #{item.open} @ #{item.time}"
end

Quote

Fugle.intraday.quote(symbol: '0050').body.closed?

Meta

Fugle.intraday.meta(symbol: '0050').body.name

Trades

Fugle.intraday.trades(symbol: '0050').body.each do |item|
  puts "Price: #{item.price}"
end

Roadmap

  • HTTP API Support
  • WebSocket support
  • Unit Tests

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/fugle-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Fugle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.