Skip to content

rvbabilonia/beta-dog

Repository files navigation

beta-dog

Build Status

Introduction

"Because the beta always follows the alpha."

Beta-Dog is a scraper for the New Zealand stock market. It fetches all the available instruments/securities and sorts them according to price-to-earning ratio or earnings per share to aid a newbie investor.

Usage

  1. To view all the instruments, go to https://beta-dog.vincenzolabs.org/api/v1/instruments.

  2. Available query parameters are filter which can be ALL (default), EQUITIES or FUNDS and order which can be DEFAULT (default), PE_RATIO or EPS e.g. https://beta-dog.vincenzolabs.org/api/v1/instruments?filter=EQUITIES&order=EPS.

  3. To view Swagger UI, go to https://beta-dog.vincenzolabs.org/api/v1/swagger-ui-custom.html.

Infrastructure

Beta-Dog is Dockerized (docker pull rvbabilonia/beta-dog) and hosted in https://hub.docker.com/r/rvbabilonia/beta-dog.

A running instance is running on a Kubernetes cluster provided by https://kubesail.com.

DNS record is stored in Amazon Route 53 and SSL certificate is provided by AWS Certificate Manager.