Sygnal generator for Sygnal.io prototype
JavaScript Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.gitignore
.yardopts
README.md
sygnal.gemspec

README.md

Sygnal Ruby Gem

A gem for generating market-based event notifications via Sygnal.io API

Installation

gem install sygnal

Sample Application

require 'sygnal'

sygnal_type_id = 2
api_key = 'YOUR_API_KEY'

s = SygnalGenerator.new(sygnal_type_id, api_key)

#create a theoretical event loop here that predicts if S&P 500 is likely to close near high of the day
#if s_and_p_close_near_high_probability > 0.8
	
	response = s.generate_sygnal(
		'S&P has an 80% liklihood of closing within 0.4% of the high of the day.'  
	)

	puts response.body

	#For now, generate_sygnal returns a Net::Http response object, see Net::Http docs for details

#end