aylien-news-api
Advanced tools
The_AYLIEN_News_API_is_the_most_powerful_way_of_sourcing_searching_and_syndicating_analyzed_and_enriched_news_content__It_is_accessed_by_sending_HTTP_requests_to_our_server_which_returns_information_to_your_client_
Readme
AylienNewsApi - JavaScript client for aylien-news-api The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
This SDK is automatically generated by the OpenAPI Generator project:
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install aylien-news-api --save
Finally, you need to build the module:
npm run build
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm link
To use the link you just defined in your project, switch to the directory you want to use your aylien-news-api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var AylienNewsApi = require('aylien-news-api');
var defaultClient = AylienNewsApi.ApiClient.instance;
// Configure API key authorization: app_id
var app_id = defaultClient.authentications['app_id'];
app_id.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//app_id.apiKeyPrefix['X-AYLIEN-NewsAPI-Application-ID'] = "Token"
// Configure API key authorization: app_key
var app_key = defaultClient.authentications['app_key'];
app_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//app_key.apiKeyPrefix['X-AYLIEN-NewsAPI-Application-Key'] = "Token"
var api = new AylienNewsApi.DefaultApi()
var body = null; // {Object} /stories body schema to perform an advanced search with logical operators and nested objects.
var opts = {
'publishedAtStart': "publishedAtStart_example", // {String} This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
'publishedAtEnd': "publishedAtEnd_example", // {String} This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
'_return': ["null"], // {[String]} This parameter is used for specifying return fields.
'sortBy': "'published_at'", // {String} This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
'sortDirection': "'desc'", // {String} This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
'cursor': "'*'", // {String} This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
'perPage': 10 // {Number} This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.advancedListStories(body, opts, callback);
All URIs are relative to https://api.aylien.com/news
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AylienNewsApi.DefaultApi | advancedListStories | POST /stories | List Stories |
| AylienNewsApi.DefaultApi | listAutocompletes | GET /autocompletes | List autocompletes |
| AylienNewsApi.DefaultApi | listClusters | GET /clusters | List Clusters |
| AylienNewsApi.DefaultApi | listHistograms | GET /histograms | List histograms |
| AylienNewsApi.DefaultApi | listRelatedStoriesGet | GET /related_stories | |
| AylienNewsApi.DefaultApi | listRelatedStoriesPost | POST /related_stories | |
| AylienNewsApi.DefaultApi | listStories | GET /stories | List Stories |
| AylienNewsApi.DefaultApi | listTimeSeries | GET /time_series | List time series |
| AylienNewsApi.DefaultApi | listTrends | GET /trends | List trends |
FAQs
The_AYLIEN_News_API_is_the_most_powerful_way_of_sourcing_searching_and_syndicating_analyzed_and_enriched_news_content__It_is_accessed_by_sending_HTTP_requests_to_our_server_which_returns_information_to_your_client_
The npm package aylien-news-api receives a total of 64 weekly downloads. As such, aylien-news-api popularity was classified as not popular.
We found that aylien-news-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.