@bitget-ai/getagent-skill 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/VERSION +1 -1
- package/package.json +1 -1
- package/skills/getagent/SKILL.md +29 -1
- package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
- package/skills/getagent/references/api/publish.md +4 -0
- package/skills/getagent/references/backtest-engine.md +80 -151
- package/skills/getagent/references/package-schema.md +30 -8
- package/skills/getagent/references/sdk/backtest/catalog.md +15 -2
- package/skills/getagent/references/sdk/data/arxiv.md +8 -10
- package/skills/getagent/references/sdk/data/catalog.md +1 -4
- package/skills/getagent/references/sdk/data/commodity.md +25 -39
- package/skills/getagent/references/sdk/data/coverage.md +0 -3
- package/skills/getagent/references/sdk/data/crypto.md +158 -357
- package/skills/getagent/references/sdk/data/currency.md +7 -15
- package/skills/getagent/references/sdk/data/derivatives.md +35 -50
- package/skills/getagent/references/sdk/data/economy.md +175 -259
- package/skills/getagent/references/sdk/data/equity.md +257 -393
- package/skills/getagent/references/sdk/data/etf.md +40 -64
- package/skills/getagent/references/sdk/data/famafrench.md +38 -50
- package/skills/getagent/references/sdk/data/fixedincome.md +89 -139
- package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
- package/skills/getagent/references/sdk/data/index.md +18 -32
- package/skills/getagent/references/sdk/data/news.md +52 -58
- package/skills/getagent/references/sdk/data/playbook-supported.md +965 -1600
- package/skills/getagent/references/sdk/data/regulators.md +23 -43
- package/skills/getagent/references/sdk/data/sentiment.md +12 -34
- package/skills/getagent/references/sdk/data/uscongress.md +13 -21
- package/skills/getagent/references/sdk/data/web_search.md +3 -7
- package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
- package/skills/getagent/scripts/validate.py +127 -1
|
@@ -15,7 +15,7 @@ are callable through the DataSDK wrapper.
|
|
|
15
15
|
### `currency.price.historical`
|
|
16
16
|
|
|
17
17
|
```python
|
|
18
|
-
data.currency.price.historical(symbol=..., start_time=None, end_time=None, interval='1d'
|
|
18
|
+
data.currency.price.historical(symbol=..., start_time=None, end_time=None, interval='1d')
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Summary: Historical
|
|
@@ -25,7 +25,6 @@ Summary: Historical
|
|
|
25
25
|
| Endpoint ID | `currency.price.historical` |
|
|
26
26
|
| HTTP | `GET` |
|
|
27
27
|
| Path | `/inner/v1/agent-data/currency/price/historical` |
|
|
28
|
-
| Default provider | - |
|
|
29
28
|
| SDK | `supported` |
|
|
30
29
|
| Host | `supported` |
|
|
31
30
|
| Notes | - |
|
|
@@ -34,18 +33,17 @@ Summary: Historical
|
|
|
34
33
|
|
|
35
34
|
| Param | Required | Type | Default | Notes |
|
|
36
35
|
|---|---|---|---|---|
|
|
37
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed
|
|
36
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed |
|
|
38
37
|
| `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. |
|
|
39
38
|
| `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. |
|
|
40
|
-
| `interval` | `no` | `string` | `1d` | Time interval of the data to return.
|
|
41
|
-
| `provider` | `yes` | `string` | `-` | enum: fmp, tiingo, yfinance |
|
|
39
|
+
| `interval` | `no` | `string` | `1d` | Time interval of the data to return. |
|
|
42
40
|
|
|
43
41
|
---
|
|
44
42
|
|
|
45
43
|
### `currency.reference_rates`
|
|
46
44
|
|
|
47
45
|
```python
|
|
48
|
-
data.currency.reference_rates(
|
|
46
|
+
data.currency.reference_rates()
|
|
49
47
|
```
|
|
50
48
|
|
|
51
49
|
Summary: Reference Rates
|
|
@@ -55,7 +53,6 @@ Summary: Reference Rates
|
|
|
55
53
|
| Endpoint ID | `currency.reference_rates` |
|
|
56
54
|
| HTTP | `GET` |
|
|
57
55
|
| Path | `/inner/v1/agent-data/currency/reference_rates` |
|
|
58
|
-
| Default provider | `ecb` |
|
|
59
56
|
| SDK | `supported` |
|
|
60
57
|
| Host | `supported` |
|
|
61
58
|
| Notes | - |
|
|
@@ -64,14 +61,13 @@ Summary: Reference Rates
|
|
|
64
61
|
|
|
65
62
|
| Param | Required | Type | Default | Notes |
|
|
66
63
|
|---|---|---|---|---|
|
|
67
|
-
| `provider` | `no` | `string` | `ecb` | - |
|
|
68
64
|
|
|
69
65
|
---
|
|
70
66
|
|
|
71
67
|
### `currency.search`
|
|
72
68
|
|
|
73
69
|
```python
|
|
74
|
-
data.currency.search(query=None
|
|
70
|
+
data.currency.search(query=None)
|
|
75
71
|
```
|
|
76
72
|
|
|
77
73
|
Summary: Search
|
|
@@ -81,7 +77,6 @@ Summary: Search
|
|
|
81
77
|
| Endpoint ID | `currency.search` |
|
|
82
78
|
| HTTP | `GET` |
|
|
83
79
|
| Path | `/inner/v1/agent-data/currency/search` |
|
|
84
|
-
| Default provider | - |
|
|
85
80
|
| SDK | `supported` |
|
|
86
81
|
| Host | `supported` |
|
|
87
82
|
| Notes | - |
|
|
@@ -91,14 +86,13 @@ Summary: Search
|
|
|
91
86
|
| Param | Required | Type | Default | Notes |
|
|
92
87
|
|---|---|---|---|---|
|
|
93
88
|
| `query` | `no` | `string | null` | `-` | Query to search for currency pairs. |
|
|
94
|
-
| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
|
|
95
89
|
|
|
96
90
|
---
|
|
97
91
|
|
|
98
92
|
### `currency.snapshots`
|
|
99
93
|
|
|
100
94
|
```python
|
|
101
|
-
data.currency.snapshots(base='usd', quote_type='indirect', counter_currencies=None
|
|
95
|
+
data.currency.snapshots(base='usd', quote_type='indirect', counter_currencies=None)
|
|
102
96
|
```
|
|
103
97
|
|
|
104
98
|
Summary: Snapshots
|
|
@@ -108,7 +102,6 @@ Summary: Snapshots
|
|
|
108
102
|
| Endpoint ID | `currency.snapshots` |
|
|
109
103
|
| HTTP | `GET` |
|
|
110
104
|
| Path | `/inner/v1/agent-data/currency/snapshots` |
|
|
111
|
-
| Default provider | - |
|
|
112
105
|
| SDK | `supported` |
|
|
113
106
|
| Host | `supported` |
|
|
114
107
|
| Notes | - |
|
|
@@ -117,7 +110,6 @@ Summary: Snapshots
|
|
|
117
110
|
|
|
118
111
|
| Param | Required | Type | Default | Notes |
|
|
119
112
|
|---|---|---|---|---|
|
|
120
|
-
| `base` | `no` | `string` | `usd` | The base currency symbol. Multiple comma separated items allowed
|
|
113
|
+
| `base` | `no` | `string` | `usd` | The base currency symbol. Multiple comma separated items allowed |
|
|
121
114
|
| `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. |
|
|
122
115
|
| `counter_currencies` | `no` | `string | array | null` | `-` | accepts array values An optional list of counter currency symbols to filter for. None returns all. |
|
|
123
|
-
| `provider` | `yes` | `string` | `-` | enum: exchangerate_api, fmp |
|
|
@@ -19,7 +19,7 @@ are callable through the DataSDK wrapper.
|
|
|
19
19
|
### `derivatives.futures.curve`
|
|
20
20
|
|
|
21
21
|
```python
|
|
22
|
-
data.derivatives.futures.curve(symbol=..., date=None, hours_ago=None
|
|
22
|
+
data.derivatives.futures.curve(symbol=..., date=None, hours_ago=None)
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
Summary: Curve
|
|
@@ -29,7 +29,6 @@ Summary: Curve
|
|
|
29
29
|
| Endpoint ID | `derivatives.futures.curve` |
|
|
30
30
|
| HTTP | `GET` |
|
|
31
31
|
| Path | `/inner/v1/agent-data/derivatives/futures/curve` |
|
|
32
|
-
| Default provider | - |
|
|
33
32
|
| SDK | `supported` |
|
|
34
33
|
| Host | `supported` |
|
|
35
34
|
| Notes | - |
|
|
@@ -38,17 +37,16 @@ Summary: Curve
|
|
|
38
37
|
|
|
39
38
|
| Param | Required | Type | Default | Notes |
|
|
40
39
|
|---|---|---|---|---|
|
|
41
|
-
| `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
|
|
42
|
-
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed
|
|
43
|
-
| `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.
|
|
44
|
-
| `provider` | `yes` | `string` | `-` | enum: cboe, deribit, yfinance |
|
|
40
|
+
| `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; Symbol to get data for. Default is 'btc' Supported symbols are: ['btc', 'eth', 'paxg'] |
|
|
41
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed |
|
|
42
|
+
| `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. |
|
|
45
43
|
|
|
46
44
|
---
|
|
47
45
|
|
|
48
46
|
### `derivatives.futures.historical`
|
|
49
47
|
|
|
50
48
|
```python
|
|
51
|
-
data.derivatives.futures.historical(symbol=..., start_time=None, end_time=None, expiration=None, interval='1d'
|
|
49
|
+
data.derivatives.futures.historical(symbol=..., start_time=None, end_time=None, expiration=None, interval='1d')
|
|
52
50
|
```
|
|
53
51
|
|
|
54
52
|
Summary: Historical
|
|
@@ -58,7 +56,6 @@ Summary: Historical
|
|
|
58
56
|
| Endpoint ID | `derivatives.futures.historical` |
|
|
59
57
|
| HTTP | `GET` |
|
|
60
58
|
| Path | `/inner/v1/agent-data/derivatives/futures/historical` |
|
|
61
|
-
| Default provider | - |
|
|
62
59
|
| SDK | `supported` |
|
|
63
60
|
| Host | `supported` |
|
|
64
61
|
| Notes | - |
|
|
@@ -67,19 +64,18 @@ Summary: Historical
|
|
|
67
64
|
|
|
68
65
|
| Param | Required | Type | Default | Notes |
|
|
69
66
|
|---|---|---|---|---|
|
|
70
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
67
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
71
68
|
| `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. |
|
|
72
69
|
| `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. |
|
|
73
70
|
| `expiration` | `no` | `string | null` | `-` | Future expiry date with format YYYY-MM |
|
|
74
|
-
| `interval` | `no` | `string` | `1d` | Time interval of the data to return.
|
|
75
|
-
| `provider` | `yes` | `string` | `-` | enum: deribit, yfinance |
|
|
71
|
+
| `interval` | `no` | `string` | `1d` | Time interval of the data to return. |
|
|
76
72
|
|
|
77
73
|
---
|
|
78
74
|
|
|
79
75
|
### `derivatives.futures.info`
|
|
80
76
|
|
|
81
77
|
```python
|
|
82
|
-
data.derivatives.futures.info(symbol=None
|
|
78
|
+
data.derivatives.futures.info(symbol=None)
|
|
83
79
|
```
|
|
84
80
|
|
|
85
81
|
Summary: Info
|
|
@@ -89,7 +85,6 @@ Summary: Info
|
|
|
89
85
|
| Endpoint ID | `derivatives.futures.info` |
|
|
90
86
|
| HTTP | `GET` |
|
|
91
87
|
| Path | `/inner/v1/agent-data/derivatives/futures/info` |
|
|
92
|
-
| Default provider | `deribit` |
|
|
93
88
|
| SDK | `supported` |
|
|
94
89
|
| Host | `supported` |
|
|
95
90
|
| Notes | - |
|
|
@@ -98,15 +93,14 @@ Summary: Info
|
|
|
98
93
|
|
|
99
94
|
| Param | Required | Type | Default | Notes |
|
|
100
95
|
|---|---|---|---|---|
|
|
101
|
-
| `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.
|
|
102
|
-
| `provider` | `no` | `string` | `deribit` | - |
|
|
96
|
+
| `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. |
|
|
103
97
|
|
|
104
98
|
---
|
|
105
99
|
|
|
106
100
|
### `derivatives.futures.instruments`
|
|
107
101
|
|
|
108
102
|
```python
|
|
109
|
-
data.derivatives.futures.instruments(
|
|
103
|
+
data.derivatives.futures.instruments()
|
|
110
104
|
```
|
|
111
105
|
|
|
112
106
|
Summary: Instruments
|
|
@@ -116,7 +110,6 @@ Summary: Instruments
|
|
|
116
110
|
| Endpoint ID | `derivatives.futures.instruments` |
|
|
117
111
|
| HTTP | `GET` |
|
|
118
112
|
| Path | `/inner/v1/agent-data/derivatives/futures/instruments` |
|
|
119
|
-
| Default provider | `deribit` |
|
|
120
113
|
| SDK | `supported` |
|
|
121
114
|
| Host | `supported` |
|
|
122
115
|
| Notes | - |
|
|
@@ -125,14 +118,13 @@ Summary: Instruments
|
|
|
125
118
|
|
|
126
119
|
| Param | Required | Type | Default | Notes |
|
|
127
120
|
|---|---|---|---|---|
|
|
128
|
-
| `provider` | `no` | `string` | `deribit` | - |
|
|
129
121
|
|
|
130
122
|
---
|
|
131
123
|
|
|
132
124
|
### `derivatives.options.chains`
|
|
133
125
|
|
|
134
126
|
```python
|
|
135
|
-
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
|
|
127
|
+
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)
|
|
136
128
|
```
|
|
137
129
|
|
|
138
130
|
Summary: Chains
|
|
@@ -142,7 +134,6 @@ Summary: Chains
|
|
|
142
134
|
| Endpoint ID | `derivatives.options.chains` |
|
|
143
135
|
| HTTP | `GET` |
|
|
144
136
|
| Path | `/inner/v1/agent-data/derivatives/options/chains` |
|
|
145
|
-
| Default provider | - |
|
|
146
137
|
| SDK | `supported` |
|
|
147
138
|
| Host | `supported` |
|
|
148
139
|
| Notes | - |
|
|
@@ -152,28 +143,27 @@ Summary: Chains
|
|
|
152
143
|
| Param | Required | Type | Default | Notes |
|
|
153
144
|
|---|---|---|---|---|
|
|
154
145
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
155
|
-
| `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
|
|
156
|
-
| `delay` | `no` | `string` | `eod` | enum: eod, realtime, delayed Whether to return delayed, realtime, or eod data.
|
|
157
|
-
| `date` | `no` | `string | null` | `-` | The end-of-day date for options chains data
|
|
158
|
-
| `option_type` | `no` | `string | null` | `-` | The option type, call or put, 'None' is both (default).
|
|
159
|
-
| `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.
|
|
160
|
-
| `strike_gt` | `no` | `integer | null` | `-` | Return options with a strike price greater than the given value. Parameter is ignored when a date is supplied.
|
|
161
|
-
| `strike_lt` | `no` | `integer | null` | `-` | Return options with a strike price less than the given value. Parameter is ignored when a date is supplied.
|
|
162
|
-
| `volume_gt` | `no` | `integer | null` | `-` | Return options with a volume greater than the given value. Parameter is ignored when a date is supplied.
|
|
163
|
-
| `volume_lt` | `no` | `integer | null` | `-` | Return options with a volume less than the given value. Parameter is ignored when a date is supplied.
|
|
164
|
-
| `oi_gt` | `no` | `integer | null` | `-` | Return options with an open interest greater than the given value. Parameter is ignored when a date is supplied.
|
|
165
|
-
| `oi_lt` | `no` | `integer | null` | `-` | Return options with an open interest less than the given value. Parameter is ignored when a date is supplied.
|
|
166
|
-
| `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.
|
|
167
|
-
| `show_extended_price` | `no` | `boolean` | `true` | Whether to include OHLC type fields, default is True. Parameter is ignored when a date is supplied.
|
|
168
|
-
| `include_related_symbols` | `no` | `boolean` | `false` | Include related symbols that end in a 1 or 2 because of a corporate action, default is False.
|
|
169
|
-
| `provider` | `yes` | `string` | `-` | enum: cboe, deribit, intrinio, tmx, tradier, yfinance |
|
|
146
|
+
| `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.; Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False. |
|
|
147
|
+
| `delay` | `no` | `string` | `eod` | enum: eod, realtime, delayed Whether to return delayed, realtime, or eod data. |
|
|
148
|
+
| `date` | `no` | `string | null` | `-` | The end-of-day date for options chains data.; A specific date to get data for. |
|
|
149
|
+
| `option_type` | `no` | `string | null` | `-` | The option type, call or put, 'None' is both (default). |
|
|
150
|
+
| `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. |
|
|
151
|
+
| `strike_gt` | `no` | `integer | null` | `-` | Return options with a strike price greater than the given value. Parameter is ignored when a date is supplied. |
|
|
152
|
+
| `strike_lt` | `no` | `integer | null` | `-` | Return options with a strike price less than the given value. Parameter is ignored when a date is supplied. |
|
|
153
|
+
| `volume_gt` | `no` | `integer | null` | `-` | Return options with a volume greater than the given value. Parameter is ignored when a date is supplied. |
|
|
154
|
+
| `volume_lt` | `no` | `integer | null` | `-` | Return options with a volume less than the given value. Parameter is ignored when a date is supplied. |
|
|
155
|
+
| `oi_gt` | `no` | `integer | null` | `-` | Return options with an open interest greater than the given value. Parameter is ignored when a date is supplied. |
|
|
156
|
+
| `oi_lt` | `no` | `integer | null` | `-` | Return options with an open interest less than the given value. Parameter is ignored when a date is supplied. |
|
|
157
|
+
| `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. |
|
|
158
|
+
| `show_extended_price` | `no` | `boolean` | `true` | Whether to include OHLC type fields, default is True. Parameter is ignored when a date is supplied. |
|
|
159
|
+
| `include_related_symbols` | `no` | `boolean` | `false` | Include related symbols that end in a 1 or 2 because of a corporate action, default is False. |
|
|
170
160
|
|
|
171
161
|
---
|
|
172
162
|
|
|
173
163
|
### `derivatives.options.snapshots`
|
|
174
164
|
|
|
175
165
|
```python
|
|
176
|
-
data.derivatives.options.snapshots(date=None, only_traded=True
|
|
166
|
+
data.derivatives.options.snapshots(date=None, only_traded=True)
|
|
177
167
|
```
|
|
178
168
|
|
|
179
169
|
Summary: Snapshots
|
|
@@ -183,7 +173,6 @@ Summary: Snapshots
|
|
|
183
173
|
| Endpoint ID | `derivatives.options.snapshots` |
|
|
184
174
|
| HTTP | `GET` |
|
|
185
175
|
| Path | `/inner/v1/agent-data/derivatives/options/snapshots` |
|
|
186
|
-
| Default provider | `intrinio` |
|
|
187
176
|
| SDK | `supported` |
|
|
188
177
|
| Host | `supported` |
|
|
189
178
|
| Notes | - |
|
|
@@ -192,9 +181,8 @@ Summary: Snapshots
|
|
|
192
181
|
|
|
193
182
|
| Param | Required | Type | Default | Notes |
|
|
194
183
|
|---|---|---|---|---|
|
|
195
|
-
| `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'
|
|
196
|
-
| `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.
|
|
197
|
-
| `provider` | `no` | `string` | `intrinio` | - |
|
|
184
|
+
| `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' |
|
|
185
|
+
| `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. |
|
|
198
186
|
|
|
199
187
|
---
|
|
200
188
|
|
|
@@ -211,7 +199,6 @@ Summary: Surface
|
|
|
211
199
|
| Endpoint ID | `derivatives.options.surface` |
|
|
212
200
|
| HTTP | `POST` |
|
|
213
201
|
| Path | `/inner/v1/agent-data/derivatives/options/surface` |
|
|
214
|
-
| Default provider | - |
|
|
215
202
|
| SDK | `supported` |
|
|
216
203
|
| Host | `supported` |
|
|
217
204
|
| Notes | - |
|
|
@@ -238,7 +225,7 @@ Summary: Surface
|
|
|
238
225
|
### `derivatives.options.unusual`
|
|
239
226
|
|
|
240
227
|
```python
|
|
241
|
-
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'
|
|
228
|
+
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')
|
|
242
229
|
```
|
|
243
230
|
|
|
244
231
|
Summary: Unusual
|
|
@@ -248,7 +235,6 @@ Summary: Unusual
|
|
|
248
235
|
| Endpoint ID | `derivatives.options.unusual` |
|
|
249
236
|
| HTTP | `GET` |
|
|
250
237
|
| Path | `/inner/v1/agent-data/derivatives/options/unusual` |
|
|
251
|
-
| Default provider | `intrinio` |
|
|
252
238
|
| SDK | `supported` |
|
|
253
239
|
| Host | `supported` |
|
|
254
240
|
| Notes | - |
|
|
@@ -260,10 +246,9 @@ Summary: Unusual
|
|
|
260
246
|
| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. (the underlying symbol) |
|
|
261
247
|
| `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. |
|
|
262
248
|
| `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. |
|
|
263
|
-
| `trade_type` | `no` | `string | null` | `-` | The type of unusual activity to query for.
|
|
264
|
-
| `sentiment` | `no` | `string | null` | `-` | The sentiment type to query for.
|
|
265
|
-
| `min_value` | `no` | `integer | number | null` | `-` | The inclusive minimum total value for the unusual activity.
|
|
266
|
-
| `max_value` | `no` | `integer | number | null` | `-` | The inclusive maximum total value for the unusual activity.
|
|
267
|
-
| `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.
|
|
268
|
-
| `source` | `no` | `string` | `delayed` | The source of the data. Either realtime or delayed.
|
|
269
|
-
| `provider` | `no` | `string` | `intrinio` | - |
|
|
249
|
+
| `trade_type` | `no` | `string | null` | `-` | The type of unusual activity to query for. |
|
|
250
|
+
| `sentiment` | `no` | `string | null` | `-` | The sentiment type to query for. |
|
|
251
|
+
| `min_value` | `no` | `integer | number | null` | `-` | The inclusive minimum total value for the unusual activity. |
|
|
252
|
+
| `max_value` | `no` | `integer | number | null` | `-` | The inclusive maximum total value for the unusual activity. |
|
|
253
|
+
| `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. |
|
|
254
|
+
| `source` | `no` | `string` | `delayed` | The source of the data. Either realtime or delayed. |
|