@bitget-ai/getagent-skill 0.2.1 → 0.3.0

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

@@ -15,13 +15,16 @@ are callable through the DataSDK wrapper.
 - [`regulators.sec.schema_files`](#regulatorssecschema-files)
 - [`regulators.sec.sic_search`](#regulatorssecsic-search)
 - [`regulators.sec.symbol_map`](#regulatorssecsymbol-map)
+- [`uscongress.bill_info`](#uscongressbill-info)
+- [`uscongress.bill_text_urls`](#uscongressbill-text-urls)
+- [`uscongress.bills`](#uscongressbills)
 
 ## 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')
+data.regulators.cftc.cot(start_time=None, end_time=None, id='045601', report_type='legacy', futures_only=False)
 ```
 
 Summary: Cot
@@ -31,7 +34,6 @@ Summary: Cot
 | Endpoint ID | `regulators.cftc.cot` |
 | HTTP | `GET` |
 | Path | `/inner/v1/agent-data/regulators/cftc/cot` |
-| Default provider | `cftc` |
 | SDK | `supported` |
 | Host | `supported` |
 | Notes | - |
@@ -43,16 +45,15 @@ Summary: Cot
 | `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` | - |
+| `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. |
+| `futures_only` | `no` | `boolean` | `false` | Returns the futures-only report. Default is False, for the combined report. |
 
 ---
 
 ### `regulators.cftc.cot_search`
 
 ```python
-data.regulators.cftc.cot_search(query='', provider='cftc')
+data.regulators.cftc.cot_search(query='')
 ```
 
 Summary: Cot Search
@@ -62,7 +63,6 @@ Summary: Cot Search
 | 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 | - |
@@ -72,14 +72,13 @@ Summary: Cot Search
 | 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')
+data.regulators.sec.cik_map(symbol=..., use_cache=True)
 ```
 
 Summary: Cik Map
@@ -89,7 +88,6 @@ Summary: Cik Map
 | 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 | - |
@@ -99,15 +97,14 @@ Summary: Cik Map
 | 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` | - |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache for the request, default is True. |
 
 ---
 
 ### `regulators.sec.filing_headers`
 
 ```python
-data.regulators.sec.filing_headers(url='', use_cache=True, provider='sec')
+data.regulators.sec.filing_headers(url='', use_cache=True)
 ```
 
 Summary: Filing Headers
@@ -117,7 +114,6 @@ Summary: Filing Headers
 | 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 | - |
@@ -126,16 +122,15 @@ Summary: Filing Headers
 
 | 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` | - |
+| `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. |
+| `use_cache` | `no` | `boolean` | `true` | Use cache for the index headers and cover page. Default is True. |
 
 ---
 
 ### `regulators.sec.htm_file`
 
 ```python
-data.regulators.sec.htm_file(url='', use_cache=True, provider='sec')
+data.regulators.sec.htm_file(url='', use_cache=True)
 ```
 
 Summary: Htm File
@@ -145,7 +140,6 @@ Summary: Htm File
 | 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 | - |
@@ -154,16 +148,15 @@ Summary: Htm File
 
 | 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` | - |
+| `url` | `no` | `string` | `` | URL for the SEC filing. |
+| `use_cache` | `no` | `boolean` | `true` | Cache the file for use later. Default is True. |
 
 ---
 
 ### `regulators.sec.institutions_search`
 
 ```python
-data.regulators.sec.institutions_search(query='', use_cache=True, provider='sec')
+data.regulators.sec.institutions_search(query='', use_cache=True)
 ```
 
 Summary: Institutions Search
@@ -173,7 +166,6 @@ Summary: Institutions Search
 | 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 | - |
@@ -183,15 +175,14 @@ Summary: Institutions Search
 | 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` | - |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache. |
 
 ---
 
 ### `regulators.sec.rss_litigation`
 
 ```python
-data.regulators.sec.rss_litigation(provider='sec')
+data.regulators.sec.rss_litigation()
 ```
 
 Summary: Rss Litigation
@@ -201,7 +192,6 @@ Summary: Rss Litigation
 | 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 | - |
@@ -210,14 +200,13 @@ Summary: Rss Litigation
 
 | 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')
+data.regulators.sec.schema_files(taxonomy=None, year=None, component=None, category=None)
 ```
 
 Summary: Schema Files
@@ -227,7 +216,6 @@ Summary: Schema Files
 | 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 | - |
@@ -236,18 +224,17 @@ Summary: Schema Files
 
 | 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` | - |
+| `taxonomy` | `no` | `string | null` | `-` | Taxonomy family to explore. Omit to list all available taxonomies and their descriptions. |
+| `year` | `no` | `integer | null` | `-` | Taxonomy year (e.g. 2011+ for us-gaap, varies by taxonomy). Defaults to the most recent year when omitted. |
+| `component` | `no` | `string | null` | `-` | Presentation component to retrieve. Values are taxonomy-specific. Omit to return all components for the taxonomy. |
+| `category` | `no` | `string | null` | `-` | Filter taxonomies by SEC filer category. |
 
 ---
 
 ### `regulators.sec.sic_search`
 
 ```python
-data.regulators.sec.sic_search(query='', use_cache=True, provider='sec')
+data.regulators.sec.sic_search(query='', use_cache=True)
 ```
 
 Summary: Sic Search
@@ -257,7 +244,6 @@ Summary: Sic Search
 | 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 | - |
@@ -267,15 +253,14 @@ Summary: Sic Search
 | 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` | - |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache. |
 
 ---
 
 ### `regulators.sec.symbol_map`
 
 ```python
-data.regulators.sec.symbol_map(query=..., use_cache=True, provider='sec')
+data.regulators.sec.symbol_map(query=..., use_cache=True)
 ```
 
 Summary: Symbol Map
@@ -285,7 +270,6 @@ Summary: Symbol Map
 | 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 | - |
@@ -296,4 +280,85 @@ Summary: Symbol Map
 |---|---|---|---|---|
 | `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` | - |
+
+---
+
+### `uscongress.bill_info`
+
+```python
+data.uscongress.bill_info(bill_url=None)
+```
+
+Summary: Bill Info
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `uscongress.bill_info` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/uscongress/bill_info` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `bill_url` | `no` | `string | null` | `-` | Enter a base URL of a bill (e.g., 'https://api.congress.gov/v3/bill/119/s/1947?format=json'). Alternatively, you can enter a bill number (e.g., '119/s/1947'). |
+
+---
+
+### `uscongress.bill_text_urls`
+
+```python
+data.uscongress.bill_text_urls(bill_url=..., is_workspace=False)
+```
+
+Summary: Bill Text Urls
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `uscongress.bill_text_urls` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/uscongress/bill_text_urls` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `bill_url` | `yes` | `string` | `-` | Base URL or bill number of the bill to retrieve document choices for. |
+| `is_workspace` | `no` | `boolean` | `false` | - |
+
+---
+
+### `uscongress.bills`
+
+```python
+data.uscongress.bills(congress=None, bill_type=None, start_time=None, end_time=None, limit=100, offset=0, sort_by='desc')
+```
+
+Summary: Bills
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `uscongress.bills` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/regulators/uscongress/bills` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `congress` | `no` | `integer | null` | `-` | Congress number (e.g., 118 for the 118th Congress). The 103rd Congress started in 1993. Each Congress spans two years, starting in odd-numbered years. |
+| `bill_type` | `no` | `string | null` | `-` | Bill type. Must be one of: hr, s, hjres, sjres, hconres, sconres, hres, sres. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Filters bills by last updated date. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Filters bills by last updated date. |
+| `limit` | `no` | `integer | null` | `100` | The number of data entries to return. Default 100, max 250. Set to 0 for no limit (must be used with 'bill_type' and 'congress'). |
+| `offset` | `no` | `integer | null` | `0` | The starting record returned. 0 is the first record. |
+| `sort_by` | `no` | `string` | `desc` | Sort by update date. Default is latest first. enum: asc, desc |