@bitget-ai/getagent-skill 0.2.1

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

@@ -0,0 +1,123 @@
+# Currency 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
+- [`currency.price.historical`](#currencypricehistorical)
+- [`currency.reference_rates`](#currencyreference-rates)
+- [`currency.search`](#currencysearch)
+- [`currency.snapshots`](#currencysnapshots)
+
+## Endpoint reference
+
+### `currency.price.historical`
+
+```python
+data.currency.price.historical(symbol=..., start_time=None, end_time=None, interval='1d', provider=...)
+```
+
+Summary: Historical
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `currency.price.historical` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/currency/price/historical` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, tiingo, 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. (provider: fmp,tiingo, yfinance) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, tiingo, yfinance |
+
+---
+
+### `currency.reference_rates`
+
+```python
+data.currency.reference_rates(provider='ecb')
+```
+
+Summary: Reference Rates
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `currency.reference_rates` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/currency/reference_rates` |
+| Default provider | `ecb` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `provider` | `no` | `string` | `ecb` | - |
+
+---
+
+### `currency.search`
+
+```python
+data.currency.search(query=None, provider=...)
+```
+
+Summary: Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `currency.search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/currency/search` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `no` | `string | null` | `-` | Query to search for currency pairs. |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
+
+---
+
+### `currency.snapshots`
+
+```python
+data.currency.snapshots(base='usd', quote_type='indirect', counter_currencies=None, provider=...)
+```
+
+Summary: Snapshots
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `currency.snapshots` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/currency/snapshots` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `base` | `no` | `string` | `usd` | The base currency symbol. Multiple comma separated items allowed for provider(s): fmp. |
+| `quote_type` | `no` | `string` | `indirect` | enum: direct, indirect Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency. |
+| `counter_currencies` | `no` | `string | array | null` | `-` | accepts array values An optional list of counter currency symbols to filter for. None returns all. |
+| `provider` | `yes` | `string` | `-` | enum: exchangerate_api, fmp |

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

@@ -0,0 +1,269 @@
+# Derivatives 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
+- [`derivatives.futures.curve`](#derivativesfuturescurve)
+- [`derivatives.futures.historical`](#derivativesfutureshistorical)
+- [`derivatives.futures.info`](#derivativesfuturesinfo)
+- [`derivatives.futures.instruments`](#derivativesfuturesinstruments)
+- [`derivatives.options.chains`](#derivativesoptionschains)
+- [`derivatives.options.snapshots`](#derivativesoptionssnapshots)
+- [`derivatives.options.surface`](#derivativesoptionssurface)
+- [`derivatives.options.unusual`](#derivativesoptionsunusual)
+
+## Endpoint reference
+
+### `derivatives.futures.curve`
+
+```python
+data.derivatives.futures.curve(symbol=..., date=None, hours_ago=None, provider=...)
+```
+
+Summary: Curve
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.futures.curve` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/futures/curve` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for.; Symbol to get data for.Default is 'VX_EOD'. Entered dates return the data nearest to the entered date. 'VX_AM' = Mid-Morning TWAP Levels 'VX_EOD' = 4PM Eastern Time Levels (provider: cboe); Symbol to get data for. Default is 'btc' Supported symbols are: ['btc', 'eth', 'paxg'] (provider: deribit) |
+| `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed for provider(s): cboe, yfinance. |
+| `hours_ago` | `no` | `integer | array | string | null` | `-` | accepts array values Compare the current curve with the specified number of hours ago. Default is None. Multiple comma separated items allowed. (provider: deribit) |
+| `provider` | `yes` | `string` | `-` | enum: cboe, deribit, yfinance |
+
+---
+
+### `derivatives.futures.historical`
+
+```python
+data.derivatives.futures.historical(symbol=..., start_time=None, end_time=None, expiration=None, interval='1d', provider=...)
+```
+
+Summary: Historical
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.futures.historical` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/futures/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): deribit, 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. |
+| `expiration` | `no` | `string | null` | `-` | Future expiry date with format YYYY-MM |
+| `interval` | `no` | `string` | `1d` | Time interval of the data to return. (provider: deribit, yfinance) |
+| `provider` | `yes` | `string` | `-` | enum: deribit, yfinance |
+
+---
+
+### `derivatives.futures.info`
+
+```python
+data.derivatives.futures.info(symbol=None, provider='deribit')
+```
+
+Summary: Info
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.futures.info` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/futures/info` |
+| Default provider | `deribit` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Perpetual contracts can be referenced by their currency pair - i.e, SOLUSDC - or by their official Deribit symbol - i.e, SOL_USDC-PERPETUAL For a list of currently available instruments, use `derivatives.futures.instruments()` Multiple comma separated items allowed. (provider: deribit) |
+| `provider` | `no` | `string` | `deribit` | - |
+
+---
+
+### `derivatives.futures.instruments`
+
+```python
+data.derivatives.futures.instruments(provider='deribit')
+```
+
+Summary: Instruments
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.futures.instruments` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/futures/instruments` |
+| Default provider | `deribit` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `provider` | `no` | `string` | `deribit` | - |
+
+---
+
+### `derivatives.options.chains`
+
+```python
+data.derivatives.options.chains(symbol=..., use_cache=True, delay='eod', date=None, option_type=None, moneyness='all', strike_gt=None, strike_lt=None, volume_gt=None, volume_lt=None, oi_gt=None, oi_lt=None, model='black_scholes', show_extended_price=True, include_related_symbols=False, provider=...)
+```
+
+Summary: Chains
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.options.chains` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/options/chains` |
+| Default provider | - |
+| 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` | When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe); Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False. (provider: tmx) |
+| `delay` | `no` | `string` | `eod` | enum: eod, realtime, delayed Whether to return delayed, realtime, or eod data. (provider: intrinio) |
+| `date` | `no` | `string | null` | `-` | The end-of-day date for options chains data. (provider: intrinio); A specific date to get data for. (provider: tmx) |
+| `option_type` | `no` | `string | null` | `-` | The option type, call or put, 'None' is both (default). (provider: intrinio) |
+| `moneyness` | `no` | `string` | `all` | enum: otm, itm, all Return only contracts that are in or out of the money, default is 'all'. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `strike_gt` | `no` | `integer | null` | `-` | Return options with a strike price greater than the given value. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `strike_lt` | `no` | `integer | null` | `-` | Return options with a strike price less than the given value. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `volume_gt` | `no` | `integer | null` | `-` | Return options with a volume greater than the given value. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `volume_lt` | `no` | `integer | null` | `-` | Return options with a volume less than the given value. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `oi_gt` | `no` | `integer | null` | `-` | Return options with an open interest greater than the given value. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `oi_lt` | `no` | `integer | null` | `-` | Return options with an open interest less than the given value. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `model` | `no` | `string` | `black_scholes` | enum: black_scholes, bjerk The pricing model to use for options chains data, default is 'black_scholes'. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `show_extended_price` | `no` | `boolean` | `true` | Whether to include OHLC type fields, default is True. Parameter is ignored when a date is supplied. (provider: intrinio) |
+| `include_related_symbols` | `no` | `boolean` | `false` | Include related symbols that end in a 1 or 2 because of a corporate action, default is False. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: cboe, deribit, intrinio, tmx, tradier, yfinance |
+
+---
+
+### `derivatives.options.snapshots`
+
+```python
+data.derivatives.options.snapshots(date=None, only_traded=True, provider='intrinio')
+```
+
+Summary: Snapshots
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.options.snapshots` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/options/snapshots` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `date` | `no` | `string | null` | `-` | The date of the data. Can be a datetime or an ISO datetime string. Data appears to go back to around 2022-06-01 Example: '2024-03-08T12:15:00+0400' (provider: intrinio) |
+| `only_traded` | `no` | `boolean` | `true` | Only include options that have been traded during the session, default is True. Setting to false will dramatically increase the size of the response - use with caution. (provider: intrinio) |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `derivatives.options.surface`
+
+```python
+data.derivatives.options.surface(target='implied_volatility', underlying_price=None, option_type='otm', dte_min=None, dte_max=None, moneyness=None, strike_min=None, strike_max=None, oi=False, volume=False, theme='dark', body=...)
+```
+
+Summary: Surface
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.options.surface` |
+| HTTP | `POST` |
+| Path | `/inner/v1/agent-data/derivatives/options/surface` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `target` | `no` | `string` | `implied_volatility` | - |
+| `underlying_price` | `no` | `number | null` | `-` | - |
+| `option_type` | `no` | `string | null` | `otm` | - |
+| `dte_min` | `no` | `integer | null` | `-` | - |
+| `dte_max` | `no` | `integer | null` | `-` | - |
+| `moneyness` | `no` | `number | null` | `-` | - |
+| `strike_min` | `no` | `number | null` | `-` | - |
+| `strike_max` | `no` | `number | null` | `-` | - |
+| `oi` | `no` | `boolean` | `false` | - |
+| `volume` | `no` | `boolean` | `false` | - |
+| `theme` | `no` | `string` | `dark` | enum: dark, light |
+| `body` | `yes` | `object` | `-` | JSON request body. |
+
+---
+
+### `derivatives.options.unusual`
+
+```python
+data.derivatives.options.unusual(symbol=None, start_time=None, end_time=None, trade_type=None, sentiment=None, min_value=None, max_value=None, limit=100000, source='delayed', provider='intrinio')
+```
+
+Summary: Unusual
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `derivatives.options.unusual` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/derivatives/options/unusual` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. (the underlying symbol) |
+| `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. |
+| `trade_type` | `no` | `string | null` | `-` | The type of unusual activity to query for. (provider: intrinio) |
+| `sentiment` | `no` | `string | null` | `-` | The sentiment type to query for. (provider: intrinio) |
+| `min_value` | `no` | `integer | number | null` | `-` | The inclusive minimum total value for the unusual activity. (provider: intrinio) |
+| `max_value` | `no` | `integer | number | null` | `-` | The inclusive maximum total value for the unusual activity. (provider: intrinio) |
+| `limit` | `no` | `integer` | `100000` | The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance. (provider: intrinio) |
+| `source` | `no` | `string` | `delayed` | The source of the data. Either realtime or delayed. (provider: intrinio) |
+| `provider` | `no` | `string` | `intrinio` | - |