@bitget-ai/getagent-skill 0.2.1 → 0.3.0
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 +15 -4
- package/.claude-plugin/plugin.json +1 -1
- package/VERSION +1 -1
- package/package.json +1 -1
- package/skills/getagent/SKILL.md +169 -6
- package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
- package/skills/getagent/references/api/confirm.md +59 -0
- package/skills/getagent/references/api/index.md +9 -7
- package/skills/getagent/references/api/publish.md +13 -6
- package/skills/getagent/references/api/run.md +5 -5
- package/skills/getagent/references/api/upload.md +22 -4
- package/skills/getagent/references/backtest-engine.md +82 -152
- package/skills/getagent/references/package-schema.md +31 -8
- package/skills/getagent/references/sdk/backtest/catalog.md +17 -2
- package/skills/getagent/references/sdk/data/arxiv.md +8 -10
- package/skills/getagent/references/sdk/data/catalog.md +3 -8
- package/skills/getagent/references/sdk/data/commodity.md +71 -39
- package/skills/getagent/references/sdk/data/coverage.md +0 -3
- package/skills/getagent/references/sdk/data/crypto.md +1583 -402
- package/skills/getagent/references/sdk/data/currency.md +55 -15
- package/skills/getagent/references/sdk/data/derivatives.md +161 -50
- package/skills/getagent/references/sdk/data/economy.md +911 -259
- package/skills/getagent/references/sdk/data/equity.md +1719 -393
- package/skills/getagent/references/sdk/data/etf.md +550 -64
- package/skills/getagent/references/sdk/data/famafrench.md +38 -50
- package/skills/getagent/references/sdk/data/fixedincome.md +574 -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 +128 -58
- package/skills/getagent/references/sdk/data/regulators.md +108 -43
- package/skills/getagent/references/sdk/data/sentiment.md +188 -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/references/sdk.md +14 -5
- package/skills/getagent/scripts/validate.py +109 -3
- package/skills/getagent/scripts/version_check.sh +13 -12
- package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9871
|
@@ -29,7 +29,6 @@ Summary: Get Dataflow Dimensions
|
|
|
29
29
|
| Endpoint ID | `imf_utils.get_dataflow_dimensions` |
|
|
30
30
|
| HTTP | `GET` |
|
|
31
31
|
| Path | `/inner/v1/agent-data/imf_utils/get_dataflow_dimensions` |
|
|
32
|
-
| Default provider | - |
|
|
33
32
|
| SDK | `supported` |
|
|
34
33
|
| Host | `supported` |
|
|
35
34
|
| Notes | - |
|
|
@@ -56,7 +55,6 @@ Summary: List Dataflow Choices
|
|
|
56
55
|
| Endpoint ID | `imf_utils.list_dataflow_choices` |
|
|
57
56
|
| HTTP | `GET` |
|
|
58
57
|
| Path | `/inner/v1/agent-data/imf_utils/list_dataflow_choices` |
|
|
59
|
-
| Default provider | - |
|
|
60
58
|
| SDK | `supported` |
|
|
61
59
|
| Host | `supported` |
|
|
62
60
|
| Notes | - |
|
|
@@ -80,7 +78,6 @@ Summary: List Dataflows
|
|
|
80
78
|
| Endpoint ID | `imf_utils.list_dataflows` |
|
|
81
79
|
| HTTP | `GET` |
|
|
82
80
|
| Path | `/inner/v1/agent-data/imf_utils/list_dataflows` |
|
|
83
|
-
| Default provider | - |
|
|
84
81
|
| SDK | `supported` |
|
|
85
82
|
| Host | `supported` |
|
|
86
83
|
| Notes | - |
|
|
@@ -106,7 +103,6 @@ Summary: List Port Id Choices
|
|
|
106
103
|
| Endpoint ID | `imf_utils.list_port_id_choices` |
|
|
107
104
|
| HTTP | `GET` |
|
|
108
105
|
| Path | `/inner/v1/agent-data/imf_utils/list_port_id_choices` |
|
|
109
|
-
| Default provider | - |
|
|
110
106
|
| SDK | `supported` |
|
|
111
107
|
| Host | `supported` |
|
|
112
108
|
| Notes | - |
|
|
@@ -130,7 +126,6 @@ Summary: List Table Choices
|
|
|
130
126
|
| Endpoint ID | `imf_utils.list_table_choices` |
|
|
131
127
|
| HTTP | `GET` |
|
|
132
128
|
| Path | `/inner/v1/agent-data/imf_utils/list_table_choices` |
|
|
133
|
-
| Default provider | - |
|
|
134
129
|
| SDK | `supported` |
|
|
135
130
|
| Host | `supported` |
|
|
136
131
|
| Notes | - |
|
|
@@ -154,7 +149,6 @@ Summary: List Tables
|
|
|
154
149
|
| Endpoint ID | `imf_utils.list_tables` |
|
|
155
150
|
| HTTP | `GET` |
|
|
156
151
|
| Path | `/inner/v1/agent-data/imf_utils/list_tables` |
|
|
157
|
-
| Default provider | - |
|
|
158
152
|
| SDK | `supported` |
|
|
159
153
|
| Host | `supported` |
|
|
160
154
|
| Notes | - |
|
|
@@ -178,7 +172,6 @@ Summary: Presentation Table
|
|
|
178
172
|
| Endpoint ID | `imf_utils.presentation_table` |
|
|
179
173
|
| HTTP | `GET` |
|
|
180
174
|
| Path | `/inner/v1/agent-data/imf_utils/presentation_table` |
|
|
181
|
-
| Default provider | - |
|
|
182
175
|
| SDK | `supported` |
|
|
183
176
|
| Host | `supported` |
|
|
184
177
|
| Notes | - |
|
|
@@ -210,7 +203,6 @@ Summary: Presentation Table Choices
|
|
|
210
203
|
| Endpoint ID | `imf_utils.presentation_table_choices` |
|
|
211
204
|
| HTTP | `GET` |
|
|
212
205
|
| Path | `/inner/v1/agent-data/imf_utils/presentation_table_choices` |
|
|
213
|
-
| Default provider | - |
|
|
214
206
|
| SDK | `supported` |
|
|
215
207
|
| Host | `supported` |
|
|
216
208
|
| Notes | - |
|
|
@@ -18,7 +18,7 @@ are callable through the DataSDK wrapper.
|
|
|
18
18
|
### `index.available`
|
|
19
19
|
|
|
20
20
|
```python
|
|
21
|
-
data.index.available(use_cache=True
|
|
21
|
+
data.index.available(use_cache=True)
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Summary: Available
|
|
@@ -28,7 +28,6 @@ Summary: Available
|
|
|
28
28
|
| Endpoint ID | `index.available` |
|
|
29
29
|
| HTTP | `GET` |
|
|
30
30
|
| Path | `/inner/v1/agent-data/index/available` |
|
|
31
|
-
| Default provider | - |
|
|
32
31
|
| SDK | `supported` |
|
|
33
32
|
| Host | `supported` |
|
|
34
33
|
| Notes | - |
|
|
@@ -37,15 +36,14 @@ Summary: Available
|
|
|
37
36
|
|
|
38
37
|
| Param | Required | Type | Default | Notes |
|
|
39
38
|
|---|---|---|---|---|
|
|
40
|
-
| `use_cache` | `no` | `boolean` | `true` | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass
|
|
41
|
-
| `provider` | `yes` | `string` | `-` | enum: cboe, fmp, tmx, yfinance |
|
|
39
|
+
| `use_cache` | `no` | `boolean` | `true` | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.; 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. |
|
|
42
40
|
|
|
43
41
|
---
|
|
44
42
|
|
|
45
43
|
### `index.constituents`
|
|
46
44
|
|
|
47
45
|
```python
|
|
48
|
-
data.index.constituents(symbol=..., historical=False, use_cache=True
|
|
46
|
+
data.index.constituents(symbol=..., historical=False, use_cache=True)
|
|
49
47
|
```
|
|
50
48
|
|
|
51
49
|
Summary: Constituents
|
|
@@ -55,7 +53,6 @@ Summary: Constituents
|
|
|
55
53
|
| Endpoint ID | `index.constituents` |
|
|
56
54
|
| HTTP | `GET` |
|
|
57
55
|
| Path | `/inner/v1/agent-data/index/constituents` |
|
|
58
|
-
| Default provider | - |
|
|
59
56
|
| SDK | `supported` |
|
|
60
57
|
| Host | `supported` |
|
|
61
58
|
| Notes | - |
|
|
@@ -65,16 +62,15 @@ Summary: Constituents
|
|
|
65
62
|
| Param | Required | Type | Default | Notes |
|
|
66
63
|
|---|---|---|---|---|
|
|
67
64
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
68
|
-
| `historical` | `no` | `boolean` | `false` | Flag to retrieve historical removals and additions.
|
|
69
|
-
| `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.
|
|
70
|
-
| `provider` | `yes` | `string` | `-` | enum: cboe, fmp, tmx |
|
|
65
|
+
| `historical` | `no` | `boolean` | `false` | Flag to retrieve historical removals and additions. |
|
|
66
|
+
| `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. |
|
|
71
67
|
|
|
72
68
|
---
|
|
73
69
|
|
|
74
70
|
### `index.price.historical`
|
|
75
71
|
|
|
76
72
|
```python
|
|
77
|
-
data.index.price.historical(symbol=..., start_time=None, end_time=None, interval='1d', use_cache=True, limit=10000
|
|
73
|
+
data.index.price.historical(symbol=..., start_time=None, end_time=None, interval='1d', use_cache=True, limit=10000)
|
|
78
74
|
```
|
|
79
75
|
|
|
80
76
|
Summary: Historical
|
|
@@ -84,7 +80,6 @@ Summary: Historical
|
|
|
84
80
|
| Endpoint ID | `index.price.historical` |
|
|
85
81
|
| HTTP | `GET` |
|
|
86
82
|
| Path | `/inner/v1/agent-data/index/price/historical` |
|
|
87
|
-
| Default provider | - |
|
|
88
83
|
| SDK | `supported` |
|
|
89
84
|
| Host | `supported` |
|
|
90
85
|
| Notes | - |
|
|
@@ -93,20 +88,19 @@ Summary: Historical
|
|
|
93
88
|
|
|
94
89
|
| Param | Required | Type | Default | Notes |
|
|
95
90
|
|---|---|---|---|---|
|
|
96
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
91
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
97
92
|
| `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. |
|
|
98
93
|
| `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. |
|
|
99
|
-
| `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
|
|
100
|
-
| `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.
|
|
101
|
-
| `limit` | `no` | `integer | null` | `10000` | The number of data entries to return.
|
|
102
|
-
| `provider` | `yes` | `string` | `-` | enum: akshare, cboe, fmp, intrinio, yfinance |
|
|
94
|
+
| `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.; Time interval of the data to return. |
|
|
95
|
+
| `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. |
|
|
96
|
+
| `limit` | `no` | `integer | null` | `10000` | The number of data entries to return. |
|
|
103
97
|
|
|
104
98
|
---
|
|
105
99
|
|
|
106
100
|
### `index.search`
|
|
107
101
|
|
|
108
102
|
```python
|
|
109
|
-
data.index.search(query='', is_symbol=False, use_cache=True
|
|
103
|
+
data.index.search(query='', is_symbol=False, use_cache=True)
|
|
110
104
|
```
|
|
111
105
|
|
|
112
106
|
Summary: Search
|
|
@@ -116,7 +110,6 @@ Summary: Search
|
|
|
116
110
|
| Endpoint ID | `index.search` |
|
|
117
111
|
| HTTP | `GET` |
|
|
118
112
|
| Path | `/inner/v1/agent-data/index/search` |
|
|
119
|
-
| Default provider | `cboe` |
|
|
120
113
|
| SDK | `supported` |
|
|
121
114
|
| Host | `supported` |
|
|
122
115
|
| Notes | - |
|
|
@@ -127,15 +120,14 @@ Summary: Search
|
|
|
127
120
|
|---|---|---|---|---|
|
|
128
121
|
| `query` | `no` | `string` | `` | Search query. |
|
|
129
122
|
| `is_symbol` | `no` | `boolean` | `false` | Whether to search by ticker symbol. |
|
|
130
|
-
| `use_cache` | `no` | `boolean` | `true` | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.
|
|
131
|
-
| `provider` | `no` | `string` | `cboe` | - |
|
|
123
|
+
| `use_cache` | `no` | `boolean` | `true` | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. |
|
|
132
124
|
|
|
133
125
|
---
|
|
134
126
|
|
|
135
127
|
### `index.sectors`
|
|
136
128
|
|
|
137
129
|
```python
|
|
138
|
-
data.index.sectors(symbol=..., use_cache=True
|
|
130
|
+
data.index.sectors(symbol=..., use_cache=True)
|
|
139
131
|
```
|
|
140
132
|
|
|
141
133
|
Summary: Sectors
|
|
@@ -145,7 +137,6 @@ Summary: Sectors
|
|
|
145
137
|
| Endpoint ID | `index.sectors` |
|
|
146
138
|
| HTTP | `GET` |
|
|
147
139
|
| Path | `/inner/v1/agent-data/index/sectors` |
|
|
148
|
-
| Default provider | `tmx` |
|
|
149
140
|
| SDK | `supported` |
|
|
150
141
|
| Host | `supported` |
|
|
151
142
|
| Notes | - |
|
|
@@ -155,15 +146,14 @@ Summary: Sectors
|
|
|
155
146
|
| Param | Required | Type | Default | Notes |
|
|
156
147
|
|---|---|---|---|---|
|
|
157
148
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
158
|
-
| `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.
|
|
159
|
-
| `provider` | `no` | `string` | `tmx` | - |
|
|
149
|
+
| `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. |
|
|
160
150
|
|
|
161
151
|
---
|
|
162
152
|
|
|
163
153
|
### `index.snapshots`
|
|
164
154
|
|
|
165
155
|
```python
|
|
166
|
-
data.index.snapshots(region='us', use_cache=True
|
|
156
|
+
data.index.snapshots(region='us', use_cache=True)
|
|
167
157
|
```
|
|
168
158
|
|
|
169
159
|
Summary: Snapshots
|
|
@@ -173,7 +163,6 @@ Summary: Snapshots
|
|
|
173
163
|
| Endpoint ID | `index.snapshots` |
|
|
174
164
|
| HTTP | `GET` |
|
|
175
165
|
| Path | `/inner/v1/agent-data/index/snapshots` |
|
|
176
|
-
| Default provider | - |
|
|
177
166
|
| SDK | `supported` |
|
|
178
167
|
| Host | `supported` |
|
|
179
168
|
| Notes | - |
|
|
@@ -183,15 +172,14 @@ Summary: Snapshots
|
|
|
183
172
|
| Param | Required | Type | Default | Notes |
|
|
184
173
|
|---|---|---|---|---|
|
|
185
174
|
| `region` | `no` | `string` | `us` | The region of focus for the data - i.e., us, eu. |
|
|
186
|
-
| `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.
|
|
187
|
-
| `provider` | `yes` | `string` | `-` | enum: cboe, tmx |
|
|
175
|
+
| `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. |
|
|
188
176
|
|
|
189
177
|
---
|
|
190
178
|
|
|
191
179
|
### `index.sp500_multiples`
|
|
192
180
|
|
|
193
181
|
```python
|
|
194
|
-
data.index.sp500_multiples(start_time=None, end_time=None, series_name='pe_month'
|
|
182
|
+
data.index.sp500_multiples(start_time=None, end_time=None, series_name='pe_month')
|
|
195
183
|
```
|
|
196
184
|
|
|
197
185
|
Summary: Sp500 Multiples
|
|
@@ -201,7 +189,6 @@ Summary: Sp500 Multiples
|
|
|
201
189
|
| Endpoint ID | `index.sp500_multiples` |
|
|
202
190
|
| HTTP | `GET` |
|
|
203
191
|
| Path | `/inner/v1/agent-data/index/sp500_multiples` |
|
|
204
|
-
| Default provider | `multpl` |
|
|
205
192
|
| SDK | `supported` |
|
|
206
193
|
| Host | `supported` |
|
|
207
194
|
| Notes | - |
|
|
@@ -212,5 +199,4 @@ Summary: Sp500 Multiples
|
|
|
212
199
|
|---|---|---|---|---|
|
|
213
200
|
| `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. |
|
|
214
201
|
| `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. |
|
|
215
|
-
| `series_name` | `no` | `string` | `pe_month` | The name of the series. Defaults to 'pe_month'. Multiple comma separated items allowed
|
|
216
|
-
| `provider` | `no` | `string` | `multpl` | - |
|
|
202
|
+
| `series_name` | `no` | `string` | `pe_month` | The name of the series. Defaults to 'pe_month'. Multiple comma separated items allowed |
|
|
@@ -14,7 +14,7 @@ are callable through the DataSDK wrapper.
|
|
|
14
14
|
### `news.company`
|
|
15
15
|
|
|
16
16
|
```python
|
|
17
|
-
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
|
|
17
|
+
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)
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
Summary: Company
|
|
@@ -24,7 +24,6 @@ Summary: Company
|
|
|
24
24
|
| Endpoint ID | `news.company` |
|
|
25
25
|
| HTTP | `GET` |
|
|
26
26
|
| Path | `/inner/v1/agent-data/news/company` |
|
|
27
|
-
| Default provider | - |
|
|
28
27
|
| SDK | `supported` |
|
|
29
28
|
| Host | `supported` |
|
|
30
29
|
| Notes | - |
|
|
@@ -35,40 +34,70 @@ Summary: Company
|
|
|
35
34
|
|---|---|---|---|---|
|
|
36
35
|
| `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. |
|
|
37
36
|
| `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. |
|
|
38
|
-
| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
37
|
+
| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
39
38
|
| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
|
|
40
|
-
| `date` | `no` | `string | null` | `-` | A specific date to get data for.
|
|
41
|
-
| `display` | `no` | `string` | `full` | enum: headline, abstract, full Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).
|
|
42
|
-
| `updated_since` | `no` | `integer | null` | `-` | Number of seconds since the news was updated.
|
|
43
|
-
| `published_since` | `no` | `integer | null` | `-` | Number of seconds since the news was published.
|
|
44
|
-
| `sort` | `no` | `string` | `created` | enum: id, created, updated Key to sort the news by.
|
|
45
|
-
| `order` | `no` | `string` | `desc` | enum: asc, desc Order to sort the news by.
|
|
46
|
-
| `isin` | `no` | `string | null` | `-` | The company's ISIN.
|
|
47
|
-
| `cusip` | `no` | `string | null` | `-` | The company's CUSIP.
|
|
48
|
-
| `channels` | `no` | `string | null` | `-` | Channels of the news to retrieve.
|
|
49
|
-
| `topics` | `no` | `string | null` | `-` | Topics of the news to retrieve.
|
|
50
|
-
| `authors` | `no` | `string | null` | `-` | Authors of the news to retrieve.
|
|
51
|
-
| `content_types` | `no` | `string | null` | `-` | Content types of the news to retrieve.
|
|
52
|
-
| `page` | `no` | `integer | null` | `0` | Page number of the results. Use in combination with limit
|
|
53
|
-
| `press_release` | `no` | `boolean | null` | `-` | When true, will return only press releases for the given symbol(s).
|
|
54
|
-
| `source` | `no` | `string | null` | `-` | The source of the news article
|
|
55
|
-
| `sentiment` | `no` | `string | null` | `-` | Return news only from this source.
|
|
56
|
-
| `language` | `no` | `string | null` | `-` | Filter by language. Unsupported for yahoo source.
|
|
57
|
-
| `topic` | `no` | `string | null` | `-` | Filter by topic. Unsupported for yahoo source.
|
|
58
|
-
| `word_count_greater_than` | `no` | `integer | null` | `-` | News stories will have a word count greater than this value. Unsupported for yahoo source.
|
|
59
|
-
| `word_count_less_than` | `no` | `integer | null` | `-` | News stories will have a word count less than this value. Unsupported for yahoo source.
|
|
60
|
-
| `is_spam` | `no` | `boolean | null` | `-` | Filter whether it is marked as spam or not. Unsupported for yahoo source.
|
|
61
|
-
| `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.
|
|
62
|
-
| `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.
|
|
63
|
-
| `offset` | `no` | `integer | null` | `0` | Page offset, used in conjunction with limit.
|
|
64
|
-
|
|
39
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. |
|
|
40
|
+
| `display` | `no` | `string` | `full` | enum: headline, abstract, full Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). |
|
|
41
|
+
| `updated_since` | `no` | `integer | null` | `-` | Number of seconds since the news was updated. |
|
|
42
|
+
| `published_since` | `no` | `integer | null` | `-` | Number of seconds since the news was published. |
|
|
43
|
+
| `sort` | `no` | `string` | `created` | enum: id, created, updated Key to sort the news by. |
|
|
44
|
+
| `order` | `no` | `string` | `desc` | enum: asc, desc Order to sort the news by. |
|
|
45
|
+
| `isin` | `no` | `string | null` | `-` | The company's ISIN. |
|
|
46
|
+
| `cusip` | `no` | `string | null` | `-` | The company's CUSIP. |
|
|
47
|
+
| `channels` | `no` | `string | null` | `-` | Channels of the news to retrieve. |
|
|
48
|
+
| `topics` | `no` | `string | null` | `-` | Topics of the news to retrieve. |
|
|
49
|
+
| `authors` | `no` | `string | null` | `-` | Authors of the news to retrieve. |
|
|
50
|
+
| `content_types` | `no` | `string | null` | `-` | Content types of the news to retrieve. |
|
|
51
|
+
| `page` | `no` | `integer | null` | `0` | Page number of the results. Use in combination with limit.; The page number to start from. Use with limit. |
|
|
52
|
+
| `press_release` | `no` | `boolean | null` | `-` | When true, will return only press releases for the given symbol(s). |
|
|
53
|
+
| `source` | `no` | `string | null` | `-` | The source of the news article.; A comma-separated list of the domains requested. Multiple comma separated items allowed. |
|
|
54
|
+
| `sentiment` | `no` | `string | null` | `-` | Return news only from this source. |
|
|
55
|
+
| `language` | `no` | `string | null` | `-` | Filter by language. Unsupported for yahoo source. |
|
|
56
|
+
| `topic` | `no` | `string | null` | `-` | Filter by topic. Unsupported for yahoo source. |
|
|
57
|
+
| `word_count_greater_than` | `no` | `integer | null` | `-` | News stories will have a word count greater than this value. Unsupported for yahoo source. |
|
|
58
|
+
| `word_count_less_than` | `no` | `integer | null` | `-` | News stories will have a word count less than this value. Unsupported for yahoo source. |
|
|
59
|
+
| `is_spam` | `no` | `boolean | null` | `-` | Filter whether it is marked as spam or not. Unsupported for yahoo source. |
|
|
60
|
+
| `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. |
|
|
61
|
+
| `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. |
|
|
62
|
+
| `offset` | `no` | `integer | null` | `0` | Page offset, used in conjunction with limit. |
|
|
63
|
+
|
|
64
|
+
#### Response fields
|
|
65
|
+
|
|
66
|
+
| Field | Type | Notes |
|
|
67
|
+
|---|---|---|
|
|
68
|
+
| `date` | `string` | The date of the data. The date of publication. |
|
|
69
|
+
| `title` | `string` | Title of the article. |
|
|
70
|
+
| `author` | `string` | Author of the article. |
|
|
71
|
+
| `excerpt` | `string` | Excerpt of the article text. |
|
|
72
|
+
| `body` | `string` | Body of the article text. |
|
|
73
|
+
| `images` | `object` | Images associated with the article. |
|
|
74
|
+
| `url` | `string` | URL to the article. |
|
|
75
|
+
| `symbols` | `string` | Symbols associated with the article. |
|
|
76
|
+
| `source` | `string` | Name of the news site. |
|
|
77
|
+
| `summary` | `string` | The summary of the news article. |
|
|
78
|
+
| `topics` | `string` | The topics related to the news article. |
|
|
79
|
+
| `word_count` | `integer` | The word count of the news article. |
|
|
80
|
+
| `business_relevance` | `number` | How strongly correlated the news article is to the business. |
|
|
81
|
+
| `sentiment` | `string` | The sentiment of the news article - i.e, negative, positive. |
|
|
82
|
+
| `sentiment_confidence` | `number` | The confidence score of the sentiment rating. |
|
|
83
|
+
| `language` | `string` | The language of the news article. |
|
|
84
|
+
| `spam` | `boolean` | Whether the news article is spam. |
|
|
85
|
+
| `copyright` | `string` | The copyright notice of the news article. |
|
|
86
|
+
| `id` | `string` | Article ID. |
|
|
87
|
+
| `security` | `object` | The Intrinio Security object. Contains the security details related to the news article. |
|
|
88
|
+
| `channels` | `string` | Channels associated with the news. |
|
|
89
|
+
| `tags` | `string` | Tags associated with the news. |
|
|
90
|
+
| `updated` | `string` | Updated date of the news. |
|
|
91
|
+
| `original_id` | `string` | Original ID of the news article. |
|
|
92
|
+
| `article_id` | `integer` | Unique ID of the news article. |
|
|
93
|
+
| `crawl_date` | `string` | Date the news article was crawled. |
|
|
65
94
|
|
|
66
95
|
---
|
|
67
96
|
|
|
68
97
|
### `news.label_search`
|
|
69
98
|
|
|
70
99
|
```python
|
|
71
|
-
data.news.label_search(label=..., language_id=0, start_time=None, end_time=None, page=1, page_size=10
|
|
100
|
+
data.news.label_search(label=..., language_id=0, start_time=None, end_time=None, page=1, page_size=10)
|
|
72
101
|
```
|
|
73
102
|
|
|
74
103
|
Summary: Label Search
|
|
@@ -78,7 +107,6 @@ Summary: Label Search
|
|
|
78
107
|
| Endpoint ID | `news.label_search` |
|
|
79
108
|
| HTTP | `GET` |
|
|
80
109
|
| Path | `/inner/v1/agent-data/news/label_search` |
|
|
81
|
-
| Default provider | `bitget_data` |
|
|
82
110
|
| SDK | `supported` |
|
|
83
111
|
| Host | `supported` |
|
|
84
112
|
| Notes | - |
|
|
@@ -93,14 +121,23 @@ Summary: Label Search
|
|
|
93
121
|
| `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. |
|
|
94
122
|
| `page` | `no` | `integer | null` | `1` | Page number for pagination (1-based). Defaults to 1. |
|
|
95
123
|
| `page_size` | `no` | `integer | null` | `10` | Number of news items per page. Defaults to 10. |
|
|
96
|
-
|
|
124
|
+
|
|
125
|
+
#### Response fields
|
|
126
|
+
|
|
127
|
+
| Field | Type | Notes |
|
|
128
|
+
|---|---|---|
|
|
129
|
+
| `title` | `string` | News article title. |
|
|
130
|
+
| `content` | `string` | Full HTML/text content of the news article. |
|
|
131
|
+
| `labels` | `array` | Human-readable label names associated with the article (e.g. ['Crypto', 'Stocks']). |
|
|
132
|
+
| `language` | `string` | Locale string of the article language (e.g. 'en', 'zh-CN'). |
|
|
133
|
+
| `published_at` | `string` | Publication timestamp of the article. |
|
|
97
134
|
|
|
98
135
|
---
|
|
99
136
|
|
|
100
137
|
### `news.world`
|
|
101
138
|
|
|
102
139
|
```python
|
|
103
|
-
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
|
|
140
|
+
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)
|
|
104
141
|
```
|
|
105
142
|
|
|
106
143
|
Summary: World
|
|
@@ -110,7 +147,6 @@ Summary: World
|
|
|
110
147
|
| Endpoint ID | `news.world` |
|
|
111
148
|
| HTTP | `GET` |
|
|
112
149
|
| Path | `/inner/v1/agent-data/news/world` |
|
|
113
|
-
| Default provider | - |
|
|
114
150
|
| SDK | `supported` |
|
|
115
151
|
| Host | `supported` |
|
|
116
152
|
| Notes | Global news feed endpoint for macro/news-aware strategies. |
|
|
@@ -122,28 +158,62 @@ Summary: World
|
|
|
122
158
|
| `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. |
|
|
123
159
|
| `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. |
|
|
124
160
|
| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. The number of articles to return. |
|
|
125
|
-
| `date` | `no` | `string | null` | `-` | A specific date to get data for.
|
|
126
|
-
| `display` | `no` | `string` | `full` | enum: headline, abstract, full Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).
|
|
127
|
-
| `updated_since` | `no` | `integer | null` | `-` | Number of seconds since the news was updated.
|
|
128
|
-
| `published_since` | `no` | `integer | null` | `-` | Number of seconds since the news was published.
|
|
129
|
-
| `sort` | `no` | `string` | `created` | enum: id, created, updated Key to sort the news by.
|
|
130
|
-
| `order` | `no` | `string` | `desc` | enum: asc, desc Order to sort the news by.
|
|
131
|
-
| `isin` | `no` | `string | null` | `-` | The ISIN of the news to retrieve.
|
|
132
|
-
| `cusip` | `no` | `string | null` | `-` | The CUSIP of the news to retrieve.
|
|
133
|
-
| `channels` | `no` | `string | null` | `-` | Channels of the news to retrieve.
|
|
134
|
-
| `topics` | `no` | `string | null` | `-` | Topics of the news to retrieve.
|
|
135
|
-
| `authors` | `no` | `string | null` | `-` | Authors of the news to retrieve.
|
|
136
|
-
| `content_types` | `no` | `string | null` | `-` | Content types of the news to retrieve.
|
|
137
|
-
| `term` | `no` | `string | null` | `-` | Search term to filter articles by. This overrides all other filters.
|
|
138
|
-
| `source` | `no` | `string | null` | `-` | Filter by a specific publisher. Only valid when filter is set to source
|
|
139
|
-
| `topic` | `no` | `string | null` | `general` | The topic of the news to be fetched
|
|
140
|
-
| `page` | `no` | `integer | null` | `-` | Page number of the results. Use in combination with limit.
|
|
141
|
-
| `sentiment` | `no` | `string | null` | `-` | Return news only from this source.
|
|
142
|
-
| `language` | `no` | `string | null` | `-` | Filter by language. Unsupported for yahoo source.
|
|
143
|
-
| `word_count_greater_than` | `no` | `integer | null` | `-` | News stories will have a word count greater than this value. Unsupported for yahoo source.
|
|
144
|
-
| `word_count_less_than` | `no` | `integer | null` | `-` | News stories will have a word count less than this value. Unsupported for yahoo source.
|
|
145
|
-
| `is_spam` | `no` | `boolean | null` | `-` | Filter whether it is marked as spam or not. Unsupported for yahoo source.
|
|
146
|
-
| `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.
|
|
147
|
-
| `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.
|
|
148
|
-
| `offset` | `no` | `integer | null` | `0` | Page offset, used in conjunction with limit.
|
|
149
|
-
|
|
161
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. |
|
|
162
|
+
| `display` | `no` | `string` | `full` | enum: headline, abstract, full Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). |
|
|
163
|
+
| `updated_since` | `no` | `integer | null` | `-` | Number of seconds since the news was updated. |
|
|
164
|
+
| `published_since` | `no` | `integer | null` | `-` | Number of seconds since the news was published. |
|
|
165
|
+
| `sort` | `no` | `string` | `created` | enum: id, created, updated Key to sort the news by. |
|
|
166
|
+
| `order` | `no` | `string` | `desc` | enum: asc, desc Order to sort the news by. |
|
|
167
|
+
| `isin` | `no` | `string | null` | `-` | The ISIN of the news to retrieve. |
|
|
168
|
+
| `cusip` | `no` | `string | null` | `-` | The CUSIP of the news to retrieve. |
|
|
169
|
+
| `channels` | `no` | `string | null` | `-` | Channels of the news to retrieve. |
|
|
170
|
+
| `topics` | `no` | `string | null` | `-` | Topics of the news to retrieve. |
|
|
171
|
+
| `authors` | `no` | `string | null` | `-` | Authors of the news to retrieve. |
|
|
172
|
+
| `content_types` | `no` | `string | null` | `-` | Content types of the news to retrieve. |
|
|
173
|
+
| `term` | `no` | `string | null` | `-` | Search term to filter articles by. This overrides all other filters. |
|
|
174
|
+
| `source` | `no` | `string | null` | `-` | Filter by a specific publisher. Only valid when filter is set to source.; The source of the news article.; A comma-separated list of the domains requested. Multiple comma separated items allowed. |
|
|
175
|
+
| `topic` | `no` | `string | null` | `general` | The topic of the news to be fetched.; Filter by topic. Unsupported for yahoo source. |
|
|
176
|
+
| `page` | `no` | `integer | null` | `-` | Page number of the results. Use in combination with limit. |
|
|
177
|
+
| `sentiment` | `no` | `string | null` | `-` | Return news only from this source. |
|
|
178
|
+
| `language` | `no` | `string | null` | `-` | Filter by language. Unsupported for yahoo source. |
|
|
179
|
+
| `word_count_greater_than` | `no` | `integer | null` | `-` | News stories will have a word count greater than this value. Unsupported for yahoo source. |
|
|
180
|
+
| `word_count_less_than` | `no` | `integer | null` | `-` | News stories will have a word count less than this value. Unsupported for yahoo source. |
|
|
181
|
+
| `is_spam` | `no` | `boolean | null` | `-` | Filter whether it is marked as spam or not. Unsupported for yahoo source. |
|
|
182
|
+
| `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. |
|
|
183
|
+
| `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. |
|
|
184
|
+
| `offset` | `no` | `integer | null` | `0` | Page offset, used in conjunction with limit. |
|
|
185
|
+
|
|
186
|
+
#### Response fields
|
|
187
|
+
|
|
188
|
+
| Field | Type | Notes |
|
|
189
|
+
|---|---|---|
|
|
190
|
+
| `date` | `string` | The date of the data. The date of publication. |
|
|
191
|
+
| `title` | `string` | Title of the article. |
|
|
192
|
+
| `author` | `string` | Author of the article. |
|
|
193
|
+
| `excerpt` | `string` | Excerpt of the article text. |
|
|
194
|
+
| `body` | `string` | Body of the article text. |
|
|
195
|
+
| `images` | `object` | Images associated with the article. |
|
|
196
|
+
| `url` | `string` | URL to the article. |
|
|
197
|
+
| `source` | `string` | News source. |
|
|
198
|
+
| `tags` | `array` | Tags for the article. |
|
|
199
|
+
| `score` | `number` | Search relevance score for the article. |
|
|
200
|
+
| `symbols` | `string` | Ticker tagged in the fetched news. |
|
|
201
|
+
| `article_id` | `integer` | Unique ID of the news article. |
|
|
202
|
+
| `site` | `string` | News source. |
|
|
203
|
+
| `crawl_date` | `string` | Date the news article was crawled. |
|
|
204
|
+
| `channels` | `string` | Channels associated with the news. |
|
|
205
|
+
| `stocks` | `string` | Stocks associated with the news. |
|
|
206
|
+
| `updated` | `string` | Updated date of the news. |
|
|
207
|
+
| `id` | `string` | Article ID. |
|
|
208
|
+
| `updated_id` | `string` | Updated article ID if the article was updated. |
|
|
209
|
+
| `summary` | `string` | The summary of the news article. |
|
|
210
|
+
| `topics` | `string` | The topics related to the news article. |
|
|
211
|
+
| `word_count` | `integer` | The word count of the news article. |
|
|
212
|
+
| `business_relevance` | `number` | How strongly correlated the news article is to the business. |
|
|
213
|
+
| `sentiment` | `string` | The sentiment of the news article - i.e, negative, positive. |
|
|
214
|
+
| `sentiment_confidence` | `number` | The confidence score of the sentiment rating. |
|
|
215
|
+
| `language` | `string` | The language of the news article. |
|
|
216
|
+
| `spam` | `boolean` | Whether the news article is spam. |
|
|
217
|
+
| `copyright` | `string` | The copyright notice of the news article. |
|
|
218
|
+
| `company` | `object` | The Intrinio Company object. Contains details company reference data. |
|
|
219
|
+
| `security` | `object` | The Intrinio Security object. Contains the security details related to the news article. |
|