Skip to content

A news site scraping API with a few different endpoints that provide links to articles related to energy prices

License

Notifications You must be signed in to change notification settings

Energy-Price-News-API/energy-prices-api

Repository files navigation

Energy Price News API

All Contributors

A project to create a public API that scrapes news sites for anything concerning the changes in energy prices.

This project's secondary aim is to help beginners learn how to contribute to open source projects and will be purposely kept as basic as possible.

Up to date version hosted at: RapidAPI Hub

Original Idea

This project was first thought up after watching this video by Ania KubΓ³w, so many thanks to her for the inspiration. Be sure to check the channel out for more easy to follow tutorials!

Planned Features

  • Links to articles
  • End points for specific sources
  • Thorough documentation
  • An open and inviting issue-board to encourage discussion of future features

Language & Prerequisites

Warning The above mentioned Node version is important to be able to run this project properly as it makes use of some newer functions. Also, if you are not using linux, the JSON formatter browser extension is HIGHLY recommended.

Installation

  • Fork this repo and then clone your fork to an empty local directory using SSH
  • run:
npm install
  • Now the basis of the project is here and can already be viewed by running:
npm run dev
  • You may view the various endpoints by opening localhost:8000 in your browser and appending the desired route
    • e.g. localhost:8000/api/news

Contribution

The aim for this project it to be very easy to access, so please have a look through the contribution guide if you need an idea how or where to get started.

API documentation

Some rudimentary and development focused documentation on using the API can be found here, where you have listed the various endpoints available and how to make use of any additional features.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Soshun Esaki
Soshun Esaki

πŸ’»
nulad
nulad

πŸ’» πŸ€”
takanome_dev
takanome_dev

πŸ’» ⚠️ πŸ€” πŸ“– πŸš‡ πŸ”§ πŸ”¬ πŸ‘€ πŸ’¬ 🚧 πŸ“† πŸ‘€
AyushiN
AyushiN

πŸ’»
Yoshemith Castellanos Irribarren
Yoshemith Castellanos Irribarren

πŸ’» πŸ€” πŸš‡ πŸ–‹ 🎨
dbsaw
dbsaw

πŸ’» πŸ€”
Diego Cordoba
Diego Cordoba

πŸ’»
Anu
Anu

πŸ“–
James Neff
James Neff

πŸ’»
Jon Rutter
Jon Rutter

πŸ’»
Roberto
Roberto

πŸ’» πŸ€”
Elmir Ismayilov
Elmir Ismayilov

πŸ’»
RamΓ³n Soria
RamΓ³n Soria

πŸ’»
alesbe
alesbe

πŸ’» πŸ›
kvaithin
kvaithin

πŸ’»
apurva-hub
apurva-hub

πŸ’»
cfkim
cfkim

πŸ’» πŸ€”
Ghada
Ghada

πŸ’»
Klesta Luli
Klesta Luli

πŸ’»
Jayavardhan
Jayavardhan

πŸ’»
Dalu46
Dalu46

πŸ’»
Ian
Ian

πŸ’»
Muiz Uvais
Muiz Uvais

πŸ’»
scottjwilson
scottjwilson

πŸ’» πŸ”Œ
k-puchala
k-puchala

πŸ’»
snehashish-ghosh98
snehashish-ghosh98

πŸ’»
nomandhoni-cs
nomandhoni-cs

πŸ’»
Rohan Nair
Rohan Nair

πŸ’»
mrajen27
mrajen27

πŸ’»
Ketan Parmar
Ketan Parmar

πŸ’»
Z Adil Khwaja
Z Adil Khwaja

πŸ’»
MuminAhmadKhan
MuminAhmadKhan

πŸ’»
Stefan Talbot
Stefan Talbot

πŸ’» πŸ€”
Dev Parikh
Dev Parikh

πŸ’»
Will12
Will12

πŸ’» πŸ’‘
Rupali Haldiya
Rupali Haldiya

πŸ›
Ashwin Acharya
Ashwin Acharya

πŸ’»
Leon Lafayette
Leon Lafayette

πŸ’» πŸ€” πŸ”¬ ⚠️
Sayam Gandhak
Sayam Gandhak

πŸ’» ⚠️
reny_pacheco
reny_pacheco

πŸ’» ⚠️ πŸ€”
ChinmayKumbhare
ChinmayKumbhare

πŸ’»
Chandan Kumar Mandal
Chandan Kumar Mandal

πŸ’»
Hamza Nawab
Hamza Nawab

πŸ’» ⚠️
Andres Cespedes Morales
Andres Cespedes Morales

🚧
Madalin Ignisca
Madalin Ignisca

πŸš‡ πŸ§‘β€πŸ«
Artur Bauer
Artur Bauer

πŸ’»
Aabhas Sao
Aabhas Sao

πŸ’»
Susanna
Susanna

πŸ’»
Ignacio Alvarado
Ignacio Alvarado

πŸ’»
Łukasz Mielczarek
Łukasz Mielczarek

πŸ’»
Anubhav Adhikari
Anubhav Adhikari

πŸ’»
Rahul Kumar
Rahul Kumar

πŸ’»
Michael
Michael

πŸ“–
Sohaib Chebah
Sohaib Chebah

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

About

A news site scraping API with a few different endpoints that provide links to articles related to energy prices

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks