Skip to content

Commit

Permalink
📝 Create README
Browse files Browse the repository at this point in the history
  • Loading branch information
higorpo committed Dec 10, 2020
1 parent ff7c07e commit 996c96a
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Google News Scraper API

This repository contains the source code of an API that scraps the [Google News](https://news.google.com/) page.
It was created in Typescript (Node.js) using the Puppeteer library together with Express.

You can use the API endpoint using:

```ssh
curl -X GET https://google-news-scraper-api.herokuapp.com/news?lang=<lang-code>
```

Like

```ssh
curl -X GET https://google-news-scraper-api.herokuapp.com/news?lang=en-US
```

The API will return a JSON with an array of objects containing the following structure:

```JS
{
"news_title": string,
"news_url": string,
"newspaper_name": string,
"datetime": string | null,
}
```

**Important:** The API caches the information and keeps it for 20 minutes until the next refresh of the data.

--

Created for study purposes.

0 comments on commit 996c96a

Please sign in to comment.