# Py-stocks-api

Py-stocks-api is a lightweight self-hosted web service that wraps the yfinance market-data library to provide simple endpoints for stock price history and ticker information. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1937/py-stocks-api

## Description

Py-stocks-api is a lightweight self-hosted web service that wraps the yfinance market-data library to provide simple endpoints for stock price history and ticker information.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

8/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (last commit 1750 days ago)
- Popular: 0 (0 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- GitHub: https://github.com/patrickstigler/py-stocks
- Docker Hub: https://hub.docker.com/r/patrickstigler/py-stocks-api
- Unraid: https://ca.unraid.net/apps/py-stocks-api-0ew5rp80yj2yuo?q=py-stocks-api

## Common questions

### Which port do I need to expose when running py-stocks-api in Docker?

Use port 8000. The README shows running the container with port 8000 mapped to the host.

### Can I change the data interval for the download endpoint?

Yes. The /download endpoint accepts an interval parameter, and its default value is 1d.

### Does py-stocks-api need authentication or reverse-proxy configuration?

No authentication or reverse-proxy settings are documented. The only stated requirement is to expose port 8000.

### Does py-stocks-api include a local database or backup mechanism?

No local database or backup mechanism is documented. It is described as a minimal yfinance wrapper that exposes HTTP endpoints for fetched data.

---
Source: Our Local Host (https://ourlocalhost.com/app/1937/py-stocks-api), the self-hosted and open-source app directory.
