DOCUMENTATION.md

API Documentation ================================== A guide to using our APIs for your free and open-source project. --------------------------------------------------- --------------------------------------------------- The Guardian API ----------------

Description

This is just a little API that simplifies the existing Guardian API for interaction with JavaScript.

Usage

*http://thescoop.io/guardian_feeds.php?
start_time=2012-12-31&
end_time=2013-12-31&
section=uk-news&
keyword=the%20scoop*

'start_time' - Takes a hyphen separated date and symbolises the first date boundary between which to find news.
'end_time' - Takes a hyphen separated date and symbolises the last date boundary between which to find news.
'section' - Defines a section (AKA a category). A list of valid sections can be found in the root of the repo.
'keyword' - A search term to find related articles. EG. 'bike' would return stories that mentioned 'bike'

The Daily Guardian API

Description

An API that returns <=10 news stories for each day between two dates. This can be used to get more news stories, but it has to query the API for each day, so it may take a while to receive data. Due to the resources this requires from the server, output has been capped to 200 days.

Usage

*http://thescoop.io/guardian_feeds_daily.php?
start_time=2012-12-31&
end_time=2013-12-31&
section=uk-news&
keyword=best%20website*

'start_time' - Takes a hyphen separated date and symbolises the first date boundary between which to find news.
'end_time' - Takes a hyphen separated date and symbolises the last date boundary between which to find news.
'section' - Defines a section (AKA a category). A list of valid sections can be found in the root of the repo.
'keyword' - A search term to find related articles. EG. 'car' would return stories that mentioned 'car'

The OTS API

Description

The OTS API will take a URL, parse the URL for the largest body of text