0.0
Low commit activity in last 3 years
No release in over a year
Client library for polygon.io's REST and Websocket API's. Polygon IO is an API for market data. Modernized version
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 2.7
~> 2.11
~> 5.0
~> 13.0
~> 0.80
~> 5.1

Runtime

~> 6.0, >= 6.0.2.2
~> 1.2, >= 1.2.0
~> 1.2, >= 1.2.2
~> 1.2, >= 1.2.7
~> 0.17, >= 0.17.3
~> 0.13, >= 0.13.1
~> 3.10, >= 3.10.1
~> 0.1, >= 0.1.4
~> 0.7, >= 0.7.1
 Project Readme

Polygonio (Ruby)

Table of Contents

  • Background
  • Installation
  • Usage

Background

This is a client library for Polygon.io. Please see Polygon.io

Installation

Add this line to your application's Gemfile:

gem 'polygonio'

And then execute:

$ bundle install

Usage

Create an instance of the client:

All methods follow the documentation found [here]:https://polygon.io/docs pretty closely:

client = Polygonio::Rest::Client.new(api_key)

# See tests for a full reference of all of methods
client.reference.tickers.list

client.stocks.list_exchanges

client.forex.historic_ticks

client.crypto.list # list exchanges

Polygonio::Websocket::Client.new("crypto", api_key).subscribe("XQ.BTC-USD") do |event|
  pp "Incoming message"
  pp event
end

Using delayed websockets. If your account only supports delayed feeds you will need to use the delayed websocket endpoint

Polygonio::Websocket::Client.new("stocks", api_key, delayed: true).subscribe("AM.*,A.*,T.*") do |event|
  pp "Incoming message"
  pp event
end