https://github.com/ahmadammarm/premier-league-api
An unofficial API client for pulling standings and fixtures (coming soon) data from the Premier League.
https://github.com/ahmadammarm/premier-league-api
api-client docker fiber football go premier-league
Last synced: 6 months ago
JSON representation
An unofficial API client for pulling standings and fixtures (coming soon) data from the Premier League.
- Host: GitHub
- URL: https://github.com/ahmadammarm/premier-league-api
- Owner: ahmadammarm
- Created: 2025-04-11T13:36:23.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-12T14:50:53.000Z (6 months ago)
- Last Synced: 2025-04-12T15:40:49.840Z (6 months ago)
- Topics: api-client, docker, fiber, football, go, premier-league
- Language: Go
- Homepage:
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Premier League API
This is an unofficial Premier League API client for pulling standings, and fixtures data from the Premier League. The API is built using Go and Fiber, and the data is scraped from the Premier League website.
API Endpoints
The application provides the following API endpoints:
- `GET /api/standings`
- `GET /api/standings/position/:position` Example: /api/standings/position/1
- `GET /api/standings/team/:team` Example: /api/standings/team/liverpool
- `GET /api/standings/zone/:zone` Example: /api/standings/zone/champions (champions, europa, conference, relegation)
The JSON object contains an array of strings, where each string represents a team's position, name, number of games played, wins, draws, losses, goal difference, and total points.
The API returns a JSON object with the following structure:
[
"position",
"team",
"played",
"wins",
"draws",
"losses",
"goal_difference",
"points"
]
Getting Started without Docker
1. Clone the repository:
```sh
git clone https://github.com/ahmadammarm/premier-league-api.git
```
2. Navigate to the project directory:
```sh
cd premier-league-api
```
3. Install the project dependencies:
```sh
go mod download
```
4. Run the project:
```sh
go run cmd/main.go
```
Getting Started with Docker
1. Clone the repository:
```sh
git clone https://github.com/ahmadammarm/premier-league-api.git
```
2. Navigate to the project directory:
```sh
cd premier-league-api
```
3. Build the docker image:
```sh
docker build -t premier-league-api:your_tag .
```
4. Start the container with port forwarding from the image:
```sh
docker run -p 8080:8080 premier-league-api:your_tag
```
The project will be available at:
`http://localhost:8080`
5. To stop the container:
```sh
docker container stop your_container_name
```
### This project still needs more improvements and also available for your contributions, thank you :)
Disclaimer
This project is created solely for learning and educational purposes. It is not intended for production-level use or commercial applications.