World Cup API

This is a not official REST API that provides information about the 2022 FIFA World Cup! It gathers information from public sources and scrap it in an organized way, making the implementation easier.

It's totally free, and open-source, so you can collaborate with us. See CONTRIBUTING and LICENSE

OBS: We don't encourage the commercial use of this API, check FIFA Terms of Service.

Documentation

We are working on a documentation file to guide you on the use of this API, check DOCUMENTATION.md

Changelog

You can follow the changelog here

Projects made using this API

• Copa Calendar by Poveii
• IRC Bot Sopel Module by luisuribe
• NLW Copa 22 by wsminelli
• Apostas Copa do Mundo by DenisSlapelis/colantuomo (repo)
• Follow-up world cup 2022 by David-Viuche

Roadmap

• Create the database schema.
• Create a initial scrapper that setup all games, teams and group informations.
• Create an endpoint /matches that gives information about the next games
• Create an endpoint /teams that gives information about all the teams that are participating in the cup.
• Create an endpoint /groups that gives information about all the groups of the points stage.
• Create a terraform infrastructure to deploy this project on AWS
• Create a scrapper that get the score of the current match and the past matches, to consolidate the data.
• Create a job that consolidates group points based on matches
• Create a domain and setup a letsencrypt.org SSL certificate to handle HTTPs requests.
• Create a scrapper to fetch match statistics from the API.
• Create a redis cache that handle requests that didnt change to ensure that database handles the incoming traffic.
• Create a timeline with the events of the game.
• Create a rate limiter to avoid flooding on the api.
• Write unit tests for the api.
• Write a view with the instructions to use the API and host it on / route.
• Integrate with swagger
• Write a github action that test, build and deploy this application to AWS
• Include queries search on the main find endpoints