README.md

SimplyWallSt Snowflake API Client

An unofficial client for Simply Wall St Snowflake API.

Installation

Add this line to your application's Gemfile:

gem 'simplywallst_snowflake'

Usage

Create a new SimplywallstSnowflake::Client object with the desired exchange and stock ticker.

require 'simplywallst_snowflake'
client = SimplywallstSnowflake::Client.new(exchange, ticker)

For example:

client = SimplywallstSnowflake::Client.new('ASX', 'TLS')

The following client properties are available:

  response
  url
  company_name
  unique_symbol
  primary_exchange_symbol
  primary_ticker_symbol
  snowflake_scores
  snowflake_colour
  widget_url
  snowflake_tile_url
  value
  future
  past
  health
  income

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bcoles/simplywallst_snowflake.

Documentation

SimplyWall.St Snowflake Widget API Documentation

License

The gem is available as open source under the terms of the MIT License.