README.md

Binge - News Aggregation API

API Endpoint

Topic Endpoints

Update Topic Information

Update and aggregate news content based on topics. Use the endpoint `fetch_articles` to request an aggregation of trending news based on Binge topics.

Return Topic Information

Given a `topic` parameter, it will return the associated topic information. `topic` is case-sensitive. ``` GET http://binge.azurewebsites.net/api/topics?topic=Your%20Topic ```

Return All Topic Information

It will return the all topic information in the database. ``` GET http://binge.azurewebsites.net/api/all_topics ```

Article Endpoints

Return Article Information

Given a `topic` parameter, it will return the associated articles in an Array. `topic` is case-sensitive. To receive articles for more than one topic, make a comma separated list past using the `favorite` parameter. ``` GET http://binge.azurewebsites.net/api/articles?topic=Your%20Topic # Single Topic GET http://binge.azurewebsites.net/api/articles?favorite=Topic%20One,Topic%20Two,Topic%20Three # Multiple Topic ```

Return All Article Information

It will return the all article information in the database. ``` GET http://binge.azurewebsites.net/api/all_articles ```

Add New Article

Will add a new article given the necessary parameters: * `topic` - Topic the article belongs to * `title` - Title of the article * `publisher` - Source publisher of article * `publisher_url` - Article URL * `image_url` - Preview image URL * `type` - Type of article (0 - Text article, 1 - Video article)

GET http://binge.azurewebsites.net/api/add_article?topic=Your%20Topic&title=Your%20Title&publisher=Publisher&publisher_url=Publisher%20Url&image_url=Image%20Url&type=0