File size: 9,354 Bytes
6993919 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | # rugmunch.NewsApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**analyze_news_api_v1_news_news_id_analyze_post**](NewsApi.md#analyze_news_api_v1_news_news_id_analyze_post) | **POST** /api/v1/news/{news_id}/analyze | Analyze News
[**get_news_api_v1_news_news_id_get**](NewsApi.md#get_news_api_v1_news_news_id_get) | **GET** /api/v1/news/{news_id} | Get News
[**list_news_api_v1_news_post**](NewsApi.md#list_news_api_v1_news_post) | **POST** /api/v1/news | List News
[**trending_news_api_v1_news_trending_get**](NewsApi.md#trending_news_api_v1_news_trending_get) | **GET** /api/v1/news/trending | Trending News
# **analyze_news_api_v1_news_news_id_analyze_post**
> NewsAnalysisResponse analyze_news_api_v1_news_news_id_analyze_post(news_id)
Analyze News
Generate LLM analysis via LiteLLM. Falls back to None if LLM unreachable.
### Example
```python
import rugmunch
from rugmunch.models.news_analysis_response import NewsAnalysisResponse
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.NewsApi(api_client)
news_id = 'news_id_example' # str |
try:
# Analyze News
api_response = api_instance.analyze_news_api_v1_news_news_id_analyze_post(news_id)
print("The response of NewsApi->analyze_news_api_v1_news_news_id_analyze_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NewsApi->analyze_news_api_v1_news_news_id_analyze_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**news_id** | **str**| |
### Return type
[**NewsAnalysisResponse**](NewsAnalysisResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_news_api_v1_news_news_id_get**
> NewsItemOut get_news_api_v1_news_news_id_get(news_id)
Get News
Single news item. Searches both news_items and crypto_news.
### Example
```python
import rugmunch
from rugmunch.models.news_item_out import NewsItemOut
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.NewsApi(api_client)
news_id = 'news_id_example' # str |
try:
# Get News
api_response = api_instance.get_news_api_v1_news_news_id_get(news_id)
print("The response of NewsApi->get_news_api_v1_news_news_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NewsApi->get_news_api_v1_news_news_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**news_id** | **str**| |
### Return type
[**NewsItemOut**](NewsItemOut.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_news_api_v1_news_post**
> NewsListResponse list_news_api_v1_news_post(chain=chain, token=token, category=category, since_hours=since_hours, limit=limit, offset=offset, sort=sort)
List News
List news items with filters. Reads from both news_items (new) and crypto_news (legacy).
### Example
```python
import rugmunch
from rugmunch.models.news_list_response import NewsListResponse
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.NewsApi(api_client)
chain = 'chain_example' # str | (optional)
token = 'token_example' # str | (optional)
category = 'category_example' # str | (optional)
since_hours = 24 # int | (optional) (default to 24)
limit = 20 # int | (optional) (default to 20)
offset = 0 # int | (optional) (default to 0)
sort = 'recency' # str | (optional) (default to 'recency')
try:
# List News
api_response = api_instance.list_news_api_v1_news_post(chain=chain, token=token, category=category, since_hours=since_hours, limit=limit, offset=offset, sort=sort)
print("The response of NewsApi->list_news_api_v1_news_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NewsApi->list_news_api_v1_news_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**chain** | **str**| | [optional]
**token** | **str**| | [optional]
**category** | **str**| | [optional]
**since_hours** | **int**| | [optional] [default to 24]
**limit** | **int**| | [optional] [default to 20]
**offset** | **int**| | [optional] [default to 0]
**sort** | **str**| | [optional] [default to 'recency']
### Return type
[**NewsListResponse**](NewsListResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **trending_news_api_v1_news_trending_get**
> NewsListResponse trending_news_api_v1_news_trending_get(window_hours=window_hours, limit=limit)
Trending News
Time-decay trending. Reads from news_items (new) primary, falls back to crypto_news (legacy).
### Example
```python
import rugmunch
from rugmunch.models.news_list_response import NewsListResponse
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.NewsApi(api_client)
window_hours = 168 # int | (optional) (default to 168)
limit = 20 # int | (optional) (default to 20)
try:
# Trending News
api_response = api_instance.trending_news_api_v1_news_trending_get(window_hours=window_hours, limit=limit)
print("The response of NewsApi->trending_news_api_v1_news_trending_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NewsApi->trending_news_api_v1_news_trending_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**window_hours** | **int**| | [optional] [default to 168]
**limit** | **int**| | [optional] [default to 20]
### Return type
[**NewsListResponse**](NewsListResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|