Giter VIP home page Giter VIP logo

restock's Introduction

RESTock

What is RESTock?

RESTock is a simple tool based on python3 used to obtain the stock price data from www.alphavantage.co/

Getting started

The easiest way to run RESTock is to pull the public docker image

docker pull jrcast/restock

Or can build your own by pulling this git repository and running the following:

docker build -t restock -f Dockerfile .

Running RESTock

To run RESTock locally:

docker run -ti --rm  -e APIKEY=[YOUR_APIKEY] -e SYMBOL=AAPL -e NDAYS=5 -p 10000:10000 restock

To deploy to Kubernetes:

kubectl create secret generic apikey --from-literal=apikey=[YOUR_APIKEY]
kubectl create -f k8s

Requesting data from RESTock

Once your container or pod is running, you can get market data by sending GET requests. Note that RESTock uses port 10000 by default. Currently, RESTock only support two parameters:

Parameter Type Example
symbol str AAPL
ndays int 4

You can skip the request parameters and specify a default symbol and ndays by setting the SYMBOL and NDAYS environmental variables in the container.

Sample request: http://localhost:10000?symbol=aapl&ndays=2

Docker

Releases are automatically built and published to dockerhub: jrcast/restock

Current limitations:

  1. Returned data is currently limited to the daily close price of the specified stock symbol.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.