aylien_news_api 4.1.1 → 4.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +100 -31
- data/docs/AggregatedSentiment.md +21 -0
- data/docs/DefaultApi.md +491 -7
- data/docs/DeprecatedEntities.md +19 -0
- data/docs/DeprecatedEntity.md +33 -0
- data/docs/DeprecatedEntitySurfaceForm.md +21 -0
- data/docs/DeprecatedRelatedStories.md +27 -0
- data/docs/DeprecatedStories.md +25 -0
- data/docs/DeprecatedStory.md +61 -0
- data/docs/Entity.md +16 -8
- data/docs/EntityInText.md +19 -0
- data/docs/EntityLinks.md +6 -2
- data/docs/EntityMention.md +19 -0
- data/docs/EntityMentionIndex.md +19 -0
- data/docs/EntitySentiment.md +19 -0
- data/docs/EntitySurfaceForm.md +21 -0
- data/docs/Logicals.md +21 -0
- data/docs/NestedEntity.md +33 -0
- data/docs/Parameter.md +127 -0
- data/docs/Query.md +31 -0
- data/docs/Story.md +4 -2
- data/docs/TimeSeries.md +3 -1
- data/docs/Trend.md +3 -1
- data/lib/aylien_news_api.rb +16 -1
- data/lib/aylien_news_api/api/default_api.rb +728 -11
- data/lib/aylien_news_api/models/aggregated_sentiment.rb +228 -0
- data/lib/aylien_news_api/models/deprecated_entities.rb +221 -0
- data/lib/aylien_news_api/models/deprecated_entity.rb +314 -0
- data/lib/aylien_news_api/models/deprecated_entity_surface_form.rb +244 -0
- data/lib/aylien_news_api/models/deprecated_related_stories.rb +260 -0
- data/lib/aylien_news_api/models/deprecated_stories.rb +252 -0
- data/lib/aylien_news_api/models/deprecated_story.rb +429 -0
- data/lib/aylien_news_api/models/entity.rb +96 -44
- data/lib/aylien_news_api/models/entity_in_text.rb +217 -0
- data/lib/aylien_news_api/models/entity_links.rb +25 -5
- data/lib/aylien_news_api/models/entity_mention.rb +215 -0
- data/lib/aylien_news_api/models/entity_mention_index.rb +265 -0
- data/lib/aylien_news_api/models/entity_sentiment.rb +240 -0
- data/lib/aylien_news_api/models/entity_surface_form.rb +244 -0
- data/lib/aylien_news_api/models/logicals.rb +230 -0
- data/lib/aylien_news_api/models/nested_entity.rb +278 -0
- data/lib/aylien_news_api/models/parameter.rb +701 -0
- data/lib/aylien_news_api/models/query.rb +271 -0
- data/lib/aylien_news_api/models/related_stories.rb +1 -0
- data/lib/aylien_news_api/models/stories.rb +1 -0
- data/lib/aylien_news_api/models/story.rb +19 -6
- data/lib/aylien_news_api/models/time_series.rb +13 -4
- data/lib/aylien_news_api/models/trend.rb +13 -4
- data/lib/aylien_news_api/version.rb +1 -1
- data/spec/api/default_api_spec.rb +226 -3
- data/spec/models/aggregated_sentiment_spec.rb +53 -0
- data/spec/models/deprecated_entities_spec.rb +47 -0
- data/spec/models/deprecated_entity_spec.rb +89 -0
- data/spec/models/deprecated_entity_surface_form_spec.rb +53 -0
- data/spec/models/deprecated_related_stories_spec.rb +71 -0
- data/spec/models/deprecated_stories_spec.rb +65 -0
- data/spec/models/deprecated_story_spec.rb +173 -0
- data/spec/models/entity_in_text_spec.rb +47 -0
- data/spec/models/entity_links_spec.rb +12 -0
- data/spec/models/entity_mention_index_spec.rb +47 -0
- data/spec/models/entity_mention_spec.rb +47 -0
- data/spec/models/entity_sentiment_spec.rb +47 -0
- data/spec/models/entity_spec.rb +28 -4
- data/spec/models/entity_surface_form_spec.rb +53 -0
- data/spec/models/logicals_spec.rb +53 -0
- data/spec/models/nested_entity_spec.rb +89 -0
- data/spec/models/parameter_spec.rb +371 -0
- data/spec/models/query_spec.rb +83 -0
- data/spec/models/story_spec.rb +6 -0
- data/spec/models/time_series_spec.rb +6 -0
- data/spec/models/trend_spec.rb +6 -0
- metadata +66 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e176f5b1e738c3030926956cb506f764011dec94ef941f919dc8a3e9d4867548
|
4
|
+
data.tar.gz: adc5ecf9f8e8f0830c61ac641cffd833852726a977e45845aa78361716f66571
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d5c7cd99b6bdeae64f2bc452ea6d28297a39a0370b60d4956a0e2624f1655fae77e85bf5aae9cdefda19373eb6fc7b359a69f5b2aa55f3ecbaea1eabd0cb5073
|
7
|
+
data.tar.gz: 83323addc9aa798e9ae1375246daad57e5df13f4f5465fe17be0a6f8030bf84ead2d9dd05eee08cea01f69c7f0bf677f15192fb3d20aa96c4da01d1726053e2a
|
data/README.md
CHANGED
@@ -1,22 +1,46 @@
|
|
1
|
-
#
|
1
|
+
# aylien_news_api
|
2
2
|
|
3
|
-
|
3
|
+
AylienNewsApi - the Ruby gem for the AYLIEN News API
|
4
4
|
|
5
|
-
|
5
|
+
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.
|
6
6
|
|
7
|
-
|
7
|
+
|
8
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
9
|
+
|
10
|
+
- API version: 3.0
|
11
|
+
- Package version: 4.5.0
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
|
+
For more information, please visit [https://newsapi.aylien.com/](https://newsapi.aylien.com/)
|
8
14
|
|
9
15
|
## Installation
|
10
16
|
|
11
|
-
|
17
|
+
### Build a gem
|
18
|
+
|
19
|
+
To build the Ruby code into a gem:
|
20
|
+
|
21
|
+
```shell
|
22
|
+
gem build aylien_news_api.gemspec
|
23
|
+
```
|
24
|
+
|
25
|
+
Then either install the gem locally:
|
12
26
|
|
13
|
-
|
27
|
+
```shell
|
28
|
+
gem install ./aylien_news_api-4.5.0.gem
|
29
|
+
```
|
30
|
+
|
31
|
+
(for development, run `gem install --dev ./aylien_news_api-4.5.0.gem` to install the development dependencies)
|
32
|
+
|
33
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
34
|
+
|
35
|
+
Finally add this to the Gemfile:
|
36
|
+
|
37
|
+
gem 'aylien_news_api', '~> 4.5.0'
|
14
38
|
|
15
39
|
### Install from Git
|
16
40
|
|
17
|
-
If the Ruby gem is hosted at a git repository: https://github.com/
|
41
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
18
42
|
|
19
|
-
gem 'aylien_news_api', :git => 'https://github.com/
|
43
|
+
gem 'aylien_news_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
20
44
|
|
21
45
|
### Include the Ruby code directly
|
22
46
|
|
@@ -29,39 +53,44 @@ ruby -Ilib script.rb
|
|
29
53
|
## Getting Started
|
30
54
|
|
31
55
|
Please follow the [installation](#installation) procedure and then run the following code:
|
56
|
+
|
32
57
|
```ruby
|
33
58
|
# Load the gem
|
34
59
|
require 'aylien_news_api'
|
35
60
|
|
36
61
|
# Setup authorization
|
37
62
|
AylienNewsApi.configure do |config|
|
38
|
-
|
39
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-
|
63
|
+
# Configure API key authorization: app_id
|
64
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
65
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
66
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
67
|
+
|
68
|
+
# Configure API key authorization: app_key
|
69
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
70
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
71
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
40
72
|
end
|
41
73
|
|
42
74
|
api_instance = AylienNewsApi::DefaultApi.new
|
43
|
-
|
75
|
+
unknown_base_type = {"$and":[{"$or":[{"body":{"$text":"Tim Cook"}},{"social.shares.count.reddit.max":{"$gte":5000,"$boost":5}}]},{"entity":{"$and":[{"name":{"$text":"Apple","$boost":2}},{"$not":[{"type":{"$eq":"Fruit"}}]}]}}]} # UNKNOWN_BASE_TYPE | /stories body schema to perform an advanced search with logical operators and nested objects.
|
44
76
|
opts = {
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
]
|
51
|
-
|
52
|
-
sort_by: 'social_shares_count.facebook'
|
77
|
+
published_at_start: 'published_at_start_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).
|
78
|
+
published_at_end: 'published_at_end_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).
|
79
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
80
|
+
sort_by: '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).
|
81
|
+
sort_direction: '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).
|
82
|
+
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).
|
83
|
+
per_page: 10 # Integer | 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)
|
53
84
|
}
|
54
85
|
|
55
|
-
|
56
86
|
begin
|
57
|
-
|
58
|
-
result.
|
59
|
-
|
60
|
-
end
|
87
|
+
#List Stories
|
88
|
+
result = api_instance.advanced_list_stories(unknown_base_type, opts)
|
89
|
+
p result
|
61
90
|
rescue AylienNewsApi::ApiError => e
|
62
|
-
puts "Exception when calling DefaultApi->
|
63
|
-
puts e.response_body
|
91
|
+
puts "Exception when calling DefaultApi->advanced_list_stories: #{e}"
|
64
92
|
end
|
93
|
+
|
65
94
|
```
|
66
95
|
|
67
96
|
## Documentation for API Endpoints
|
@@ -70,11 +99,12 @@ All URIs are relative to *https://api.aylien.com/news*
|
|
70
99
|
|
71
100
|
Class | Method | HTTP request | Description
|
72
101
|
------------ | ------------- | ------------- | -------------
|
102
|
+
*AylienNewsApi::DefaultApi* | [**advanced_list_stories**](docs/DefaultApi.md#advanced_list_stories) | **POST** /stories | List Stories
|
73
103
|
*AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
74
104
|
*AylienNewsApi::DefaultApi* | [**list_clusters**](docs/DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
|
75
|
-
*AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
|
76
105
|
*AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
77
|
-
*AylienNewsApi::DefaultApi* | [**
|
106
|
+
*AylienNewsApi::DefaultApi* | [**list_related_stories_get**](docs/DefaultApi.md#list_related_stories_get) | **GET** /related_stories |
|
107
|
+
*AylienNewsApi::DefaultApi* | [**list_related_stories_post**](docs/DefaultApi.md#list_related_stories_post) | **POST** /related_stories |
|
78
108
|
*AylienNewsApi::DefaultApi* | [**list_stories**](docs/DefaultApi.md#list_stories) | **GET** /stories | List Stories
|
79
109
|
*AylienNewsApi::DefaultApi* | [**list_time_series**](docs/DefaultApi.md#list_time_series) | **GET** /time_series | List time series
|
80
110
|
*AylienNewsApi::DefaultApi* | [**list_trends**](docs/DefaultApi.md#list_trends) | **GET** /trends | List trends
|
@@ -82,30 +112,49 @@ Class | Method | HTTP request | Description
|
|
82
112
|
|
83
113
|
## Documentation for Models
|
84
114
|
|
115
|
+
- [AylienNewsApi::AggregatedSentiment](docs/AggregatedSentiment.md)
|
85
116
|
- [AylienNewsApi::Author](docs/Author.md)
|
86
117
|
- [AylienNewsApi::Autocomplete](docs/Autocomplete.md)
|
87
118
|
- [AylienNewsApi::Autocompletes](docs/Autocompletes.md)
|
88
119
|
- [AylienNewsApi::Category](docs/Category.md)
|
89
120
|
- [AylienNewsApi::CategoryLinks](docs/CategoryLinks.md)
|
121
|
+
- [AylienNewsApi::CategoryTaxonomy](docs/CategoryTaxonomy.md)
|
90
122
|
- [AylienNewsApi::Cluster](docs/Cluster.md)
|
91
123
|
- [AylienNewsApi::Clusters](docs/Clusters.md)
|
92
|
-
- [AylienNewsApi::
|
93
|
-
- [AylienNewsApi::
|
124
|
+
- [AylienNewsApi::DeprecatedEntities](docs/DeprecatedEntities.md)
|
125
|
+
- [AylienNewsApi::DeprecatedEntity](docs/DeprecatedEntity.md)
|
126
|
+
- [AylienNewsApi::DeprecatedEntitySurfaceForm](docs/DeprecatedEntitySurfaceForm.md)
|
127
|
+
- [AylienNewsApi::DeprecatedRelatedStories](docs/DeprecatedRelatedStories.md)
|
128
|
+
- [AylienNewsApi::DeprecatedStories](docs/DeprecatedStories.md)
|
129
|
+
- [AylienNewsApi::DeprecatedStory](docs/DeprecatedStory.md)
|
94
130
|
- [AylienNewsApi::Entity](docs/Entity.md)
|
131
|
+
- [AylienNewsApi::EntityInText](docs/EntityInText.md)
|
95
132
|
- [AylienNewsApi::EntityLinks](docs/EntityLinks.md)
|
133
|
+
- [AylienNewsApi::EntityMention](docs/EntityMention.md)
|
134
|
+
- [AylienNewsApi::EntityMentionIndex](docs/EntityMentionIndex.md)
|
135
|
+
- [AylienNewsApi::EntitySentiment](docs/EntitySentiment.md)
|
136
|
+
- [AylienNewsApi::EntitySurfaceForm](docs/EntitySurfaceForm.md)
|
96
137
|
- [AylienNewsApi::Error](docs/Error.md)
|
97
138
|
- [AylienNewsApi::ErrorLinks](docs/ErrorLinks.md)
|
98
139
|
- [AylienNewsApi::Errors](docs/Errors.md)
|
99
140
|
- [AylienNewsApi::HistogramInterval](docs/HistogramInterval.md)
|
100
141
|
- [AylienNewsApi::Histograms](docs/Histograms.md)
|
101
142
|
- [AylienNewsApi::Location](docs/Location.md)
|
143
|
+
- [AylienNewsApi::Logicals](docs/Logicals.md)
|
102
144
|
- [AylienNewsApi::Media](docs/Media.md)
|
145
|
+
- [AylienNewsApi::MediaFormat](docs/MediaFormat.md)
|
146
|
+
- [AylienNewsApi::MediaType](docs/MediaType.md)
|
147
|
+
- [AylienNewsApi::NestedEntity](docs/NestedEntity.md)
|
148
|
+
- [AylienNewsApi::Parameter](docs/Parameter.md)
|
149
|
+
- [AylienNewsApi::Query](docs/Query.md)
|
103
150
|
- [AylienNewsApi::Rank](docs/Rank.md)
|
104
151
|
- [AylienNewsApi::Rankings](docs/Rankings.md)
|
105
152
|
- [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
|
106
153
|
- [AylienNewsApi::RepresentativeStory](docs/RepresentativeStory.md)
|
107
154
|
- [AylienNewsApi::Scope](docs/Scope.md)
|
155
|
+
- [AylienNewsApi::ScopeLevel](docs/ScopeLevel.md)
|
108
156
|
- [AylienNewsApi::Sentiment](docs/Sentiment.md)
|
157
|
+
- [AylienNewsApi::SentimentPolarity](docs/SentimentPolarity.md)
|
109
158
|
- [AylienNewsApi::Sentiments](docs/Sentiments.md)
|
110
159
|
- [AylienNewsApi::ShareCount](docs/ShareCount.md)
|
111
160
|
- [AylienNewsApi::ShareCounts](docs/ShareCounts.md)
|
@@ -114,10 +163,30 @@ Class | Method | HTTP request | Description
|
|
114
163
|
- [AylienNewsApi::Story](docs/Story.md)
|
115
164
|
- [AylienNewsApi::StoryCluster](docs/StoryCluster.md)
|
116
165
|
- [AylienNewsApi::StoryLinks](docs/StoryLinks.md)
|
166
|
+
- [AylienNewsApi::StoryTranslation](docs/StoryTranslation.md)
|
117
167
|
- [AylienNewsApi::StoryTranslations](docs/StoryTranslations.md)
|
118
|
-
- [AylienNewsApi::StoryTranslationsEn](docs/StoryTranslationsEn.md)
|
119
168
|
- [AylienNewsApi::Summary](docs/Summary.md)
|
120
169
|
- [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
|
121
170
|
- [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
|
122
171
|
- [AylienNewsApi::Trend](docs/Trend.md)
|
123
172
|
- [AylienNewsApi::Trends](docs/Trends.md)
|
173
|
+
- [AylienNewsApi::Warning](docs/Warning.md)
|
174
|
+
|
175
|
+
|
176
|
+
## Documentation for Authorization
|
177
|
+
|
178
|
+
|
179
|
+
### app_id
|
180
|
+
|
181
|
+
|
182
|
+
- **Type**: API key
|
183
|
+
- **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
|
184
|
+
- **Location**: HTTP header
|
185
|
+
|
186
|
+
### app_key
|
187
|
+
|
188
|
+
|
189
|
+
- **Type**: API key
|
190
|
+
- **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
|
191
|
+
- **Location**: HTTP header
|
192
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# AylienNewsApi::AggregatedSentiment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**positive** | **Integer** | Positive sentiments count | [optional]
|
8
|
+
**neutral** | **Integer** | Neutral sentiments count | [optional]
|
9
|
+
**negative** | **Integer** | Negative sentiments count | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'AylienNewsApi'
|
15
|
+
|
16
|
+
instance = AylienNewsApi::AggregatedSentiment.new(positive: null,
|
17
|
+
neutral: null,
|
18
|
+
negative: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/DefaultApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.aylien.com/news*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**advanced_list_stories**](DefaultApi.md#advanced_list_stories) | **POST** /stories | List Stories
|
7
8
|
[**list_autocompletes**](DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
8
9
|
[**list_clusters**](DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
|
9
10
|
[**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
@@ -15,6 +16,81 @@ Method | HTTP request | Description
|
|
15
16
|
|
16
17
|
|
17
18
|
|
19
|
+
## advanced_list_stories
|
20
|
+
|
21
|
+
> OneOfStoriesDeprecatedStories advanced_list_stories(unknown_base_type, opts)
|
22
|
+
|
23
|
+
List Stories
|
24
|
+
|
25
|
+
The stories endpoint is used to return stories based on the json query you set in your request body. The News API crawler gathers articles in near real-time and stores information about them, or metadata. Below you can see all of the query parameters, and JSON schema for the body, which you can use to narrow down your query.
|
26
|
+
|
27
|
+
### Example
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
# load the gem
|
31
|
+
require 'aylien_news_api'
|
32
|
+
# setup authorization
|
33
|
+
AylienNewsApi.configure do |config|
|
34
|
+
# Configure API key authorization: app_id
|
35
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
38
|
+
|
39
|
+
# Configure API key authorization: app_key
|
40
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
41
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
42
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
43
|
+
end
|
44
|
+
|
45
|
+
api_instance = AylienNewsApi::DefaultApi.new
|
46
|
+
unknown_base_type = {"$and":[{"$or":[{"body":{"$text":"Tim Cook"}},{"social.shares.count.reddit.max":{"$gte":5000,"$boost":5}}]},{"entity":{"$and":[{"name":{"$text":"Apple","$boost":2}},{"$not":[{"type":{"$eq":"Fruit"}}]}]}}]} # UNKNOWN_BASE_TYPE | /stories body schema to perform an advanced search with logical operators and nested objects.
|
47
|
+
opts = {
|
48
|
+
published_at_start: 'published_at_start_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).
|
49
|
+
published_at_end: 'published_at_end_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).
|
50
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
51
|
+
sort_by: '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).
|
52
|
+
sort_direction: '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).
|
53
|
+
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).
|
54
|
+
per_page: 10 # Integer | 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)
|
55
|
+
}
|
56
|
+
|
57
|
+
begin
|
58
|
+
#List Stories
|
59
|
+
result = api_instance.advanced_list_stories(unknown_base_type, opts)
|
60
|
+
p result
|
61
|
+
rescue AylienNewsApi::ApiError => e
|
62
|
+
puts "Exception when calling DefaultApi->advanced_list_stories: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
|
69
|
+
Name | Type | Description | Notes
|
70
|
+
------------- | ------------- | ------------- | -------------
|
71
|
+
**unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)| /stories body schema to perform an advanced search with logical operators and nested objects. |
|
72
|
+
**published_at_start** | **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). | [optional]
|
73
|
+
**published_at_end** | **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). | [optional]
|
74
|
+
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
75
|
+
**sort_by** | **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). | [optional] [default to 'published_at']
|
76
|
+
**sort_direction** | **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). | [optional] [default to 'desc']
|
77
|
+
**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). | [optional] [default to '*']
|
78
|
+
**per_page** | **Integer**| 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) | [optional] [default to 10]
|
79
|
+
|
80
|
+
### Return type
|
81
|
+
|
82
|
+
[**OneOfStoriesDeprecatedStories**](OneOfStoriesDeprecatedStories.md)
|
83
|
+
|
84
|
+
### Authorization
|
85
|
+
|
86
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
87
|
+
|
88
|
+
### HTTP request headers
|
89
|
+
|
90
|
+
- **Content-Type**: application/json
|
91
|
+
- **Accept**: application/json, text/xml
|
92
|
+
|
93
|
+
|
18
94
|
## list_autocompletes
|
19
95
|
|
20
96
|
> Autocompletes list_autocompletes(type, term, opts)
|
@@ -225,18 +301,49 @@ opts = {
|
|
225
301
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
226
302
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
227
303
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
304
|
+
entities_id: ['entities_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
305
|
+
not_entities_id: ['entities_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
306
|
+
entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
307
|
+
not_entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
308
|
+
entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
309
|
+
not_entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
310
|
+
entities_types: ['entities_types_example'], # Array<String> | This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
311
|
+
not_entities_types: ['entities_types_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
312
|
+
entities_stock_tickers: ['entities_stock_tickers_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
313
|
+
entities_body_stock_tickers: ['entities_body_stock_tickers_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
314
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
315
|
+
entities_surface_forms_text: ['entities_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
316
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
317
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
318
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
319
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
228
320
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
229
321
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
230
322
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
231
323
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
324
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
325
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
232
326
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
233
327
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
328
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
329
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
330
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
331
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
332
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
333
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
334
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
234
335
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
235
336
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
236
337
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
237
338
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
339
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
340
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
238
341
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
239
342
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
343
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
344
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
345
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
346
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
240
347
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
241
348
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
242
349
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -291,6 +398,9 @@ opts = {
|
|
291
398
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
292
399
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
293
400
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
401
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
402
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
403
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
294
404
|
interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
|
295
405
|
interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
|
296
406
|
interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
|
@@ -333,18 +443,49 @@ Name | Type | Description | Notes
|
|
333
443
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
334
444
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
335
445
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
446
|
+
**entities_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
447
|
+
**not_entities_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
448
|
+
**entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
449
|
+
**not_entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
450
|
+
**entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
451
|
+
**not_entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
452
|
+
**entities_types** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
453
|
+
**not_entities_types** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
454
|
+
**entities_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
455
|
+
**entities_body_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
456
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
457
|
+
**entities_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
458
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
459
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
460
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
461
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
336
462
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
337
463
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
338
464
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
339
465
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
466
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
467
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
340
468
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
341
469
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
470
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
471
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
472
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
473
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
474
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
475
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
476
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
342
477
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
343
478
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
344
479
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
345
480
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
481
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
482
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
346
483
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
347
484
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
485
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
486
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
487
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
488
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
348
489
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
349
490
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
350
491
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -399,6 +540,9 @@ Name | Type | Description | Notes
|
|
399
540
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
400
541
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
401
542
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
543
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
544
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
545
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
402
546
|
**interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
|
403
547
|
**interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
|
404
548
|
**interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
|
@@ -420,7 +564,7 @@ Name | Type | Description | Notes
|
|
420
564
|
|
421
565
|
## list_related_stories_get
|
422
566
|
|
423
|
-
>
|
567
|
+
> OneOfRelatedStoriesDeprecatedRelatedStories list_related_stories_get(opts)
|
424
568
|
|
425
569
|
|
426
570
|
|
@@ -466,18 +610,49 @@ opts = {
|
|
466
610
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
467
611
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
468
612
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
613
|
+
entities_id: ['entities_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
614
|
+
not_entities_id: ['entities_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
615
|
+
entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
616
|
+
not_entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
617
|
+
entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
618
|
+
not_entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
619
|
+
entities_types: ['entities_types_example'], # Array<String> | This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
620
|
+
not_entities_types: ['entities_types_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
621
|
+
entities_stock_tickers: ['entities_stock_tickers_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
622
|
+
entities_body_stock_tickers: ['entities_body_stock_tickers_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
623
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
624
|
+
entities_surface_forms_text: ['entities_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
625
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
626
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
627
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
628
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
469
629
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
470
630
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
471
631
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
472
632
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
633
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
634
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
473
635
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
474
636
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
637
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
638
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
639
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
640
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
641
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
642
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
643
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
475
644
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
476
645
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
477
646
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
478
647
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
648
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
649
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
479
650
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
480
651
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
652
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
653
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
654
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
655
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
481
656
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
482
657
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
483
658
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -537,6 +712,9 @@ opts = {
|
|
537
712
|
story_url: 'story_url_example', # String | An article or webpage
|
538
713
|
story_title: 'story_title_example', # String | Title of the article
|
539
714
|
story_body: 'story_body_example', # String | Body of the article
|
715
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
716
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
717
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
540
718
|
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
541
719
|
story_language: 'auto', # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
|
542
720
|
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
@@ -577,18 +755,49 @@ Name | Type | Description | Notes
|
|
577
755
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
578
756
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
579
757
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
758
|
+
**entities_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
759
|
+
**not_entities_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
760
|
+
**entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
761
|
+
**not_entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
762
|
+
**entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
763
|
+
**not_entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
764
|
+
**entities_types** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
765
|
+
**not_entities_types** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
766
|
+
**entities_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
767
|
+
**entities_body_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
768
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
769
|
+
**entities_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
770
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
771
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
772
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
773
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
580
774
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
581
775
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
582
776
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
583
777
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
778
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
779
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
584
780
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
585
781
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
782
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
783
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
784
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
785
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
786
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
787
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
788
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
586
789
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
587
790
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
588
791
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
589
792
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
793
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
794
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
590
795
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
591
796
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
797
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
798
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
799
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
800
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
592
801
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
593
802
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
594
803
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -648,13 +857,16 @@ Name | Type | Description | Notes
|
|
648
857
|
**story_url** | **String**| An article or webpage | [optional]
|
649
858
|
**story_title** | **String**| Title of the article | [optional]
|
650
859
|
**story_body** | **String**| Body of the article | [optional]
|
860
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
861
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
862
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
651
863
|
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
652
864
|
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
653
865
|
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
654
866
|
|
655
867
|
### Return type
|
656
868
|
|
657
|
-
[**
|
869
|
+
[**OneOfRelatedStoriesDeprecatedRelatedStories**](OneOfRelatedStoriesDeprecatedRelatedStories.md)
|
658
870
|
|
659
871
|
### Authorization
|
660
872
|
|
@@ -668,7 +880,7 @@ Name | Type | Description | Notes
|
|
668
880
|
|
669
881
|
## list_related_stories_post
|
670
882
|
|
671
|
-
>
|
883
|
+
> OneOfRelatedStoriesDeprecatedRelatedStories list_related_stories_post(opts)
|
672
884
|
|
673
885
|
|
674
886
|
|
@@ -714,18 +926,49 @@ opts = {
|
|
714
926
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
715
927
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
716
928
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
929
|
+
entities_id: ['entities_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
930
|
+
not_entities_id: ['entities_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
931
|
+
entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
932
|
+
not_entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
933
|
+
entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
934
|
+
not_entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
935
|
+
entities_types: ['entities_types_example'], # Array<String> | This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
936
|
+
not_entities_types: ['entities_types_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
937
|
+
entities_stock_tickers: ['entities_stock_tickers_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
938
|
+
entities_body_stock_tickers: ['entities_body_stock_tickers_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
939
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
940
|
+
entities_surface_forms_text: ['entities_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
941
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
942
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
943
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
944
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
717
945
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
718
946
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
719
947
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
720
948
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
949
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
950
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
721
951
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
722
952
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
953
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
954
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
955
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
956
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
957
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
958
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
959
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
723
960
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
724
961
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
725
962
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
726
963
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
964
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
965
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
727
966
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
728
967
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
968
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
969
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
970
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
971
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
729
972
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
730
973
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
731
974
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -785,6 +1028,9 @@ opts = {
|
|
785
1028
|
story_url: 'story_url_example', # String | An article or webpage
|
786
1029
|
story_title: 'story_title_example', # String | Title of the article
|
787
1030
|
story_body: 'story_body_example', # String | Body of the article
|
1031
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1032
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1033
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
788
1034
|
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
789
1035
|
story_language: 'auto', # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
|
790
1036
|
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
@@ -825,18 +1071,49 @@ Name | Type | Description | Notes
|
|
825
1071
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
826
1072
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
827
1073
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1074
|
+
**entities_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1075
|
+
**not_entities_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1076
|
+
**entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1077
|
+
**not_entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1078
|
+
**entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1079
|
+
**not_entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1080
|
+
**entities_types** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1081
|
+
**not_entities_types** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1082
|
+
**entities_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1083
|
+
**entities_body_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1084
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1085
|
+
**entities_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1086
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1087
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1088
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1089
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
828
1090
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
829
1091
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
830
1092
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
831
1093
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1094
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1095
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
832
1096
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
833
1097
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1098
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1099
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1100
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1101
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1102
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1103
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1104
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
834
1105
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
835
1106
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
836
1107
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
837
1108
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1109
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1110
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
838
1111
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
839
1112
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1113
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1114
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1115
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1116
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
840
1117
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
841
1118
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
842
1119
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -896,13 +1173,16 @@ Name | Type | Description | Notes
|
|
896
1173
|
**story_url** | **String**| An article or webpage | [optional]
|
897
1174
|
**story_title** | **String**| Title of the article | [optional]
|
898
1175
|
**story_body** | **String**| Body of the article | [optional]
|
1176
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1177
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1178
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
899
1179
|
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
900
1180
|
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
901
1181
|
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
902
1182
|
|
903
1183
|
### Return type
|
904
1184
|
|
905
|
-
[**
|
1185
|
+
[**OneOfRelatedStoriesDeprecatedRelatedStories**](OneOfRelatedStoriesDeprecatedRelatedStories.md)
|
906
1186
|
|
907
1187
|
### Authorization
|
908
1188
|
|
@@ -916,7 +1196,7 @@ Name | Type | Description | Notes
|
|
916
1196
|
|
917
1197
|
## list_stories
|
918
1198
|
|
919
|
-
>
|
1199
|
+
> OneOfStoriesDeprecatedStories list_stories(opts)
|
920
1200
|
|
921
1201
|
List Stories
|
922
1202
|
|
@@ -964,18 +1244,49 @@ opts = {
|
|
964
1244
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
965
1245
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
966
1246
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1247
|
+
entities_id: ['entities_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1248
|
+
not_entities_id: ['entities_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1249
|
+
entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1250
|
+
not_entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1251
|
+
entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1252
|
+
not_entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1253
|
+
entities_types: ['entities_types_example'], # Array<String> | This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1254
|
+
not_entities_types: ['entities_types_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1255
|
+
entities_stock_tickers: ['entities_stock_tickers_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1256
|
+
entities_body_stock_tickers: ['entities_body_stock_tickers_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1257
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1258
|
+
entities_surface_forms_text: ['entities_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1259
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1260
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1261
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1262
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
967
1263
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
968
1264
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
969
1265
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
970
1266
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1267
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1268
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
971
1269
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
972
1270
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1271
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1272
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1273
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1274
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1275
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1276
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1277
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
973
1278
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
974
1279
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
975
1280
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
976
1281
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1282
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1283
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
977
1284
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
978
1285
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1286
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1287
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1288
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1289
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
979
1290
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
980
1291
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
981
1292
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -1031,6 +1342,9 @@ opts = {
|
|
1031
1342
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1032
1343
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1033
1344
|
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
1345
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1346
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1347
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
1034
1348
|
sort_by: '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).
|
1035
1349
|
sort_direction: '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).
|
1036
1350
|
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).
|
@@ -1073,18 +1387,49 @@ Name | Type | Description | Notes
|
|
1073
1387
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1074
1388
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1075
1389
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1390
|
+
**entities_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1391
|
+
**not_entities_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1392
|
+
**entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1393
|
+
**not_entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1394
|
+
**entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1395
|
+
**not_entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1396
|
+
**entities_types** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1397
|
+
**not_entities_types** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1398
|
+
**entities_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1399
|
+
**entities_body_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1400
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1401
|
+
**entities_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1402
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1403
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1404
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1405
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1076
1406
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1077
1407
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1078
1408
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1079
1409
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1410
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1411
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1080
1412
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1081
1413
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1414
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1415
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1416
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1417
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1418
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1419
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1420
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1082
1421
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1083
1422
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1084
1423
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1085
1424
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1425
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1426
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1086
1427
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1087
1428
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1429
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1430
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1431
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1432
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1088
1433
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1089
1434
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1090
1435
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1140,6 +1485,9 @@ Name | Type | Description | Notes
|
|
1140
1485
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1141
1486
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
1142
1487
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
1488
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1489
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1490
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1143
1491
|
**sort_by** | **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). | [optional] [default to 'published_at']
|
1144
1492
|
**sort_direction** | **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). | [optional] [default to 'desc']
|
1145
1493
|
**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). | [optional] [default to '*']
|
@@ -1147,7 +1495,7 @@ Name | Type | Description | Notes
|
|
1147
1495
|
|
1148
1496
|
### Return type
|
1149
1497
|
|
1150
|
-
[**
|
1498
|
+
[**OneOfStoriesDeprecatedStories**](OneOfStoriesDeprecatedStories.md)
|
1151
1499
|
|
1152
1500
|
### Authorization
|
1153
1501
|
|
@@ -1205,18 +1553,49 @@ opts = {
|
|
1205
1553
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1206
1554
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1207
1555
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1556
|
+
entities_id: ['entities_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1557
|
+
not_entities_id: ['entities_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1558
|
+
entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1559
|
+
not_entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1560
|
+
entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1561
|
+
not_entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1562
|
+
entities_types: ['entities_types_example'], # Array<String> | This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1563
|
+
not_entities_types: ['entities_types_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1564
|
+
entities_stock_tickers: ['entities_stock_tickers_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1565
|
+
entities_body_stock_tickers: ['entities_body_stock_tickers_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1566
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1567
|
+
entities_surface_forms_text: ['entities_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1568
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1569
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1570
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1571
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1208
1572
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1209
1573
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1210
1574
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1211
1575
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1576
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1577
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1212
1578
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1213
1579
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1580
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1581
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1582
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1583
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1584
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1585
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1586
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1214
1587
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1215
1588
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1216
1589
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1217
1590
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1591
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1592
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1218
1593
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1219
1594
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1595
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1596
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1597
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1598
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1220
1599
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1221
1600
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1222
1601
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -1271,6 +1650,9 @@ opts = {
|
|
1271
1650
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1272
1651
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1273
1652
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1653
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1654
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1655
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
1274
1656
|
published_at_start: 'NOW-7DAYS/DAY', # 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).
|
1275
1657
|
published_at_end: 'NOW/DAY', # 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).
|
1276
1658
|
period: '+1DAY' # String | The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math).
|
@@ -1308,18 +1690,49 @@ Name | Type | Description | Notes
|
|
1308
1690
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1309
1691
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1310
1692
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1693
|
+
**entities_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1694
|
+
**not_entities_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1695
|
+
**entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1696
|
+
**not_entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1697
|
+
**entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1698
|
+
**not_entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1699
|
+
**entities_types** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1700
|
+
**not_entities_types** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1701
|
+
**entities_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1702
|
+
**entities_body_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1703
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1704
|
+
**entities_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1705
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1706
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1707
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1708
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1311
1709
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1312
1710
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1313
1711
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1314
1712
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1713
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1714
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1315
1715
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1316
1716
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1717
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1718
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1719
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1720
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1721
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1722
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1723
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1317
1724
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1318
1725
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1319
1726
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1320
1727
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1728
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1729
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1321
1730
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1322
1731
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1732
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1733
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1734
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1735
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1323
1736
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1324
1737
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1325
1738
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1374,6 +1787,9 @@ Name | Type | Description | Notes
|
|
1374
1787
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1375
1788
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1376
1789
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
1790
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1791
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1792
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1377
1793
|
**published_at_start** | **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). | [optional] [default to 'NOW-7DAYS/DAY']
|
1378
1794
|
**published_at_end** | **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). | [optional] [default to 'NOW/DAY']
|
1379
1795
|
**period** | **String**| The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to '+1DAY']
|
@@ -1443,18 +1859,49 @@ opts = {
|
|
1443
1859
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1444
1860
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1445
1861
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1862
|
+
entities_id: ['entities_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1863
|
+
not_entities_id: ['entities_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1864
|
+
entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1865
|
+
not_entities_links_wikipedia: ['entities_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1866
|
+
entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1867
|
+
not_entities_links_wikidata: ['entities_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1868
|
+
entities_types: ['entities_types_example'], # Array<String> | This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1869
|
+
not_entities_types: ['entities_types_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1870
|
+
entities_stock_tickers: ['entities_stock_tickers_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1871
|
+
entities_body_stock_tickers: ['entities_body_stock_tickers_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1872
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1873
|
+
entities_surface_forms_text: ['entities_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1874
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1875
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1876
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1877
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1446
1878
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1447
1879
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1448
1880
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1449
1881
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1882
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1883
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1450
1884
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1451
1885
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1886
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1887
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1888
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1889
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1890
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1891
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1892
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1452
1893
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1453
1894
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1454
1895
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1455
1896
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1897
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1898
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1456
1899
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1457
1900
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1901
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1902
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1903
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1904
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1458
1905
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1459
1906
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1460
1907
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -1508,7 +1955,10 @@ opts = {
|
|
1508
1955
|
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
1509
1956
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1510
1957
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1511
|
-
clusters: ['clusters_example'] # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1958
|
+
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1959
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1960
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1961
|
+
query: 'query_example' # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
1512
1962
|
}
|
1513
1963
|
|
1514
1964
|
begin
|
@@ -1548,18 +1998,49 @@ Name | Type | Description | Notes
|
|
1548
1998
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1549
1999
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1550
2000
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
2001
|
+
**entities_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2002
|
+
**not_entities_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2003
|
+
**entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2004
|
+
**not_entities_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2005
|
+
**entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2006
|
+
**not_entities_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2007
|
+
**entities_types** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2008
|
+
**not_entities_types** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `types`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2009
|
+
**entities_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_tickers`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2010
|
+
**entities_body_stock_tickers** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_tickers` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2011
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2012
|
+
**entities_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form`. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2013
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2014
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2015
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2016
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1551
2017
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1552
2018
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1553
2019
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1554
2020
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2021
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2022
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1555
2023
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1556
2024
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2025
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2026
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2027
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2028
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2029
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2030
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2031
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1557
2032
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1558
2033
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1559
2034
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1560
2035
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2036
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2037
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1561
2038
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1562
2039
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2040
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2041
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2042
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
2043
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1563
2044
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1564
2045
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1565
2046
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1614,6 +2095,9 @@ Name | Type | Description | Notes
|
|
1614
2095
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1615
2096
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1616
2097
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
2098
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
2099
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
2100
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1617
2101
|
|
1618
2102
|
### Return type
|
1619
2103
|
|