Plutus

A stock data centered golang library

Quick Start

Download the library into your existing golang project

    go get -u github.com/torbenconto/plutus@latest

Create a new stock Quote using the ticker of the stock you want data on.

import "github.com/torbenconto/plutus/quote"
stock, err := quote.NewQuote("AMD")
if err != nil {
	fmt.Printf("An error occured: %e", err)
}

Done!, now you can access many different aspects of the stock including price, volume, market cap, and many others!

    fmt.Println(stock.RegularMarketPrice)

Usage

Quote

import "github.com/torbenconto/plutus/quote"
stock, err := quote.NewQuote("AMD")
if err != nil {
    fmt.Printf("An error occured: %e", err)
}

Quote Data Stream

import "github.com/torbenconto/plutus/quote"
stock, err := quote.NewQuote("AMD")
if err != nil {
    fmt.Printf("An error occured: %e", err)
}
// Set delay in Milliseconds
delay := time.Second

// Call stream func using Stock object and a given delay
stream := stock.Stream(delay)

// Get updated data and print out most recent quote price. Runs infinently and returns the newest avalible quote data in the form of a plutus.Stock struct
for {
    data := <-stream
    fmt.Println(data.RegularMarketPrice, data.RegularMarketChangePercent)
}

Historical Data

import "github.com/torbenconto/plutus/historical"
import _range "github.com/torbenconto/plutus/range
import "github.com/torbenconto/plutus/interval"
// Create a new historical data object using the ticker of the stock you want data on as well as the range and interval of the data.
stock, err := historical.NewHistorical("AMD", _range.FiveDay, interval.OneMin)
if err != nil {
    fmt.Printf("An error occured: %e", err)
}

// Returns a list of all the data points as structs containing the time in unix time and the price of the stock at that time.
for _, data := range stock.Data {
    fmt.Println(data.Time, data.Open, data.Close, data.High, data.Low, data.Volume)
}

Historical Data Stream

import "github.com/torbenconto/plutus/historical"
import _range "github.com/torbenconto/plutus/range
import "github.com/torbenconto/plutus/interval"
// Create a new historical data object using the ticker of the stock you want data on as well as the range and interval of the data.
stock, err := historical.NewHistorical("AMD", _range.FiveDay, interval.OneMin)
if err != nil {
    fmt.Printf("An error occured: %e", err)
}

// Set delay in Milliseconds
delay := time.Second

// Call stream func using Stock object and a given delay
stream := stock.Stream(delay)

// Get updated data and print out most recent quote price. Runs infinently and returns the newest avalible quote data in the form of a plutus.Stock struct
for {
    data := <-stream
    fmt.Println(data.RegularMarketPrice, data.RegularMarketChangePercent)
}

Custom API url/request headers

import "github.com/torbenconto/plutus/quote"
import "github.com/torbenconto/plutus/config"

// Create a new quote object with a custom API url and request headers
stock, err := quote.NewQuote("AMD", config.Config{
    Url: "https://example.com",
    UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3",
	Cookie: "cookie1=cookie1; cookie2=cookie2",
})

// Create a new historical data object with a custom API url and request headers
stock, err := historical.NewHistorical("AMD", _range.FiveDay, interval.OneMin, config.Config{
    Url: "https://example.com",
    UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3",
    Cookie: "cookie1=cookie1; cookie2=cookie2",
})

News

import "github.com/torbenconto/plutus/news"
// Create a new news object using the ticker of the stock you want news on.
stock, err := news.NewNews("AMD")
if err != nil {
    fmt.Printf("An error occured: %e", err)
}

// Returns a list of all the news articles as structs containing the title, description, and url of the article.
for _, article := range stock.Articles {
    fmt.Println(article.Title, article.Description, article.Url)
}

REST api

The repo containing the api and information about it is contained here plutus-api

Example based documentation

Please use the provided examples to guide you to using plutus to it's full potential.

https://github.com/torbenconto/plutus/blob/master/examples

Tests

To run the tests for the library, simply run the following command in the root of the project.

    go test ./...

Future Features

• Related News Articles
• Historical Data
• Price Estimates
• Crypto Currency Support

And More..