Welcome to FeedRadar.IO API’s documentation!¶
| Author: | Jonathan DEKHTIAR |
|---|---|
| Issues: | https://github.com/DEKHTIARJonathan/Dataradar-API-Documentation/issues |
| License: | GNU GPL v3 |
| Version: | 1.0 |
| Generated: | Aug 11, 2017 |
Introduction¶
FeedRadar.IO is an open access platform created in order to share freely and widely ressources concerning data mining, data science, machine learning, computer vision and so on. I really hope this platform will become a must-see for every student in data science and but also for data analysts and data scientists.
In order to widely open access to the ressources, the platform provides an API access. It’s free to use, you just need an API Key which is available upon request at : contact@feedradar.io
If you need any specific method to crawl the platform, feel free to contact me. I’ll be glad to provide some help for your projects.
Our Motto : Keep Sharing and Spreading Knowledge
Fair Use policy¶
Please do not change the links given by the API. It is a non negligeable way to allow people discover this amazing platform. We would really appreciate that you do not change the redirection to our platform instead of directly redirect to the ressources.
Sharing is the purpose of this platform, please respect the work done to keep it alive.
Our Motto : Keep Sharing and Spreading Knowledge
API Documentation¶
The REST API provide programmatic access to read FeedRadar.IO data.
Please only access the API over HTTPS and don’t share your API Key.
An API Key is freely available over request, feel free to ask.
The REST API is listening over GET Requests and responses are available in JSON.
How Can I Get an API Key ?¶
I’m sure that you have an awesome project idea. Send me an email : contact@feedradar.io with a link to your twitter account (if you have one) and a link to your website (if you have one). Feel free to explain me a bit of your project, I’m always very happy to hear about them.
I have some ideas to improve the platform => What can I do ?¶
I will absolutely delighted to hear about them and will do my best to implement new ideas : contact@feedradar.io
I have an improvement request => What can I do ?¶
I will absolutely delighted to hear about them and will do my best to implement new ideas : contact@feedradar.io
GET article/id¶
Returns a single Article, specified by the id parameter.
The Article will be returned in JSON with the following data: title, id, domain and a link to the ressource.
Resource URL¶
https://www.feedradar.io/api/v1/article/id/
curl https://www.feedradar.io/api/v1/article/id/?APIKey=00000000-0000-0000-0000-000000000000&id=XXXXX
Parameters¶
| Parameters | Description |
|---|---|
| APIKey | Your Unique API Key |
| id | The ID of the Ressource for which to return results for |
Example Result¶
{
"status":"success",
"uri":"/api/v1/article/id/",
"status_code":"200",
"output":{
"id": "24",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title",
"link": "https://www.feedradar.io/article.php?postID=24"
}
}
POST article/add¶
Post a ressource to the platform. Title and Link are taken as input.
The API will return the id assigned to the ressource.
Important information¶
Every addition to the platform is manually checked and approved before being publicly visible on the platform. This action is normally done under 24hours.
This review process has been set up in order to keep the high quality of the contents published. We think that fewer publication with a high added-value is more interesting than the opposite situation.
Resource URL¶
https://www.feedradar.io/api/v1/article/add/
curl -H "Content-Type: application/json" -X POST -d '{"APIKey":"00000000-0000-0000-0000-000000000000","link":"http://example.com", "title":"My Super Article"}' https://www.feedradar.io/api/v1/article/add/
Here is the JSON given as input in a more readable manner:
{
"APIKey":"00000000-0000-0000-0000-000000000000",
"link":"http://www.example.com",
"title":"My Super Article"
}
Parameters¶
| Parameters | Description |
|---|---|
| APIKey | Your Unique API Key |
| link | The ressource’s full URL that you are posting to the platform |
| title | The ressource’s title that will be displayed |
Example Result¶
{
"status":"success",
"uri":"/api/v1/article/add/",
"status_code":"200",
"link":"http://example.com",
"title":"My Super Article",
"id":"XXX"
}
GET articles/all¶
Returns a collection of every Articles ever posted on the platform. They are sorted from the newest to the oldest.
Each Article will be returned in JSON with the following data: title, id, domain and a link to the ressource.
Resource URL¶
https://www.feedradar.io/api/v1/articles/all/
curl https://www.feedradar.io/api/v1/articles/all/?APIKey=00000000-0000-0000-0000-000000000000
Parameters¶
| Parameters | Description |
|---|---|
| APIKey | Your Unique API Key |
Example Result¶
{
"status": "success",
"uri": "/api/v1/articles/all/",
"status_code": "200",
"output": [
{
"id": "1",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title",
"link": "https://www.feedradar.io/article.php?postID=1"
},
{
"id": "2",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title",
"link": "https://www.feedradar.io/article.php?postID=2"
},
{
"id": "718",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title",
"link": "https://www.feedradar.io/article.php?postID=718"
}
]
}
GET articles/list¶
Returns a collection of the n_articles (an integer > 0) newest Articles. They are sorted from the newest to the oldest.
Each Article will be returned in JSON with the following data: title, id, domain and a link to the ressource.
Resource URL¶
https://www.feedradar.io/api/v1/articles/list/
curl https://www.feedradar.io/api/v1/articles/list/?APIKey=00000000-0000-0000-0000-000000000000&n_articles=2
Parameters¶
| Parameters | Description |
|---|---|
| APIKey | Your Unique API Key |
| n_articles | The desired quantity of articles returned by the API |
Example Result¶
{
"status": "success",
"uri": "/api/v1/articles/list/",
"status_code": "200",
"output": [
{
"id": "WWW",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title",
"link": "https://www.feedradar.io/article.php?postID=WWW"
},
{
"id": "YYY",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title",
"link": "https://www.feedradar.io/article.php?postID=YYY"
}
]
}
GET article/search¶
Returns a collection of relevant Articles matching a specified query. They are sorted from the newest to the oldest.
Each Article will be returned in JSON with the following data: title, id, domain and a link to the ressource.
Resource URL¶
https://www.feedradar.io/api/v1/articles/search/
curl https://www.feedradar.io/api/v1/articles/search/?APIKey=00000000-0000-0000-0000-000000000000&query=Data%20Science
The string given in argument with query=”xxxxxxxx” must be URL ENCODED.
Parameters¶
| Parameters | Description |
|---|---|
| APIKey | Your Unique API Key |
| query | The desired search query to perform on the database |
Example Result¶
{
"status": "success",
"uri": "/api/v1/articles/search/",
"status_code": "200",
"query" : "Searched Query",
"output": [
{
"id": "YYY",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title - Searched Query Related",
"link": "https://www.feedradar.io/article.php?postID=YYY"
},
{
"id": "WWW",
"when":"XXXX/XX/XX XX:XX",
"domain": "domain.tld",
"title": "Article / Blog post title - Searched Query Related",
"link": "https://www.feedradar.io/article.php?postID=WWW"
}
]
}