StockklyAPI is a free, near real-time, RestAPI for providing prices for stocks (FTSE100, NASDAQ), crypto-currencies (BTC), funds and precious metals (e.g. GOLD, SILVER).
Currently hosted at: https://stockklyapi.azurewebsites.net/api/
| Verb | Endpoint | Description | Authorised |
|---|---|---|---|
| GET | /api/prices/:ticker | Find a single Price using the ticker | No |
| GET | /api/pricesHistorical/:ticker | Returns last 90 days worth of prices for ticker | No |
| GET | /api/holdings | Returns all user holdings. | Yes |
| GET | /api/holdings/:ticker | Returns user holdings for a ticker | Yes |
The below are dependancies for the StockklyAPI.
These can be constructed via the docker-compose in the dependancies folder:
- Ensure you have docker installed.
cd dependanciesdocker-compose up -d
You can build the API and host via a docker container, either locate the image on DockerHub or run
docker build -t stockkly_api .docker run -d --name stockkly_api -p 5000:5000 stockkly_api
- Set up your local environment using
make create-local-env - Update your local environment details
run flask
StockkyAPI is an open source project for collating and providing data from various sources. Despite best attempts, data provided is not be suitable for decison making and should be considered as test. Stockkly also does not gurantee that the data is live. Price delays are in some cases 15 mins.