@bitget-ai/getagent-skill 0.2.1

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

@@ -0,0 +1,299 @@
+# Regulators 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
+- [`regulators.cftc.cot`](#regulatorscftccot)
+- [`regulators.cftc.cot_search`](#regulatorscftccot-search)
+- [`regulators.sec.cik_map`](#regulatorsseccik-map)
+- [`regulators.sec.filing_headers`](#regulatorssecfiling-headers)
+- [`regulators.sec.htm_file`](#regulatorssechtm-file)
+- [`regulators.sec.institutions_search`](#regulatorssecinstitutions-search)
+- [`regulators.sec.rss_litigation`](#regulatorssecrss-litigation)
+- [`regulators.sec.schema_files`](#regulatorssecschema-files)
+- [`regulators.sec.sic_search`](#regulatorssecsic-search)
+- [`regulators.sec.symbol_map`](#regulatorssecsymbol-map)
+
+## Endpoint reference
+
+### `regulators.cftc.cot`
+
+```python
+data.regulators.cftc.cot(start_time=None, end_time=None, id='045601', report_type='legacy', futures_only=False, provider='cftc')
+```
+
+Summary: Cot
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.cftc.cot` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/cftc/cot` |
+| Default provider | `cftc` |
+| 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. |
+| `id` | `no` | `string` | `045601` | A string with the CFTC market code or other identifying string, such as the contract market name, commodity name, or commodity group - i.e, 'gold' or 'japanese yen'.Default report is Fed Funds Futures. Use the 'cftc_market_code' for an exact match. |
+| `report_type` | `no` | `string` | `legacy` | enum: legacy, disaggregated, financial, supplemental The type of report to retrieve. Set `id` as 'all' to return all items in the report type (default date range returns the latest report). The Legacy report is broken down by exchange with reported open interest further broken down into three trader classifications: commercial, non-commercial and non-reportable. The Disaggregated reports are broken down by Agriculture and Natural Resource contracts. The Disaggregated reports break down reportable open interest positions into four classifications: Producer/Merchant, Swap Dealers, Managed Money and Other Reportables. The Traders in Financial Futures (TFF) report includes financial contracts. The TFF report breaks down the reported open interest into five classifications: Dealer, Asset Manager, Leveraged Money, Other Reportables and Non-Reportables. (provider: cftc) |
+| `futures_only` | `no` | `boolean` | `false` | Returns the futures-only report. Default is False, for the combined report. (provider: cftc) |
+| `provider` | `no` | `string` | `cftc` | - |
+
+---
+
+### `regulators.cftc.cot_search`
+
+```python
+data.regulators.cftc.cot_search(query='', provider='cftc')
+```
+
+Summary: Cot Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.cftc.cot_search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/cftc/cot_search` |
+| Default provider | `cftc` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `no` | `string` | `` | Search query. |
+| `provider` | `no` | `string` | `cftc` | - |
+
+---
+
+### `regulators.sec.cik_map`
+
+```python
+data.regulators.sec.cik_map(symbol=..., use_cache=True, provider='sec')
+```
+
+Summary: Cik Map
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.cik_map` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/cik_map` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache for the request, default is True. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.filing_headers`
+
+```python
+data.regulators.sec.filing_headers(url='', use_cache=True, provider='sec')
+```
+
+Summary: Filing Headers
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.filing_headers` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/filing_headers` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `url` | `no` | `string` | `` | URL for the SEC filing. The specific URL is not directly used or downloaded, but is used to generate the base URL for the filing. e.g. https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/coke-20240731.htm and https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/ are both valid URLs for the same filing. (provider: sec) |
+| `use_cache` | `no` | `boolean` | `true` | Use cache for the index headers and cover page. Default is True. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.htm_file`
+
+```python
+data.regulators.sec.htm_file(url='', use_cache=True, provider='sec')
+```
+
+Summary: Htm File
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.htm_file` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/htm_file` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `url` | `no` | `string` | `` | URL for the SEC filing. (provider: sec) |
+| `use_cache` | `no` | `boolean` | `true` | Cache the file for use later. Default is True. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.institutions_search`
+
+```python
+data.regulators.sec.institutions_search(query='', use_cache=True, provider='sec')
+```
+
+Summary: Institutions Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.institutions_search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/institutions_search` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `no` | `string` | `` | Search query. |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.rss_litigation`
+
+```python
+data.regulators.sec.rss_litigation(provider='sec')
+```
+
+Summary: Rss Litigation
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.rss_litigation` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/rss_litigation` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.schema_files`
+
+```python
+data.regulators.sec.schema_files(taxonomy=None, year=None, component=None, category=None, provider='sec')
+```
+
+Summary: Schema Files
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.schema_files` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/schema_files` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `taxonomy` | `no` | `string | null` | `-` | Taxonomy family to explore. Omit to list all available taxonomies and their descriptions. (provider: sec) |
+| `year` | `no` | `integer | null` | `-` | Taxonomy year (e.g. 2011+ for us-gaap, varies by taxonomy). Defaults to the most recent year when omitted. (provider: sec) |
+| `component` | `no` | `string | null` | `-` | Presentation component to retrieve. Values are taxonomy-specific. Omit to return all components for the taxonomy. (provider: sec) |
+| `category` | `no` | `string | null` | `-` | Filter taxonomies by SEC filer category. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.sic_search`
+
+```python
+data.regulators.sec.sic_search(query='', use_cache=True, provider='sec')
+```
+
+Summary: Sic Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.sic_search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/sic_search` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `no` | `string` | `` | Search query. |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `regulators.sec.symbol_map`
+
+```python
+data.regulators.sec.symbol_map(query=..., use_cache=True, provider='sec')
+```
+
+Summary: Symbol Map
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `regulators.sec.symbol_map` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/sec/symbol_map` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `yes` | `string` | `-` | Search query. |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache. If True, cache will store for seven days. |
+| `provider` | `no` | `string` | `sec` | - |

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

@@ -0,0 +1,323 @@
+# Sentiment 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
+- [`sentiment.followin_coin_news`](#sentimentfollowin-coin-news)
+- [`sentiment.followin_news`](#sentimentfollowin-news)
+- [`sentiment.followin_trending_topics`](#sentimentfollowin-trending-topics)
+- [`sentiment.market_fear_greed`](#sentimentmarket-fear-greed)
+- [`sentiment.news`](#sentimentnews)
+- [`sentiment.trending`](#sentimenttrending)
+- [`sentiment.twitter_list_timeline`](#sentimenttwitter-list-timeline)
+- [`sentiment.twitter_search`](#sentimenttwitter-search)
+- [`sentiment.twitter_tweet_detail`](#sentimenttwitter-tweet-detail)
+- [`sentiment.twitter_user_by_id`](#sentimenttwitter-user-by-id)
+- [`sentiment.twitter_user_by_name`](#sentimenttwitter-user-by-name)
+
+## Endpoint reference
+
+### `sentiment.followin_coin_news`
+
+```python
+data.sentiment.followin_coin_news(symbol=..., limit=20, provider='followin')
+```
+
+Summary: Followin Coin News
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.followin_coin_news` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/followin_coin_news` |
+| Default provider | `followin` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Coin/token symbol to fetch news for (e.g. 'BTC', 'ETH'). |
+| `limit` | `no` | `integer` | `20` | Maximum number of articles to return. Default 20. |
+| `provider` | `no` | `string` | `followin` | - |
+
+---
+
+### `sentiment.followin_news`
+
+```python
+data.sentiment.followin_news(news_type='trending', limit=20, provider='followin')
+```
+
+Summary: Followin News
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.followin_news` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/followin_news` |
+| Default provider | `followin` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `news_type` | `no` | `string` | `trending` | Type of news to fetch. 'trending' = hot news feed, 'flash' = flash/breaking news, 'kol_opinions' = KOL opinion articles. |
+| `limit` | `no` | `integer` | `20` | Maximum number of articles to return. Default 20. |
+| `provider` | `no` | `string` | `followin` | - |
+
+---
+
+### `sentiment.followin_trending_topics`
+
+```python
+data.sentiment.followin_trending_topics(limit=20, provider='followin')
+```
+
+Summary: Followin Trending Topics
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.followin_trending_topics` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/followin_trending_topics` |
+| Default provider | `followin` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `limit` | `no` | `integer` | `20` | Maximum number of topics to return. Default 20. |
+| `provider` | `no` | `string` | `followin` | - |
+
+---
+
+### `sentiment.market_fear_greed`
+
+```python
+data.sentiment.market_fear_greed(provider='feargreed')
+```
+
+Summary: Market Fear Greed
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.market_fear_greed` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/market_fear_greed` |
+| Default provider | `feargreed` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `provider` | `no` | `string` | `feargreed` | - |
+
+---
+
+### `sentiment.news`
+
+```python
+data.sentiment.news(category='all', limit=20, provider='rssnews')
+```
+
+Summary: News
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.news` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/news` |
+| Default provider | `rssnews` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `category` | `no` | `string` | `all` | News category filter. 'all' fetches all 44 sources concurrently. Other options filter by source group: 'crypto_core' (7 sources), 'crypto_high_freq' (4), 'crypto_supplement' (6), 'macro' (4), 'kol' (4), 'tech_ai' (5), 'geopolitical' (5), 'reddit' (5), 'chinese_japanese' (2), 'other' (2). |
+| `limit` | `no` | `integer` | `20` | Maximum number of articles to return per source. Default 20. |
+| `provider` | `no` | `string` | `rssnews` | - |
+
+---
+
+### `sentiment.trending`
+
+```python
+data.sentiment.trending(filter='all-stocks', page=1, provider='apewisdom')
+```
+
+Summary: Trending
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.trending` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/trending` |
+| Default provider | `apewisdom` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `filter` | `no` | `string` | `all-stocks` | Category or subreddit filter for trending data.; The subreddit or category filter. 'all-stocks' aggregates all stock-related subreddits, 'all-crypto' aggregates all crypto-related subreddits, '4chan' is /biz/ board, or specific subreddits like 'wallstreetbets', 'stocks', 'investing', 'cryptocurrency'. (provider: apewisdom) |
+| `page` | `no` | `integer` | `1` | Page number for pagination. |
+| `provider` | `no` | `string` | `apewisdom` | - |
+
+---
+
+### `sentiment.twitter_list_timeline`
+
+```python
+data.sentiment.twitter_list_timeline(list_id=..., count=20, cursor='', provider='twitter')
+```
+
+Summary: Twitter List Timeline
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.twitter_list_timeline` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/twitter_list_timeline` |
+| Default provider | `twitter` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `list_id` | `yes` | `string` | `-` | Twitter List ID to fetch tweets from. |
+| `count` | `no` | `integer` | `20` | Number of tweets to return (max 100). |
+| `cursor` | `no` | `string` | `` | Pagination cursor for next page. Leave empty for first page. |
+| `provider` | `no` | `string` | `twitter` | - |
+
+---
+
+### `sentiment.twitter_search`
+
+```python
+data.sentiment.twitter_search(query=..., count=20, cursor='', product='Latest', provider='twitter')
+```
+
+Summary: Twitter Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.twitter_search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/twitter_search` |
+| Default provider | `twitter` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `yes` | `string` | `-` | Search query string. |
+| `count` | `no` | `integer` | `20` | Number of tweets to return (max 40). |
+| `cursor` | `no` | `string` | `` | Pagination cursor for next page. Leave empty for first page. |
+| `product` | `no` | `string` | `Latest` | Timeline product type. One of 'Latest' or 'Top'. |
+| `provider` | `no` | `string` | `twitter` | - |
+
+---
+
+### `sentiment.twitter_tweet_detail`
+
+```python
+data.sentiment.twitter_tweet_detail(tweet_id=..., provider='twitter')
+```
+
+Summary: Twitter Tweet Detail
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.twitter_tweet_detail` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/twitter_tweet_detail` |
+| Default provider | `twitter` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `tweet_id` | `yes` | `string` | `-` | The focal tweet ID to fetch details for. |
+| `provider` | `no` | `string` | `twitter` | - |
+
+---
+
+### `sentiment.twitter_user_by_id`
+
+```python
+data.sentiment.twitter_user_by_id(user_id=..., provider='twitter')
+```
+
+Summary: Twitter User By Id
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.twitter_user_by_id` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/twitter_user_by_id` |
+| Default provider | `twitter` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `user_id` | `yes` | `string` | `-` | Twitter user ID (numeric string). |
+| `provider` | `no` | `string` | `twitter` | - |
+
+---
+
+### `sentiment.twitter_user_by_name`
+
+```python
+data.sentiment.twitter_user_by_name(screen_name=..., provider='twitter')
+```
+
+Summary: Twitter User By Name
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `sentiment.twitter_user_by_name` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/sentiment/twitter_user_by_name` |
+| Default provider | `twitter` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `screen_name` | `yes` | `string` | `-` | Twitter screen name / @handle (without @). |
+| `provider` | `no` | `string` | `twitter` | - |