@bitget-ai/getagent-skill 0.2.1

package/skills/getagent/references/sdk/data/imf_utils.md

@@ -0,0 +1,225 @@
+# Imf_Utils Data Reference
+
+Use this file when an agent needs detailed signatures and parameter
+rules for one DataSDK domain. All generated `getagent.data` endpoints
+are callable through the DataSDK wrapper.
+
+## Contents
+- [`imf_utils.get_dataflow_dimensions`](#imf-utilsget-dataflow-dimensions)
+- [`imf_utils.list_dataflow_choices`](#imf-utilslist-dataflow-choices)
+- [`imf_utils.list_dataflows`](#imf-utilslist-dataflows)
+- [`imf_utils.list_port_id_choices`](#imf-utilslist-port-id-choices)
+- [`imf_utils.list_table_choices`](#imf-utilslist-table-choices)
+- [`imf_utils.list_tables`](#imf-utilslist-tables)
+- [`imf_utils.presentation_table`](#imf-utilspresentation-table)
+- [`imf_utils.presentation_table_choices`](#imf-utilspresentation-table-choices)
+
+## Endpoint reference
+
+### `imf_utils.get_dataflow_dimensions`
+
+```python
+data.imf_utils.get_dataflow_dimensions(dataflow_id=..., output_format='json')
+```
+
+Summary: Get Dataflow Dimensions
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.get_dataflow_dimensions` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/get_dataflow_dimensions` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `dataflow_id` | `yes` | `string` | `-` | The IMF dataflow ID. Use `list_dataflows()` to see available dataflows. |
+| `output_format` | `no` | `string` | `json` | - |
+
+---
+
+### `imf_utils.list_dataflow_choices`
+
+```python
+data.imf_utils.list_dataflow_choices()
+```
+
+Summary: List Dataflow Choices
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.list_dataflow_choices` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/list_dataflow_choices` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+No query parameters.
+
+---
+
+### `imf_utils.list_dataflows`
+
+```python
+data.imf_utils.list_dataflows(output_format='json')
+```
+
+Summary: List Dataflows
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.list_dataflows` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/list_dataflows` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `output_format` | `no` | `string` | `json` | - |
+
+---
+
+### `imf_utils.list_port_id_choices`
+
+```python
+data.imf_utils.list_port_id_choices()
+```
+
+Summary: List Port Id Choices
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.list_port_id_choices` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/list_port_id_choices` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+No query parameters.
+
+---
+
+### `imf_utils.list_table_choices`
+
+```python
+data.imf_utils.list_table_choices()
+```
+
+Summary: List Table Choices
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.list_table_choices` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/list_table_choices` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+No query parameters.
+
+---
+
+### `imf_utils.list_tables`
+
+```python
+data.imf_utils.list_tables()
+```
+
+Summary: List Tables
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.list_tables` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/list_tables` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+No query parameters.
+
+---
+
+### `imf_utils.presentation_table`
+
+```python
+data.imf_utils.presentation_table(dataflow_group=None, table=None, country=None, frequency=None, dimension_values=None, limit=1, raw=False)
+```
+
+Summary: Presentation Table
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.presentation_table` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/presentation_table` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `dataflow_group` | `no` | `string | null` | `-` | The IMF dataflow group. See presentation_table_choices() for options. |
+| `table` | `no` | `string | null` | `-` | The IMF presentation table ID. See presentation_table_choices() for options. |
+| `country` | `no` | `string | null` | `-` | Country code to filter the data. Enter multiple codes by joining on '+'. See presentation_table_choices() for options. Typical values are ISO3 country codes. |
+| `frequency` | `no` | `string | null` | `-` | The data frequency. See presentation_table_choices() for options. Typical values are 'A' (annual), 'Q' (quarter), 'M' (month), or 'D' (day). |
+| `dimension_values` | `no` | `array | string | null` | `-` | accepts array values Dimension selection for filtering. Format: 'DIM_ID1:VAL1+VAL2.' See presentation_table_choices() and list_dataflow_choices() for available dimensions and values. |
+| `limit` | `no` | `integer` | `1` | Maximum number of records to retrieve per series. |
+| `raw` | `no` | `boolean` | `false` | Return presentation table as raw JSON data if True. |
+
+---
+
+### `imf_utils.presentation_table_choices`
+
+```python
+data.imf_utils.presentation_table_choices(dataflow_group=None, table=None, country=None, frequency=None)
+```
+
+Summary: Presentation Table Choices
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `imf_utils.presentation_table_choices` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/imf_utils/presentation_table_choices` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `dataflow_group` | `no` | `string | null` | `-` | - |
+| `table` | `no` | `string | null` | `-` | - |
+| `country` | `no` | `string | null` | `-` | - |
+| `frequency` | `no` | `string | null` | `-` | - |

package/skills/getagent/references/sdk/data/index.md

@@ -0,0 +1,216 @@
+# Index Data Reference
+
+Use this file when an agent needs detailed signatures and parameter
+rules for one DataSDK domain. All generated `getagent.data` endpoints
+are callable through the DataSDK wrapper.
+
+## Contents
+- [`index.available`](#indexavailable)
+- [`index.constituents`](#indexconstituents)
+- [`index.price.historical`](#indexpricehistorical)
+- [`index.search`](#indexsearch)
+- [`index.sectors`](#indexsectors)
+- [`index.snapshots`](#indexsnapshots)
+- [`index.sp500_multiples`](#indexsp500-multiples)
+
+## Endpoint reference
+
+### `index.available`
+
+```python
+data.index.available(use_cache=True, provider=...)
+```
+
+Summary: Available
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.available` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/available` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `use_cache` | `no` | `boolean` | `true` | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. (provider: cboe); Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) |
+| `provider` | `yes` | `string` | `-` | enum: cboe, fmp, tmx, yfinance |
+
+---
+
+### `index.constituents`
+
+```python
+data.index.constituents(symbol=..., historical=False, use_cache=True, provider=...)
+```
+
+Summary: Constituents
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.constituents` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/constituents` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `historical` | `no` | `boolean` | `false` | Flag to retrieve historical removals and additions. (provider: fmp) |
+| `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) |
+| `provider` | `yes` | `string` | `-` | enum: cboe, fmp, tmx |
+
+---
+
+### `index.price.historical`
+
+```python
+data.index.price.historical(symbol=..., start_time=None, end_time=None, interval='1d', use_cache=True, limit=10000, provider=...)
+```
+
+Summary: Historical
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.price.historical` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/price/historical` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, cboe, fmp, intrinio, yfinance. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `interval` | `no` | `string` | `1d` | Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals. (provider: cboe); Time interval of the data to return. (provider: fmp); Time interval of the data to return. (provider: yfinance) |
+| `use_cache` | `no` | `boolean` | `true` | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) |
+| `limit` | `no` | `integer | null` | `10000` | The number of data entries to return. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: akshare, cboe, fmp, intrinio, yfinance |
+
+---
+
+### `index.search`
+
+```python
+data.index.search(query='', is_symbol=False, use_cache=True, provider='cboe')
+```
+
+Summary: Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/search` |
+| Default provider | `cboe` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `no` | `string` | `` | Search query. |
+| `is_symbol` | `no` | `boolean` | `false` | Whether to search by ticker symbol. |
+| `use_cache` | `no` | `boolean` | `true` | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. (provider: cboe) |
+| `provider` | `no` | `string` | `cboe` | - |
+
+---
+
+### `index.sectors`
+
+```python
+data.index.sectors(symbol=..., use_cache=True, provider='tmx')
+```
+
+Summary: Sectors
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.sectors` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/sectors` |
+| Default provider | `tmx` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day. (provider: tmx) |
+| `provider` | `no` | `string` | `tmx` | - |
+
+---
+
+### `index.snapshots`
+
+```python
+data.index.snapshots(region='us', use_cache=True, provider=...)
+```
+
+Summary: Snapshots
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.snapshots` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/snapshots` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `region` | `no` | `string` | `us` | The region of focus for the data - i.e., us, eu. |
+| `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) |
+| `provider` | `yes` | `string` | `-` | enum: cboe, tmx |
+
+---
+
+### `index.sp500_multiples`
+
+```python
+data.index.sp500_multiples(start_time=None, end_time=None, series_name='pe_month', provider='multpl')
+```
+
+Summary: Sp500 Multiples
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `index.sp500_multiples` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/index/sp500_multiples` |
+| Default provider | `multpl` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `series_name` | `no` | `string` | `pe_month` | The name of the series. Defaults to 'pe_month'. Multiple comma separated items allowed for provider(s): multpl. |
+| `provider` | `no` | `string` | `multpl` | - |

package/skills/getagent/references/sdk/data/news.md

@@ -0,0 +1,149 @@
+# News Data Reference
+
+Use this file when an agent needs detailed signatures and parameter
+rules for one DataSDK domain. All generated `getagent.data` endpoints
+are callable through the DataSDK wrapper.
+
+## Contents
+- [`news.company`](#newscompany)
+- [`news.label_search`](#newslabel-search)
+- [`news.world`](#newsworld)
+
+## Endpoint reference
+
+### `news.company`
+
+```python
+data.news.company(start_time=None, end_time=None, symbol=None, limit=None, date=None, display='full', updated_since=None, published_since=None, sort='created', order='desc', isin=None, cusip=None, channels=None, topics=None, authors=None, content_types=None, page=0, press_release=None, source=None, sentiment=None, language=None, topic=None, word_count_greater_than=None, word_count_less_than=None, is_spam=None, business_relevance_greater_than=None, business_relevance_less_than=None, offset=0, provider=...)
+```
+
+Summary: Company
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `news.company` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/news/company` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, tiingo, tmx, yfinance. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `date` | `no` | `string | null` | `-` | A specific date to get data for. (provider: benzinga) |
+| `display` | `no` | `string` | `full` | enum: headline, abstract, full Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga) |
+| `updated_since` | `no` | `integer | null` | `-` | Number of seconds since the news was updated. (provider: benzinga) |
+| `published_since` | `no` | `integer | null` | `-` | Number of seconds since the news was published. (provider: benzinga) |
+| `sort` | `no` | `string` | `created` | enum: id, created, updated Key to sort the news by. (provider: benzinga) |
+| `order` | `no` | `string` | `desc` | enum: asc, desc Order to sort the news by. (provider: benzinga) |
+| `isin` | `no` | `string | null` | `-` | The company's ISIN. (provider: benzinga) |
+| `cusip` | `no` | `string | null` | `-` | The company's CUSIP. (provider: benzinga) |
+| `channels` | `no` | `string | null` | `-` | Channels of the news to retrieve. (provider: benzinga) |
+| `topics` | `no` | `string | null` | `-` | Topics of the news to retrieve. (provider: benzinga) |
+| `authors` | `no` | `string | null` | `-` | Authors of the news to retrieve. (provider: benzinga) |
+| `content_types` | `no` | `string | null` | `-` | Content types of the news to retrieve. (provider: benzinga) |
+| `page` | `no` | `integer | null` | `0` | Page number of the results. Use in combination with limit. (provider: fmp); The page number to start from. Use with limit. (provider: tmx) |
+| `press_release` | `no` | `boolean | null` | `-` | When true, will return only press releases for the given symbol(s). (provider: fmp) |
+| `source` | `no` | `string | null` | `-` | The source of the news article. (provider: intrinio); A comma-separated list of the domains requested. Multiple comma separated items allowed. (provider: tiingo) |
+| `sentiment` | `no` | `string | null` | `-` | Return news only from this source. (provider: intrinio) |
+| `language` | `no` | `string | null` | `-` | Filter by language. Unsupported for yahoo source. (provider: intrinio) |
+| `topic` | `no` | `string | null` | `-` | Filter by topic. Unsupported for yahoo source. (provider: intrinio) |
+| `word_count_greater_than` | `no` | `integer | null` | `-` | News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio) |
+| `word_count_less_than` | `no` | `integer | null` | `-` | News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio) |
+| `is_spam` | `no` | `boolean | null` | `-` | Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio) |
+| `business_relevance_greater_than` | `no` | `number | null` | `-` | News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio) |
+| `business_relevance_less_than` | `no` | `number | null` | `-` | News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio) |
+| `offset` | `no` | `integer | null` | `0` | Page offset, used in conjunction with limit. (provider: tiingo) |
+| `provider` | `yes` | `string` | `-` | enum: benzinga, finnhub, fmp, intrinio, tiingo, tmx, yfinance |
+
+---
+
+### `news.label_search`
+
+```python
+data.news.label_search(label=..., language_id=0, start_time=None, end_time=None, page=1, page_size=10, provider='bitget_data')
+```
+
+Summary: Label Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `news.label_search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/news/label_search` |
+| Default provider | `bitget_data` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `label` | `yes` | `integer | string` | `-` | News label type to search for. Accepts either the integer type code or the human-readable name: 1=Crypto, 2=Stocks, 6=Commodities & Forex, 7=Macro. |
+| `language_id` | `no` | `integer | string | null` | `0` | Language filter. Accepts either the integer language code or a locale string (e.g. 'en', 'zh-CN', 'ja'). Defaults to 0 (English). |
+| `start_time` | `no` | `string | integer | number | null` | `-` | Start of the time range. Accepts a datetime object, an ISO-8601 string, or a Unix timestamp (seconds or milliseconds). Converted to millisecond epoch before sending to the API. |
+| `end_time` | `no` | `string | integer | number | null` | `-` | End of the time range. Accepts a datetime object, an ISO-8601 string, or a Unix timestamp (seconds or milliseconds). Converted to millisecond epoch before sending to the API. |
+| `page` | `no` | `integer | null` | `1` | Page number for pagination (1-based). Defaults to 1. |
+| `page_size` | `no` | `integer | null` | `10` | Number of news items per page. Defaults to 10. |
+| `provider` | `no` | `string` | `bitget_data` | - |
+
+---
+
+### `news.world`
+
+```python
+data.news.world(start_time=None, end_time=None, limit=None, date=None, display='full', updated_since=None, published_since=None, sort='created', order='desc', isin=None, cusip=None, channels=None, topics=None, authors=None, content_types=None, term=None, source=None, topic='general', page=None, sentiment=None, language=None, word_count_greater_than=None, word_count_less_than=None, is_spam=None, business_relevance_greater_than=None, business_relevance_less_than=None, offset=0, provider=...)
+```
+
+Summary: World
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `news.world` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/news/world` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | Global news feed endpoint for macro/news-aware strategies. |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. The number of articles to return. |
+| `date` | `no` | `string | null` | `-` | A specific date to get data for. (provider: benzinga) |
+| `display` | `no` | `string` | `full` | enum: headline, abstract, full Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga) |
+| `updated_since` | `no` | `integer | null` | `-` | Number of seconds since the news was updated. (provider: benzinga) |
+| `published_since` | `no` | `integer | null` | `-` | Number of seconds since the news was published. (provider: benzinga) |
+| `sort` | `no` | `string` | `created` | enum: id, created, updated Key to sort the news by. (provider: benzinga) |
+| `order` | `no` | `string` | `desc` | enum: asc, desc Order to sort the news by. (provider: benzinga) |
+| `isin` | `no` | `string | null` | `-` | The ISIN of the news to retrieve. (provider: benzinga) |
+| `cusip` | `no` | `string | null` | `-` | The CUSIP of the news to retrieve. (provider: benzinga) |
+| `channels` | `no` | `string | null` | `-` | Channels of the news to retrieve. (provider: benzinga) |
+| `topics` | `no` | `string | null` | `-` | Topics of the news to retrieve. (provider: benzinga) |
+| `authors` | `no` | `string | null` | `-` | Authors of the news to retrieve. (provider: benzinga) |
+| `content_types` | `no` | `string | null` | `-` | Content types of the news to retrieve. (provider: benzinga) |
+| `term` | `no` | `string | null` | `-` | Search term to filter articles by. This overrides all other filters. (provider: biztoc) |
+| `source` | `no` | `string | null` | `-` | Filter by a specific publisher. Only valid when filter is set to source. (provider: biztoc); The source of the news article. (provider: intrinio); A comma-separated list of the domains requested. Multiple comma separated items allowed. (provider: tiingo) |
+| `topic` | `no` | `string | null` | `general` | The topic of the news to be fetched. (provider: fmp); Filter by topic. Unsupported for yahoo source. (provider: intrinio) |
+| `page` | `no` | `integer | null` | `-` | Page number of the results. Use in combination with limit. (provider: fmp) |
+| `sentiment` | `no` | `string | null` | `-` | Return news only from this source. (provider: intrinio) |
+| `language` | `no` | `string | null` | `-` | Filter by language. Unsupported for yahoo source. (provider: intrinio) |
+| `word_count_greater_than` | `no` | `integer | null` | `-` | News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio) |
+| `word_count_less_than` | `no` | `integer | null` | `-` | News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio) |
+| `is_spam` | `no` | `boolean | null` | `-` | Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio) |
+| `business_relevance_greater_than` | `no` | `number | null` | `-` | News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio) |
+| `business_relevance_less_than` | `no` | `number | null` | `-` | News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio) |
+| `offset` | `no` | `integer | null` | `0` | Page offset, used in conjunction with limit. (provider: tiingo) |
+| `provider` | `yes` | `string` | `-` | enum: benzinga, biztoc, finnhub, fmp, intrinio, tiingo |