@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
|
@@ -53,7 +53,7 @@ are callable through the DataSDK wrapper.
|
|
|
53
53
|
### `economy.available_indicators`
|
|
54
54
|
|
|
55
55
|
```python
|
|
56
|
-
data.economy.available_indicators(use_cache=True, query=None, dataflows=None, keywords=None, symbol=None
|
|
56
|
+
data.economy.available_indicators(use_cache=True, query=None, dataflows=None, keywords=None, symbol=None)
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
Summary: Available Indicators
|
|
@@ -63,7 +63,6 @@ Summary: Available Indicators
|
|
|
63
63
|
| Endpoint ID | `economy.available_indicators` |
|
|
64
64
|
| HTTP | `GET` |
|
|
65
65
|
| Path | `/inner/v1/agent-data/economy/available_indicators` |
|
|
66
|
-
| Default provider | - |
|
|
67
66
|
| SDK | `supported` |
|
|
68
67
|
| Host | `supported` |
|
|
69
68
|
| Notes | - |
|
|
@@ -72,19 +71,18 @@ Summary: Available Indicators
|
|
|
72
71
|
|
|
73
72
|
| Param | Required | Type | Default | Notes |
|
|
74
73
|
|---|---|---|---|---|
|
|
75
|
-
| `use_cache` | `no` | `boolean` | `true` | Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.
|
|
76
|
-
| `query` | `no` | `string | null` | `-` | The search query string. Multiple search phrases can be separated by semicolons. Each phrase can use AND (+) and OR (|) operators, as well as quoted phrases. Semicolon separation allows commas to be used within search phrases. Multiple comma separated items allowed.
|
|
77
|
-
| `dataflows` | `no` | `string | array | null` | `-` | accepts array values List of IMF dataflow IDs to filter the indicators. Use semicolons to separate multiple dataflow IDs. Multiple comma separated items allowed.
|
|
78
|
-
| `keywords` | `no` | `string | array | null` | `-` | accepts array values List of keywords to filter results. Each keyword is a single word that must appear in the indicator's label or description. Keywords prefixed with 'not' will exclude indicators containing that word (e.g., 'not USD' excludes indicators with 'USD' in them). Multiple comma separated items allowed.
|
|
79
|
-
| `symbol` | `no` | `string | null` | `-` | Dummy field to allow grouping by symbol. Multiple comma separated items allowed.
|
|
80
|
-
| `provider` | `yes` | `string` | `-` | enum: econdb, imf |
|
|
74
|
+
| `use_cache` | `no` | `boolean` | `true` | Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. |
|
|
75
|
+
| `query` | `no` | `string | null` | `-` | The search query string. Multiple search phrases can be separated by semicolons. Each phrase can use AND (+) and OR (| ) operators, as well as quoted phrases. Semicolon separation allows commas to be used within search phrases. Multiple comma separated items allowed. |
|
|
76
|
+
| `dataflows` | `no` | `string | array | null` | `-` | accepts array values List of IMF dataflow IDs to filter the indicators. Use semicolons to separate multiple dataflow IDs. Multiple comma separated items allowed. |
|
|
77
|
+
| `keywords` | `no` | `string | array | null` | `-` | accepts array values List of keywords to filter results. Each keyword is a single word that must appear in the indicator's label or description. Keywords prefixed with 'not' will exclude indicators containing that word (e.g., 'not USD' excludes indicators with 'USD' in them). Multiple comma separated items allowed. |
|
|
78
|
+
| `symbol` | `no` | `string | null` | `-` | Dummy field to allow grouping by symbol. Multiple comma separated items allowed. |
|
|
81
79
|
|
|
82
80
|
---
|
|
83
81
|
|
|
84
82
|
### `economy.balance_of_payments`
|
|
85
83
|
|
|
86
84
|
```python
|
|
87
|
-
data.economy.balance_of_payments(start_time=None, end_time=None, report_type='main', frequency='monthly', country=None
|
|
85
|
+
data.economy.balance_of_payments(start_time=None, end_time=None, report_type='main', frequency='monthly', country=None)
|
|
88
86
|
```
|
|
89
87
|
|
|
90
88
|
Summary: Balance Of Payments
|
|
@@ -94,7 +92,6 @@ Summary: Balance Of Payments
|
|
|
94
92
|
| Endpoint ID | `economy.balance_of_payments` |
|
|
95
93
|
| HTTP | `GET` |
|
|
96
94
|
| Path | `/inner/v1/agent-data/economy/balance_of_payments` |
|
|
97
|
-
| Default provider | - |
|
|
98
95
|
| SDK | `supported` |
|
|
99
96
|
| Host | `supported` |
|
|
100
97
|
| Notes | - |
|
|
@@ -105,17 +102,16 @@ Summary: Balance Of Payments
|
|
|
105
102
|
|---|---|---|---|---|
|
|
106
103
|
| `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. |
|
|
107
104
|
| `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. |
|
|
108
|
-
| `report_type` | `no` | `string` | `main` | enum: main, summary, services, investment_income, direct_investment, portfolio_investment, other_investment The report type, the level of detail in the data.
|
|
109
|
-
| `frequency` | `no` | `string` | `monthly` | enum: monthly, quarterly The frequency of the data. Monthly is valid only for ['main', 'summary'].
|
|
110
|
-
| `country` | `no` | `string` | `-` | The country/region of the data. This parameter will override the 'report_type' parameter
|
|
111
|
-
| `provider` | `yes` | `string` | `-` | enum: ecb, fred |
|
|
105
|
+
| `report_type` | `no` | `string` | `main` | enum: main, summary, services, investment_income, direct_investment, portfolio_investment, other_investment The report type, the level of detail in the data. |
|
|
106
|
+
| `frequency` | `no` | `string` | `monthly` | enum: monthly, quarterly The frequency of the data. Monthly is valid only for ['main', 'summary']. |
|
|
107
|
+
| `country` | `no` | `string` | `-` | The country/region of the data. This parameter will override the 'report_type' parameter.; The country to get data. Enter as a 3-letter ISO country code, default is USA. |
|
|
112
108
|
|
|
113
109
|
---
|
|
114
110
|
|
|
115
111
|
### `economy.calendar`
|
|
116
112
|
|
|
117
113
|
```python
|
|
118
|
-
data.economy.calendar(start_time=None, end_time=None, release_id=None, country=None, importance=None, group=None, calendar_id=None
|
|
114
|
+
data.economy.calendar(start_time=None, end_time=None, release_id=None, country=None, importance=None, group=None, calendar_id=None)
|
|
119
115
|
```
|
|
120
116
|
|
|
121
117
|
Summary: Calendar
|
|
@@ -125,7 +121,6 @@ Summary: Calendar
|
|
|
125
121
|
| Endpoint ID | `economy.calendar` |
|
|
126
122
|
| HTTP | `GET` |
|
|
127
123
|
| Path | `/inner/v1/agent-data/economy/calendar` |
|
|
128
|
-
| Default provider | - |
|
|
129
124
|
| SDK | `supported` |
|
|
130
125
|
| Host | `supported` |
|
|
131
126
|
| Notes | - |
|
|
@@ -136,19 +131,18 @@ Summary: Calendar
|
|
|
136
131
|
|---|---|---|---|---|
|
|
137
132
|
| `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. |
|
|
138
133
|
| `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. |
|
|
139
|
-
| `release_id` | `no` | `integer | null` | `-` | Filter by release ID.
|
|
140
|
-
| `country` | `no` | `string | null` | `-` | Country of the event. Accepts country names, ISO 3166-1 alpha-2/alpha-3 codes. Multiple comma-separated values allowed. Multiple comma separated items allowed
|
|
141
|
-
| `importance` | `no` | `string | null` | `-` | Importance of the event.
|
|
142
|
-
| `group` | `no` | `string | null` | `-` | Grouping of events.
|
|
143
|
-
| `calendar_id` | `no` | `integer | string | null` | `-` | Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed.
|
|
144
|
-
| `provider` | `yes` | `string` | `-` | enum: fmp, fred, nasdaq, tradingeconomics |
|
|
134
|
+
| `release_id` | `no` | `integer | null` | `-` | Filter by release ID. |
|
|
135
|
+
| `country` | `no` | `string | null` | `-` | Country of the event. Accepts country names, ISO 3166-1 alpha-2/alpha-3 codes. Multiple comma-separated values allowed. Multiple comma separated items allowed.; Country of the event. Multiple comma separated items allowed. |
|
|
136
|
+
| `importance` | `no` | `string | null` | `-` | Importance of the event. |
|
|
137
|
+
| `group` | `no` | `string | null` | `-` | Grouping of events. |
|
|
138
|
+
| `calendar_id` | `no` | `integer | string | null` | `-` | Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. |
|
|
145
139
|
|
|
146
140
|
---
|
|
147
141
|
|
|
148
142
|
### `economy.central_bank_holdings`
|
|
149
143
|
|
|
150
144
|
```python
|
|
151
|
-
data.economy.central_bank_holdings(date=None, holding_type='all_treasury', summary=False, cusip=None, wam=False, monthly=False
|
|
145
|
+
data.economy.central_bank_holdings(date=None, holding_type='all_treasury', summary=False, cusip=None, wam=False, monthly=False)
|
|
152
146
|
```
|
|
153
147
|
|
|
154
148
|
Summary: Central Bank Holdings
|
|
@@ -158,7 +152,6 @@ Summary: Central Bank Holdings
|
|
|
158
152
|
| Endpoint ID | `economy.central_bank_holdings` |
|
|
159
153
|
| HTTP | `GET` |
|
|
160
154
|
| Path | `/inner/v1/agent-data/economy/central_bank_holdings` |
|
|
161
|
-
| Default provider | `federal_reserve` |
|
|
162
155
|
| SDK | `supported` |
|
|
163
156
|
| Host | `supported` |
|
|
164
157
|
| Notes | - |
|
|
@@ -168,19 +161,18 @@ Summary: Central Bank Holdings
|
|
|
168
161
|
| Param | Required | Type | Default | Notes |
|
|
169
162
|
|---|---|---|---|---|
|
|
170
163
|
| `date` | `no` | `string | null` | `-` | A specific date to get data for. |
|
|
171
|
-
| `holding_type` | `no` | `string` | `all_treasury` | Type of holdings to return.
|
|
172
|
-
| `summary` | `no` | `boolean` | `false` | If True, returns historical weekly summary by holding type. This parameter takes priority over other parameters.
|
|
164
|
+
| `holding_type` | `no` | `string` | `all_treasury` | Type of holdings to return. |
|
|
165
|
+
| `summary` | `no` | `boolean` | `false` | If True, returns historical weekly summary by holding type. This parameter takes priority over other parameters. |
|
|
173
166
|
| `cusip` | `no` | `string | null` | `-` | Multiple comma separated items allowed. |
|
|
174
|
-
| `wam` | `no` | `boolean` | `false` | If True, returns weighted average maturity aggregated by agency or treasury securities. This parameter takes priority over `holding_type`, `cusip`, and `monthly`.
|
|
175
|
-
| `monthly` | `no` | `boolean` | `false` | If True, returns historical data for all Treasury securities at a monthly interval. This parameter takes priority over other parameters, except `wam`. Only valid when `holding_type` is set to: 'all_treasury', 'bills', 'notesbonds', 'frn', 'tips'.
|
|
176
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
167
|
+
| `wam` | `no` | `boolean` | `false` | If True, returns weighted average maturity aggregated by agency or treasury securities. This parameter takes priority over `holding_type`, `cusip`, and `monthly`. |
|
|
168
|
+
| `monthly` | `no` | `boolean` | `false` | If True, returns historical data for all Treasury securities at a monthly interval. This parameter takes priority over other parameters, except `wam`. Only valid when `holding_type` is set to: 'all_treasury', 'bills', 'notesbonds', 'frn', 'tips'. |
|
|
177
169
|
|
|
178
170
|
---
|
|
179
171
|
|
|
180
172
|
### `economy.composite_leading_indicator`
|
|
181
173
|
|
|
182
174
|
```python
|
|
183
|
-
data.economy.composite_leading_indicator(start_time=None, end_time=None, country='g20', adjustment='amplitude', growth_rate=False
|
|
175
|
+
data.economy.composite_leading_indicator(start_time=None, end_time=None, country='g20', adjustment='amplitude', growth_rate=False)
|
|
184
176
|
```
|
|
185
177
|
|
|
186
178
|
Summary: Composite Leading Indicator
|
|
@@ -190,7 +182,6 @@ Summary: Composite Leading Indicator
|
|
|
190
182
|
| Endpoint ID | `economy.composite_leading_indicator` |
|
|
191
183
|
| HTTP | `GET` |
|
|
192
184
|
| Path | `/inner/v1/agent-data/economy/composite_leading_indicator` |
|
|
193
|
-
| Default provider | `oecd` |
|
|
194
185
|
| SDK | `supported` |
|
|
195
186
|
| Host | `supported` |
|
|
196
187
|
| Notes | - |
|
|
@@ -201,17 +192,16 @@ Summary: Composite Leading Indicator
|
|
|
201
192
|
|---|---|---|---|---|
|
|
202
193
|
| `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. |
|
|
203
194
|
| `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. |
|
|
204
|
-
| `country` | `no` | `string` | `g20` | Country to get the CLI for, default is G20. Multiple comma separated items allowed.
|
|
205
|
-
| `adjustment` | `no` | `string` | `amplitude` | Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude.
|
|
206
|
-
| `growth_rate` | `no` | `boolean` | `false` | Return the 1-year growth rate (%) of the CLI, default is False.
|
|
207
|
-
| `provider` | `no` | `string` | `oecd` | - |
|
|
195
|
+
| `country` | `no` | `string` | `g20` | Country to get the CLI for, default is G20. Multiple comma separated items allowed. |
|
|
196
|
+
| `adjustment` | `no` | `string` | `amplitude` | Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude. |
|
|
197
|
+
| `growth_rate` | `no` | `boolean` | `false` | Return the 1-year growth rate (%) of the CLI, default is False. |
|
|
208
198
|
|
|
209
199
|
---
|
|
210
200
|
|
|
211
201
|
### `economy.country_profile`
|
|
212
202
|
|
|
213
203
|
```python
|
|
214
|
-
data.economy.country_profile(country=..., latest=True, use_cache=True
|
|
204
|
+
data.economy.country_profile(country=..., latest=True, use_cache=True)
|
|
215
205
|
```
|
|
216
206
|
|
|
217
207
|
Summary: Country Profile
|
|
@@ -221,7 +211,6 @@ Summary: Country Profile
|
|
|
221
211
|
| Endpoint ID | `economy.country_profile` |
|
|
222
212
|
| HTTP | `GET` |
|
|
223
213
|
| Path | `/inner/v1/agent-data/economy/country_profile` |
|
|
224
|
-
| Default provider | `econdb` |
|
|
225
214
|
| SDK | `supported` |
|
|
226
215
|
| Host | `supported` |
|
|
227
216
|
| Notes | - |
|
|
@@ -230,17 +219,16 @@ Summary: Country Profile
|
|
|
230
219
|
|
|
231
220
|
| Param | Required | Type | Default | Notes |
|
|
232
221
|
|---|---|---|---|---|
|
|
233
|
-
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed
|
|
234
|
-
| `latest` | `no` | `boolean` | `true` | If True, return only the latest data. If False, return all available data for each indicator.
|
|
235
|
-
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.
|
|
236
|
-
| `provider` | `no` | `string` | `econdb` | - |
|
|
222
|
+
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed |
|
|
223
|
+
| `latest` | `no` | `boolean` | `true` | If True, return only the latest data. If False, return all available data for each indicator. |
|
|
224
|
+
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. |
|
|
237
225
|
|
|
238
226
|
---
|
|
239
227
|
|
|
240
228
|
### `economy.cpi`
|
|
241
229
|
|
|
242
230
|
```python
|
|
243
|
-
data.economy.cpi(start_time=None, end_time=None, country='united_states', transform='yoy', frequency='monthly', harmonized=False, expenditure='total', limit=None
|
|
231
|
+
data.economy.cpi(start_time=None, end_time=None, country='united_states', transform='yoy', frequency='monthly', harmonized=False, expenditure='total', limit=None)
|
|
244
232
|
```
|
|
245
233
|
|
|
246
234
|
Summary: Cpi
|
|
@@ -250,7 +238,6 @@ Summary: Cpi
|
|
|
250
238
|
| Endpoint ID | `economy.cpi` |
|
|
251
239
|
| HTTP | `GET` |
|
|
252
240
|
| Path | `/inner/v1/agent-data/economy/cpi` |
|
|
253
|
-
| Default provider | - |
|
|
254
241
|
| SDK | `supported` |
|
|
255
242
|
| Host | `supported` |
|
|
256
243
|
| Notes | - |
|
|
@@ -261,20 +248,19 @@ Summary: Cpi
|
|
|
261
248
|
|---|---|---|---|---|
|
|
262
249
|
| `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. |
|
|
263
250
|
| `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. |
|
|
264
|
-
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed
|
|
251
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
265
252
|
| `transform` | `no` | `string` | `yoy` | Transformation of the CPI data. |
|
|
266
253
|
| `frequency` | `no` | `string` | `monthly` | enum: annual, quarter, monthly The frequency of the data. |
|
|
267
254
|
| `harmonized` | `no` | `boolean` | `false` | If true, returns harmonized data. |
|
|
268
|
-
| `expenditure` | `no` | `string` | `total` | Expenditure component of CPI.
|
|
269
|
-
| `limit` | `no` | `integer | null` | `-` | Maximum number of records to retrieve per series and country. If None, retrieves all available records.
|
|
270
|
-
| `provider` | `yes` | `string` | `-` | enum: fred, imf, oecd |
|
|
255
|
+
| `expenditure` | `no` | `string` | `total` | Expenditure component of CPI. |
|
|
256
|
+
| `limit` | `no` | `integer | null` | `-` | Maximum number of records to retrieve per series and country. If None, retrieves all available records. |
|
|
271
257
|
|
|
272
258
|
---
|
|
273
259
|
|
|
274
260
|
### `economy.direction_of_trade`
|
|
275
261
|
|
|
276
262
|
```python
|
|
277
|
-
data.economy.direction_of_trade(start_time=None, end_time=None, country=None, counterpart=None, direction='balance', frequency='month', limit=None
|
|
263
|
+
data.economy.direction_of_trade(start_time=None, end_time=None, country=None, counterpart=None, direction='balance', frequency='month', limit=None)
|
|
278
264
|
```
|
|
279
265
|
|
|
280
266
|
Summary: Direction Of Trade
|
|
@@ -284,7 +270,6 @@ Summary: Direction Of Trade
|
|
|
284
270
|
| Endpoint ID | `economy.direction_of_trade` |
|
|
285
271
|
| HTTP | `GET` |
|
|
286
272
|
| Path | `/inner/v1/agent-data/economy/direction_of_trade` |
|
|
287
|
-
| Default provider | `imf` |
|
|
288
273
|
| SDK | `supported` |
|
|
289
274
|
| Host | `supported` |
|
|
290
275
|
| Notes | - |
|
|
@@ -295,19 +280,18 @@ Summary: Direction Of Trade
|
|
|
295
280
|
|---|---|---|---|---|
|
|
296
281
|
| `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. |
|
|
297
282
|
| `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. |
|
|
298
|
-
| `country` | `no` | `string | null` | `-` | The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple comma separated items allowed
|
|
299
|
-
| `counterpart` | `no` | `string | null` | `-` | Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple comma separated items allowed
|
|
283
|
+
| `country` | `no` | `string | null` | `-` | The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple comma separated items allowed |
|
|
284
|
+
| `counterpart` | `no` | `string | null` | `-` | Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple comma separated items allowed |
|
|
300
285
|
| `direction` | `no` | `string` | `balance` | Trade direction. Use 'all' to get all data for this dimension. |
|
|
301
286
|
| `frequency` | `no` | `string` | `month` | The frequency of the data. |
|
|
302
|
-
| `limit` | `no` | `integer | null` | `-` | Limit the number of results returned, the most recent data points first.
|
|
303
|
-
| `provider` | `no` | `string` | `imf` | - |
|
|
287
|
+
| `limit` | `no` | `integer | null` | `-` | Limit the number of results returned, the most recent data points first. |
|
|
304
288
|
|
|
305
289
|
---
|
|
306
290
|
|
|
307
291
|
### `economy.export_destinations`
|
|
308
292
|
|
|
309
293
|
```python
|
|
310
|
-
data.economy.export_destinations(country
|
|
294
|
+
data.economy.export_destinations(country=...)
|
|
311
295
|
```
|
|
312
296
|
|
|
313
297
|
Summary: Export Destinations
|
|
@@ -317,7 +301,6 @@ Summary: Export Destinations
|
|
|
317
301
|
| Endpoint ID | `economy.export_destinations` |
|
|
318
302
|
| HTTP | `GET` |
|
|
319
303
|
| Path | `/inner/v1/agent-data/economy/export_destinations` |
|
|
320
|
-
| Default provider | `econdb` |
|
|
321
304
|
| SDK | `supported` |
|
|
322
305
|
| Host | `supported` |
|
|
323
306
|
| Notes | - |
|
|
@@ -326,15 +309,14 @@ Summary: Export Destinations
|
|
|
326
309
|
|
|
327
310
|
| Param | Required | Type | Default | Notes |
|
|
328
311
|
|---|---|---|---|---|
|
|
329
|
-
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed
|
|
330
|
-
| `provider` | `no` | `string` | `econdb` | - |
|
|
312
|
+
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed |
|
|
331
313
|
|
|
332
314
|
---
|
|
333
315
|
|
|
334
316
|
### `economy.fomc_documents`
|
|
335
317
|
|
|
336
318
|
```python
|
|
337
|
-
data.economy.fomc_documents(year=None, document_type=None
|
|
319
|
+
data.economy.fomc_documents(year=None, document_type=None)
|
|
338
320
|
```
|
|
339
321
|
|
|
340
322
|
Summary: Fomc Documents
|
|
@@ -344,7 +326,6 @@ Summary: Fomc Documents
|
|
|
344
326
|
| Endpoint ID | `economy.fomc_documents` |
|
|
345
327
|
| HTTP | `GET` |
|
|
346
328
|
| Path | `/inner/v1/agent-data/economy/fomc_documents` |
|
|
347
|
-
| Default provider | `federal_reserve` |
|
|
348
329
|
| SDK | `supported` |
|
|
349
330
|
| Host | `supported` |
|
|
350
331
|
| Notes | - |
|
|
@@ -353,16 +334,15 @@ Summary: Fomc Documents
|
|
|
353
334
|
|
|
354
335
|
| Param | Required | Type | Default | Notes |
|
|
355
336
|
|---|---|---|---|---|
|
|
356
|
-
| `year` | `no` | `integer | null` | `-` | The year of FOMC documents to retrieve. If None, all years since 1959 are returned.
|
|
357
|
-
| `document_type` | `no` | `string | null` | `-` | Filter by document type. Default is all. Choose from: all, monetary_policy, minutes, projections, materials, press_release, press_conference, agenda, transcript, speaker_key, beige_book, teal_book, green_book, blue_book, red_book
|
|
358
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
337
|
+
| `year` | `no` | `integer | null` | `-` | The year of FOMC documents to retrieve. If None, all years since 1959 are returned. |
|
|
338
|
+
| `document_type` | `no` | `string | null` | `-` | Filter by document type. Default is all. Choose from: all, monetary_policy, minutes, projections, materials, press_release, press_conference, agenda, transcript, speaker_key, beige_book, teal_book, green_book, blue_book, red_book |
|
|
359
339
|
|
|
360
340
|
---
|
|
361
341
|
|
|
362
342
|
### `economy.fred_regional`
|
|
363
343
|
|
|
364
344
|
```python
|
|
365
|
-
data.economy.fred_regional(symbol=..., start_time=None, end_time=None, limit=100000, is_series_group=False, region_type=None, season='nsa', units=None, frequency=None, aggregation_method='eop', transform=None
|
|
345
|
+
data.economy.fred_regional(symbol=..., start_time=None, end_time=None, limit=100000, is_series_group=False, region_type=None, season='nsa', units=None, frequency=None, aggregation_method='eop', transform=None)
|
|
366
346
|
```
|
|
367
347
|
|
|
368
348
|
Summary: Fred Regional
|
|
@@ -372,7 +352,6 @@ Summary: Fred Regional
|
|
|
372
352
|
| Endpoint ID | `economy.fred_regional` |
|
|
373
353
|
| HTTP | `GET` |
|
|
374
354
|
| Path | `/inner/v1/agent-data/economy/fred_regional` |
|
|
375
|
-
| Default provider | `fred` |
|
|
376
355
|
| SDK | `supported` |
|
|
377
356
|
| Host | `supported` |
|
|
378
357
|
| Notes | - |
|
|
@@ -381,25 +360,24 @@ Summary: Fred Regional
|
|
|
381
360
|
|
|
382
361
|
| Param | Required | Type | Default | Notes |
|
|
383
362
|
|---|---|---|---|---|
|
|
384
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for.; For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.
|
|
363
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for.; For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data. |
|
|
385
364
|
| `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. |
|
|
386
365
|
| `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. |
|
|
387
366
|
| `limit` | `no` | `integer | null` | `100000` | The number of data entries to return. |
|
|
388
|
-
| `is_series_group` | `no` | `boolean` | `false` | When True, the symbol provided is for a series_group, else it is for a series ID.
|
|
389
|
-
| `region_type` | `no` | `string | null` | `-` | The type of regional data. Parameter is only valid when `is_series_group` is True.
|
|
390
|
-
| `season` | `no` | `string` | `nsa` | The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.
|
|
391
|
-
| `units` | `no` | `string | null` | `-` | The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.
|
|
392
|
-
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday
|
|
393
|
-
| `aggregation_method` | `no` | `string | null` | `eop` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period
|
|
394
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
395
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
367
|
+
| `is_series_group` | `no` | `boolean` | `false` | When True, the symbol provided is for a series_group, else it is for a series ID. |
|
|
368
|
+
| `region_type` | `no` | `string | null` | `-` | The type of regional data. Parameter is only valid when `is_series_group` is True. |
|
|
369
|
+
| `season` | `no` | `string` | `nsa` | The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. |
|
|
370
|
+
| `units` | `no` | `string | null` | `-` | The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True. |
|
|
371
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday |
|
|
372
|
+
| `aggregation_method` | `no` | `string | null` | `eop` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period |
|
|
373
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
396
374
|
|
|
397
375
|
---
|
|
398
376
|
|
|
399
377
|
### `economy.fred_release_table`
|
|
400
378
|
|
|
401
379
|
```python
|
|
402
|
-
data.economy.fred_release_table(release_id=..., element_id=None, date=None
|
|
380
|
+
data.economy.fred_release_table(release_id=..., element_id=None, date=None)
|
|
403
381
|
```
|
|
404
382
|
|
|
405
383
|
Summary: Fred Release Table
|
|
@@ -409,7 +387,6 @@ Summary: Fred Release Table
|
|
|
409
387
|
| Endpoint ID | `economy.fred_release_table` |
|
|
410
388
|
| HTTP | `GET` |
|
|
411
389
|
| Path | `/inner/v1/agent-data/economy/fred_release_table` |
|
|
412
|
-
| Default provider | `fred` |
|
|
413
390
|
| SDK | `supported` |
|
|
414
391
|
| Host | `supported` |
|
|
415
392
|
| Notes | - |
|
|
@@ -420,15 +397,14 @@ Summary: Fred Release Table
|
|
|
420
397
|
|---|---|---|---|---|
|
|
421
398
|
| `release_id` | `yes` | `string` | `-` | The ID of the release. Use `fred_search` to find releases. |
|
|
422
399
|
| `element_id` | `no` | `string | null` | `-` | The element ID of a specific table in the release. |
|
|
423
|
-
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed
|
|
424
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
400
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed |
|
|
425
401
|
|
|
426
402
|
---
|
|
427
403
|
|
|
428
404
|
### `economy.fred_search`
|
|
429
405
|
|
|
430
406
|
```python
|
|
431
|
-
data.economy.fred_search(query=None, search_type='full_text', release_id=None, limit=None, offset=0, order_by='observation_end', sort_order='desc', filter_variable=None, filter_value=None, tag_names=None, exclude_tag_names=None, series_id=None
|
|
407
|
+
data.economy.fred_search(query=None, search_type='full_text', release_id=None, limit=None, offset=0, order_by='observation_end', sort_order='desc', filter_variable=None, filter_value=None, tag_names=None, exclude_tag_names=None, series_id=None)
|
|
432
408
|
```
|
|
433
409
|
|
|
434
410
|
Summary: Fred Search
|
|
@@ -438,7 +414,6 @@ Summary: Fred Search
|
|
|
438
414
|
| Endpoint ID | `economy.fred_search` |
|
|
439
415
|
| HTTP | `GET` |
|
|
440
416
|
| Path | `/inner/v1/agent-data/economy/fred_search` |
|
|
441
|
-
| Default provider | `fred` |
|
|
442
417
|
| SDK | `supported` |
|
|
443
418
|
| Host | `supported` |
|
|
444
419
|
| Notes | - |
|
|
@@ -448,25 +423,24 @@ Summary: Fred Search
|
|
|
448
423
|
| Param | Required | Type | Default | Notes |
|
|
449
424
|
|---|---|---|---|---|
|
|
450
425
|
| `query` | `no` | `string | null` | `-` | The search word(s). |
|
|
451
|
-
| `search_type` | `no` | `string` | `full_text` | enum: full_text, series_id, release The type of search to perform. Automatically set to 'release' when a 'release_id' is provided.
|
|
452
|
-
| `release_id` | `no` | `integer | null` | `-` | A specific release ID to target.
|
|
453
|
-
| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (1-1000)
|
|
454
|
-
| `offset` | `no` | `integer | null` | `0` | Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'.
|
|
455
|
-
| `order_by` | `no` | `string` | `observation_end` | enum: search_rank, series_id, title, units, frequency, seasonal_adjustment, realtime_start, realtime_end, last_updated, observation_start, observation_end, popularity, group_popularity Order the results by a specific attribute. The default is 'observation_end'.
|
|
456
|
-
| `sort_order` | `no` | `string` | `desc` | Sort the 'order_by' item in ascending or descending order. The default is 'desc'.
|
|
457
|
-
| `filter_variable` | `no` | `string | null` | `-` | Filter by an attribute.
|
|
458
|
-
| `filter_value` | `no` | `string | null` | `-` | String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'.
|
|
459
|
-
| `tag_names` | `no` | `string | null` | `-` | A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple comma separated items allowed.
|
|
460
|
-
| `exclude_tag_names` | `no` | `string | null` | `-` | A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. This parameter is ignored when search_type is 'release'. Multiple comma separated items allowed.
|
|
461
|
-
| `series_id` | `no` | `string | null` | `-` | A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.
|
|
462
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
426
|
+
| `search_type` | `no` | `string` | `full_text` | enum: full_text, series_id, release The type of search to perform. Automatically set to 'release' when a 'release_id' is provided. |
|
|
427
|
+
| `release_id` | `no` | `integer | null` | `-` | A specific release ID to target. |
|
|
428
|
+
| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (1-1000) |
|
|
429
|
+
| `offset` | `no` | `integer | null` | `0` | Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'. |
|
|
430
|
+
| `order_by` | `no` | `string` | `observation_end` | enum: search_rank, series_id, title, units, frequency, seasonal_adjustment, realtime_start, realtime_end, last_updated, observation_start, observation_end, popularity, group_popularity Order the results by a specific attribute. The default is 'observation_end'. |
|
|
431
|
+
| `sort_order` | `no` | `string` | `desc` | Sort the 'order_by' item in ascending or descending order. The default is 'desc'. |
|
|
432
|
+
| `filter_variable` | `no` | `string | null` | `-` | Filter by an attribute. |
|
|
433
|
+
| `filter_value` | `no` | `string | null` | `-` | String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'. |
|
|
434
|
+
| `tag_names` | `no` | `string | null` | `-` | A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple comma separated items allowed. |
|
|
435
|
+
| `exclude_tag_names` | `no` | `string | null` | `-` | A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. This parameter is ignored when search_type is 'release'. Multiple comma separated items allowed. |
|
|
436
|
+
| `series_id` | `no` | `string | null` | `-` | A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas. |
|
|
463
437
|
|
|
464
438
|
---
|
|
465
439
|
|
|
466
440
|
### `economy.fred_series`
|
|
467
441
|
|
|
468
442
|
```python
|
|
469
|
-
data.economy.fred_series(symbol=..., start_time=None, end_time=None, limit=100000, frequency=None, aggregation_method='eop', transform=None, all_pages=False, sleep=1.0
|
|
443
|
+
data.economy.fred_series(symbol=..., start_time=None, end_time=None, limit=100000, frequency=None, aggregation_method='eop', transform=None, all_pages=False, sleep=1.0)
|
|
470
444
|
```
|
|
471
445
|
|
|
472
446
|
Summary: Fred Series
|
|
@@ -476,7 +450,6 @@ Summary: Fred Series
|
|
|
476
450
|
| Endpoint ID | `economy.fred_series` |
|
|
477
451
|
| HTTP | `GET` |
|
|
478
452
|
| Path | `/inner/v1/agent-data/economy/fred_series` |
|
|
479
|
-
| Default provider | - |
|
|
480
453
|
| SDK | `supported` |
|
|
481
454
|
| Host | `supported` |
|
|
482
455
|
| Notes | Replacement target for future data.macro.* facade work. |
|
|
@@ -485,23 +458,22 @@ Summary: Fred Series
|
|
|
485
458
|
|
|
486
459
|
| Param | Required | Type | Default | Notes |
|
|
487
460
|
|---|---|---|---|---|
|
|
488
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
461
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
489
462
|
| `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. |
|
|
490
463
|
| `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. |
|
|
491
464
|
| `limit` | `no` | `integer | null` | `100000` | The number of data entries to return. |
|
|
492
|
-
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday
|
|
493
|
-
| `aggregation_method` | `no` | `string | null` | `eop` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period
|
|
494
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
495
|
-
| `all_pages` | `no` | `boolean | null` | `false` | Returns all pages of data from the API call at once.
|
|
496
|
-
| `sleep` | `no` | `number | null` | `1.0` | Time to sleep between requests to avoid rate limiting.
|
|
497
|
-
| `provider` | `yes` | `string` | `-` | enum: fred, intrinio |
|
|
465
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday |
|
|
466
|
+
| `aggregation_method` | `no` | `string | null` | `eop` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period |
|
|
467
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
468
|
+
| `all_pages` | `no` | `boolean | null` | `false` | Returns all pages of data from the API call at once. |
|
|
469
|
+
| `sleep` | `no` | `number | null` | `1.0` | Time to sleep between requests to avoid rate limiting. |
|
|
498
470
|
|
|
499
471
|
---
|
|
500
472
|
|
|
501
473
|
### `economy.gdp.forecast`
|
|
502
474
|
|
|
503
475
|
```python
|
|
504
|
-
data.economy.gdp.forecast(start_time=None, end_time=None, country='all', frequency='annual', units='volume'
|
|
476
|
+
data.economy.gdp.forecast(start_time=None, end_time=None, country='all', frequency='annual', units='volume')
|
|
505
477
|
```
|
|
506
478
|
|
|
507
479
|
Summary: Forecast
|
|
@@ -511,7 +483,6 @@ Summary: Forecast
|
|
|
511
483
|
| Endpoint ID | `economy.gdp.forecast` |
|
|
512
484
|
| HTTP | `GET` |
|
|
513
485
|
| Path | `/inner/v1/agent-data/economy/gdp/forecast` |
|
|
514
|
-
| Default provider | `oecd` |
|
|
515
486
|
| SDK | `supported` |
|
|
516
487
|
| Host | `supported` |
|
|
517
488
|
| Notes | - |
|
|
@@ -522,17 +493,16 @@ Summary: Forecast
|
|
|
522
493
|
|---|---|---|---|---|
|
|
523
494
|
| `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. |
|
|
524
495
|
| `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. |
|
|
525
|
-
| `country` | `no` | `string` | `all` | Country, or countries, to get forward GDP projections for. Default is all. Multiple comma separated items allowed.
|
|
526
|
-
| `frequency` | `no` | `string` | `annual` | Frequency of the data, default is annual.
|
|
527
|
-
| `units` | `no` | `string` | `volume` | Units of the data, default is volume (chain linked volume, 2015). 'current_prices', 'volume', and 'capita' are expressed in USD; 'growth' as a percent; 'deflator' as an index.
|
|
528
|
-
| `provider` | `no` | `string` | `oecd` | - |
|
|
496
|
+
| `country` | `no` | `string` | `all` | Country, or countries, to get forward GDP projections for. Default is all. Multiple comma separated items allowed. |
|
|
497
|
+
| `frequency` | `no` | `string` | `annual` | Frequency of the data, default is annual. |
|
|
498
|
+
| `units` | `no` | `string` | `volume` | Units of the data, default is volume (chain linked volume, 2015). 'current_prices', 'volume', and 'capita' are expressed in USD; 'growth' as a percent; 'deflator' as an index. |
|
|
529
499
|
|
|
530
500
|
---
|
|
531
501
|
|
|
532
502
|
### `economy.gdp.nominal`
|
|
533
503
|
|
|
534
504
|
```python
|
|
535
|
-
data.economy.gdp.nominal(start_time=None, end_time=None, country='united_states', use_cache=True, frequency='quarter', units='level', price_base='current_prices'
|
|
505
|
+
data.economy.gdp.nominal(start_time=None, end_time=None, country='united_states', use_cache=True, frequency='quarter', units='level', price_base='current_prices')
|
|
536
506
|
```
|
|
537
507
|
|
|
538
508
|
Summary: Nominal
|
|
@@ -542,7 +512,6 @@ Summary: Nominal
|
|
|
542
512
|
| Endpoint ID | `economy.gdp.nominal` |
|
|
543
513
|
| HTTP | `GET` |
|
|
544
514
|
| Path | `/inner/v1/agent-data/economy/gdp/nominal` |
|
|
545
|
-
| Default provider | - |
|
|
546
515
|
| SDK | `supported` |
|
|
547
516
|
| Host | `supported` |
|
|
548
517
|
| Notes | - |
|
|
@@ -553,19 +522,18 @@ Summary: Nominal
|
|
|
553
522
|
|---|---|---|---|---|
|
|
554
523
|
| `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. |
|
|
555
524
|
| `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. |
|
|
556
|
-
| `country` | `no` | `string` | `united_states` | The country to get data.Use 'all' to get data for all available countries.
|
|
557
|
-
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.
|
|
558
|
-
| `frequency` | `no` | `string` | `quarter` | enum: quarter, annual Frequency of the data.
|
|
559
|
-
| `units` | `no` | `string` | `level` | enum: level, index, capita The unit of measurement for the data.Both 'level' and 'capita' (per) are measured in USD.
|
|
560
|
-
| `price_base` | `no` | `string` | `current_prices` | enum: current_prices, volume Price base for the data, volume is chain linked volume.
|
|
561
|
-
| `provider` | `yes` | `string` | `-` | enum: econdb, oecd |
|
|
525
|
+
| `country` | `no` | `string` | `united_states` | The country to get data.Use 'all' to get data for all available countries. |
|
|
526
|
+
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. |
|
|
527
|
+
| `frequency` | `no` | `string` | `quarter` | enum: quarter, annual Frequency of the data. |
|
|
528
|
+
| `units` | `no` | `string` | `level` | enum: level, index, capita The unit of measurement for the data.Both 'level' and 'capita' (per) are measured in USD. |
|
|
529
|
+
| `price_base` | `no` | `string` | `current_prices` | enum: current_prices, volume Price base for the data, volume is chain linked volume. |
|
|
562
530
|
|
|
563
531
|
---
|
|
564
532
|
|
|
565
533
|
### `economy.gdp.real`
|
|
566
534
|
|
|
567
535
|
```python
|
|
568
|
-
data.economy.gdp.real(start_time=None, end_time=None, country='united_states', use_cache=True, frequency='quarter'
|
|
536
|
+
data.economy.gdp.real(start_time=None, end_time=None, country='united_states', use_cache=True, frequency='quarter')
|
|
569
537
|
```
|
|
570
538
|
|
|
571
539
|
Summary: Real
|
|
@@ -575,7 +543,6 @@ Summary: Real
|
|
|
575
543
|
| Endpoint ID | `economy.gdp.real` |
|
|
576
544
|
| HTTP | `GET` |
|
|
577
545
|
| Path | `/inner/v1/agent-data/economy/gdp/real` |
|
|
578
|
-
| Default provider | - |
|
|
579
546
|
| SDK | `supported` |
|
|
580
547
|
| Host | `supported` |
|
|
581
548
|
| Notes | - |
|
|
@@ -586,17 +553,16 @@ Summary: Real
|
|
|
586
553
|
|---|---|---|---|---|
|
|
587
554
|
| `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. |
|
|
588
555
|
| `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. |
|
|
589
|
-
| `country` | `no` | `string` | `united_states` | The country to get data.Use 'all' to get data for all available countries.
|
|
590
|
-
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.
|
|
591
|
-
| `frequency` | `no` | `string` | `quarter` | enum: quarter, annual Frequency of the data.
|
|
592
|
-
| `provider` | `yes` | `string` | `-` | enum: econdb, oecd |
|
|
556
|
+
| `country` | `no` | `string` | `united_states` | The country to get data.Use 'all' to get data for all available countries. |
|
|
557
|
+
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. |
|
|
558
|
+
| `frequency` | `no` | `string` | `quarter` | enum: quarter, annual Frequency of the data. |
|
|
593
559
|
|
|
594
560
|
---
|
|
595
561
|
|
|
596
562
|
### `economy.house_price_index`
|
|
597
563
|
|
|
598
564
|
```python
|
|
599
|
-
data.economy.house_price_index(start_time=None, end_time=None, country='united_states', frequency='quarter', transform='index'
|
|
565
|
+
data.economy.house_price_index(start_time=None, end_time=None, country='united_states', frequency='quarter', transform='index')
|
|
600
566
|
```
|
|
601
567
|
|
|
602
568
|
Summary: House Price Index
|
|
@@ -606,7 +572,6 @@ Summary: House Price Index
|
|
|
606
572
|
| Endpoint ID | `economy.house_price_index` |
|
|
607
573
|
| HTTP | `GET` |
|
|
608
574
|
| Path | `/inner/v1/agent-data/economy/house_price_index` |
|
|
609
|
-
| Default provider | `oecd` |
|
|
610
575
|
| SDK | `supported` |
|
|
611
576
|
| Host | `supported` |
|
|
612
577
|
| Notes | - |
|
|
@@ -617,17 +582,16 @@ Summary: House Price Index
|
|
|
617
582
|
|---|---|---|---|---|
|
|
618
583
|
| `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. |
|
|
619
584
|
| `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. |
|
|
620
|
-
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed
|
|
585
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
621
586
|
| `frequency` | `no` | `string` | `quarter` | The frequency of the data. |
|
|
622
587
|
| `transform` | `no` | `string` | `index` | Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy). |
|
|
623
|
-
| `provider` | `no` | `string` | `oecd` | - |
|
|
624
588
|
|
|
625
589
|
---
|
|
626
590
|
|
|
627
591
|
### `economy.indicators`
|
|
628
592
|
|
|
629
593
|
```python
|
|
630
|
-
data.economy.indicators(symbol=..., start_time=None, end_time=None, country=None, frequency=None, transform=None, use_cache=True, dimension_values=None, limit=None, pivot=False
|
|
594
|
+
data.economy.indicators(symbol=..., start_time=None, end_time=None, country=None, frequency=None, transform=None, use_cache=True, dimension_values=None, limit=None, pivot=False)
|
|
631
595
|
```
|
|
632
596
|
|
|
633
597
|
Summary: Indicators
|
|
@@ -637,7 +601,6 @@ Summary: Indicators
|
|
|
637
601
|
| Endpoint ID | `economy.indicators` |
|
|
638
602
|
| HTTP | `GET` |
|
|
639
603
|
| Path | `/inner/v1/agent-data/economy/indicators` |
|
|
640
|
-
| Default provider | - |
|
|
641
604
|
| SDK | `supported` |
|
|
642
605
|
| Host | `supported` |
|
|
643
606
|
| Notes | - |
|
|
@@ -646,24 +609,23 @@ Summary: Indicators
|
|
|
646
609
|
|
|
647
610
|
| Param | Required | Type | Default | Notes |
|
|
648
611
|
|---|---|---|---|---|
|
|
649
|
-
| `symbol` | `yes` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
612
|
+
| `symbol` | `yes` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed; Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Use `available_indicators()` to get a list of available symbols.; Symbol to get data for. Symbol format: 'dataflow::identifier' where identifier is either: - A table ID (starts with 'H_') for hierarchical table data - An indicator code for individual indicator data Examples: - 'BOP::H_BOP_BOP_AGG_STANDARD_PRESENTATION' - Balance of Payments table - 'BOP_AGG::GS_CD,BOP_AGG::GS_DB' - Multiple BOP_AGG indicators (Goods & Services) - 'IL::RGV_REVS' - Gold reserves in millions of fine troy ounces - 'WEO::NGDP_RPCH' - Real GDP growth (annual only) - 'WEO::POILBRE' - Brent crude oil price (use country='G001' for world) - 'PCPS::PGOLD' - Gold price per troy ounce (monthly/quarterly available) Use `obb.economy.available_indicators()` to discover symbols. Use `obb.economy.imf_utils.list_tables()` to see available tables. |
|
|
650
613
|
| `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. |
|
|
651
614
|
| `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. |
|
|
652
|
-
| `country` | `no` | `string | null` | `-` | The country to get data. Multiple comma separated items allowed
|
|
653
|
-
| `frequency` | `no` | `string | null` | `-` | The frequency of the data.; The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'
|
|
654
|
-
| `transform` | `no` | `string | null` | `-` | The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies
|
|
655
|
-
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.
|
|
656
|
-
| `dimension_values` | `no` | `array | null` | `-` | accepts array values List of additional dimension filters in 'DIM_ID:DIM_VALUE' format. Parameter can be entered multiple times.
|
|
657
|
-
| `limit` | `no` | `integer | null` | `-` | Maximum number of records to retrieve per series.
|
|
658
|
-
| `pivot` | `no` | `boolean` | `false` | If True, pivots the data to presentation view with 'indicator' and 'country' as the index, date as values.
|
|
659
|
-
| `provider` | `yes` | `string` | `-` | enum: econdb, imf |
|
|
615
|
+
| `country` | `no` | `string | null` | `-` | The country to get data. Multiple comma separated items allowed; The country to get data. ISO country codes or country names.; ISO3 country code(s). Use comma-separated values for multiple countries. Validated against the dataflow's available countries via constraint API. |
|
|
616
|
+
| `frequency` | `no` | `string | null` | `-` | The frequency of the data.; The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.; The frequency of the data. Choices vary by indicator and country. Common options: 'annual', 'quarter', 'month'. Use 'all' or '*' to return all available frequencies. Direct IMF codes (e.g., 'A', 'Q', 'M') are also accepted. |
|
|
617
|
+
| `transform` | `no` | `string | null` | `-` | The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.; Transformation to apply to the data. User-friendly options: 'index' (raw values), 'yoy' (year-over-year %), 'period' (period-over-period %). Use 'all' or '*' to return all available transformations. Direct IMF codes (e.g., 'USD', 'IX') are also accepted. |
|
|
618
|
+
| `use_cache` | `no` | `boolean` | `true` | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. |
|
|
619
|
+
| `dimension_values` | `no` | `array | null` | `-` | accepts array values List of additional dimension filters in 'DIM_ID:DIM_VALUE' format. Parameter can be entered multiple times. |
|
|
620
|
+
| `limit` | `no` | `integer | null` | `-` | Maximum number of records to retrieve per series. |
|
|
621
|
+
| `pivot` | `no` | `boolean` | `false` | If True, pivots the data to presentation view with 'indicator' and 'country' as the index, date as values. |
|
|
660
622
|
|
|
661
623
|
---
|
|
662
624
|
|
|
663
625
|
### `economy.interest_rates`
|
|
664
626
|
|
|
665
627
|
```python
|
|
666
|
-
data.economy.interest_rates(start_time=None, end_time=None, country='united_states', duration='short', frequency='monthly'
|
|
628
|
+
data.economy.interest_rates(start_time=None, end_time=None, country='united_states', duration='short', frequency='monthly')
|
|
667
629
|
```
|
|
668
630
|
|
|
669
631
|
Summary: Interest Rates
|
|
@@ -673,7 +635,6 @@ Summary: Interest Rates
|
|
|
673
635
|
| Endpoint ID | `economy.interest_rates` |
|
|
674
636
|
| HTTP | `GET` |
|
|
675
637
|
| Path | `/inner/v1/agent-data/economy/interest_rates` |
|
|
676
|
-
| Default provider | `oecd` |
|
|
677
638
|
| SDK | `supported` |
|
|
678
639
|
| Host | `supported` |
|
|
679
640
|
| Notes | - |
|
|
@@ -684,17 +645,16 @@ Summary: Interest Rates
|
|
|
684
645
|
|---|---|---|---|---|
|
|
685
646
|
| `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. |
|
|
686
647
|
| `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. |
|
|
687
|
-
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed
|
|
688
|
-
| `duration` | `no` | `string` | `short` | enum: immediate, short, long Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate.
|
|
689
|
-
| `frequency` | `no` | `string` | `monthly` | enum: monthly, quarter, annual Frequency to get interest rate for for.
|
|
690
|
-
| `provider` | `no` | `string` | `oecd` | - |
|
|
648
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
649
|
+
| `duration` | `no` | `string` | `short` | enum: immediate, short, long Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate. |
|
|
650
|
+
| `frequency` | `no` | `string` | `monthly` | enum: monthly, quarter, annual Frequency to get interest rate for for. |
|
|
691
651
|
|
|
692
652
|
---
|
|
693
653
|
|
|
694
654
|
### `economy.money_measures`
|
|
695
655
|
|
|
696
656
|
```python
|
|
697
|
-
data.economy.money_measures(start_time=None, end_time=None, adjusted=True
|
|
657
|
+
data.economy.money_measures(start_time=None, end_time=None, adjusted=True)
|
|
698
658
|
```
|
|
699
659
|
|
|
700
660
|
Summary: Money Measures
|
|
@@ -704,7 +664,6 @@ Summary: Money Measures
|
|
|
704
664
|
| Endpoint ID | `economy.money_measures` |
|
|
705
665
|
| HTTP | `GET` |
|
|
706
666
|
| Path | `/inner/v1/agent-data/economy/money_measures` |
|
|
707
|
-
| Default provider | `federal_reserve` |
|
|
708
667
|
| SDK | `supported` |
|
|
709
668
|
| Host | `supported` |
|
|
710
669
|
| Notes | - |
|
|
@@ -716,14 +675,13 @@ Summary: Money Measures
|
|
|
716
675
|
| `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. |
|
|
717
676
|
| `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. |
|
|
718
677
|
| `adjusted` | `no` | `boolean | null` | `true` | Whether to return seasonally adjusted data. |
|
|
719
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
720
678
|
|
|
721
679
|
---
|
|
722
680
|
|
|
723
681
|
### `economy.pce`
|
|
724
682
|
|
|
725
683
|
```python
|
|
726
|
-
data.economy.pce(date=None, category='personal_income'
|
|
684
|
+
data.economy.pce(date=None, category='personal_income')
|
|
727
685
|
```
|
|
728
686
|
|
|
729
687
|
Summary: Pce
|
|
@@ -733,7 +691,6 @@ Summary: Pce
|
|
|
733
691
|
| Endpoint ID | `economy.pce` |
|
|
734
692
|
| HTTP | `GET` |
|
|
735
693
|
| Path | `/inner/v1/agent-data/economy/pce` |
|
|
736
|
-
| Default provider | `fred` |
|
|
737
694
|
| SDK | `supported` |
|
|
738
695
|
| Host | `supported` |
|
|
739
696
|
| Notes | - |
|
|
@@ -742,16 +699,15 @@ Summary: Pce
|
|
|
742
699
|
|
|
743
700
|
| Param | Required | Type | Default | Notes |
|
|
744
701
|
|---|---|---|---|---|
|
|
745
|
-
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Default is the latest report. Multiple comma separated items allowed
|
|
746
|
-
| `category` | `no` | `string` | `personal_income` | The category to query.
|
|
747
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
702
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Default is the latest report. Multiple comma separated items allowed |
|
|
703
|
+
| `category` | `no` | `string` | `personal_income` | The category to query. |
|
|
748
704
|
|
|
749
705
|
---
|
|
750
706
|
|
|
751
707
|
### `economy.primary_dealer_fails`
|
|
752
708
|
|
|
753
709
|
```python
|
|
754
|
-
data.economy.primary_dealer_fails(start_time=None, end_time=None, asset_class='all', unit='value'
|
|
710
|
+
data.economy.primary_dealer_fails(start_time=None, end_time=None, asset_class='all', unit='value')
|
|
755
711
|
```
|
|
756
712
|
|
|
757
713
|
Summary: Primary Dealer Fails
|
|
@@ -761,7 +717,6 @@ Summary: Primary Dealer Fails
|
|
|
761
717
|
| Endpoint ID | `economy.primary_dealer_fails` |
|
|
762
718
|
| HTTP | `GET` |
|
|
763
719
|
| Path | `/inner/v1/agent-data/economy/primary_dealer_fails` |
|
|
764
|
-
| Default provider | `federal_reserve` |
|
|
765
720
|
| SDK | `supported` |
|
|
766
721
|
| Host | `supported` |
|
|
767
722
|
| Notes | - |
|
|
@@ -772,16 +727,15 @@ Summary: Primary Dealer Fails
|
|
|
772
727
|
|---|---|---|---|---|
|
|
773
728
|
| `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. |
|
|
774
729
|
| `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. |
|
|
775
|
-
| `asset_class` | `no` | `string` | `all` | enum: all, treasuries, tips, agency, mbs, corporate Asset class to return, default is 'all'.
|
|
776
|
-
| `unit` | `no` | `string` | `value` | enum: value, percent Unit of the data returned to the 'value' field. Default is 'value', which represents millions of USD. 'percent' returns data as the percentage of the total fails-to-receive and fails-to-deliver, by asset class.
|
|
777
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
730
|
+
| `asset_class` | `no` | `string` | `all` | enum: all, treasuries, tips, agency, mbs, corporate Asset class to return, default is 'all'. |
|
|
731
|
+
| `unit` | `no` | `string` | `value` | enum: value, percent Unit of the data returned to the 'value' field. Default is 'value', which represents millions of USD. 'percent' returns data as the percentage of the total fails-to-receive and fails-to-deliver, by asset class. |
|
|
778
732
|
|
|
779
733
|
---
|
|
780
734
|
|
|
781
735
|
### `economy.primary_dealer_positioning`
|
|
782
736
|
|
|
783
737
|
```python
|
|
784
|
-
data.economy.primary_dealer_positioning(start_time=None, end_time=None, category='treasuries'
|
|
738
|
+
data.economy.primary_dealer_positioning(start_time=None, end_time=None, category='treasuries')
|
|
785
739
|
```
|
|
786
740
|
|
|
787
741
|
Summary: Primary Dealer Positioning
|
|
@@ -791,7 +745,6 @@ Summary: Primary Dealer Positioning
|
|
|
791
745
|
| Endpoint ID | `economy.primary_dealer_positioning` |
|
|
792
746
|
| HTTP | `GET` |
|
|
793
747
|
| Path | `/inner/v1/agent-data/economy/primary_dealer_positioning` |
|
|
794
|
-
| Default provider | `federal_reserve` |
|
|
795
748
|
| SDK | `supported` |
|
|
796
749
|
| Host | `supported` |
|
|
797
750
|
| Notes | - |
|
|
@@ -802,15 +755,14 @@ Summary: Primary Dealer Positioning
|
|
|
802
755
|
|---|---|---|---|---|
|
|
803
756
|
| `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. |
|
|
804
757
|
| `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. |
|
|
805
|
-
| `category` | `no` | `string` | `treasuries` | The category of asset to return, defaults to 'treasuries'.
|
|
806
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
758
|
+
| `category` | `no` | `string` | `treasuries` | The category of asset to return, defaults to 'treasuries'. |
|
|
807
759
|
|
|
808
760
|
---
|
|
809
761
|
|
|
810
762
|
### `economy.retail_prices`
|
|
811
763
|
|
|
812
764
|
```python
|
|
813
|
-
data.economy.retail_prices(start_time=None, end_time=None, item=None, country='united_states', region='all_city', frequency='monthly', transform=None
|
|
765
|
+
data.economy.retail_prices(start_time=None, end_time=None, item=None, country='united_states', region='all_city', frequency='monthly', transform=None)
|
|
814
766
|
```
|
|
815
767
|
|
|
816
768
|
Summary: Retail Prices
|
|
@@ -820,7 +772,6 @@ Summary: Retail Prices
|
|
|
820
772
|
| Endpoint ID | `economy.retail_prices` |
|
|
821
773
|
| HTTP | `GET` |
|
|
822
774
|
| Path | `/inner/v1/agent-data/economy/retail_prices` |
|
|
823
|
-
| Default provider | `fred` |
|
|
824
775
|
| SDK | `supported` |
|
|
825
776
|
| Host | `supported` |
|
|
826
777
|
| Notes | - |
|
|
@@ -833,17 +784,16 @@ Summary: Retail Prices
|
|
|
833
784
|
| `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. |
|
|
834
785
|
| `item` | `no` | `string | null` | `-` | The item or basket of items to query. |
|
|
835
786
|
| `country` | `no` | `string` | `united_states` | The country to get data. |
|
|
836
|
-
| `region` | `no` | `string` | `all_city` | The region to get average price levels for.
|
|
837
|
-
| `frequency` | `no` | `string` | `monthly` | The frequency of the data.
|
|
838
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
839
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
787
|
+
| `region` | `no` | `string` | `all_city` | The region to get average price levels for. |
|
|
788
|
+
| `frequency` | `no` | `string` | `monthly` | The frequency of the data. |
|
|
789
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
840
790
|
|
|
841
791
|
---
|
|
842
792
|
|
|
843
793
|
### `economy.risk_premium`
|
|
844
794
|
|
|
845
795
|
```python
|
|
846
|
-
data.economy.risk_premium(
|
|
796
|
+
data.economy.risk_premium()
|
|
847
797
|
```
|
|
848
798
|
|
|
849
799
|
Summary: Risk Premium
|
|
@@ -853,7 +803,6 @@ Summary: Risk Premium
|
|
|
853
803
|
| Endpoint ID | `economy.risk_premium` |
|
|
854
804
|
| HTTP | `GET` |
|
|
855
805
|
| Path | `/inner/v1/agent-data/economy/risk_premium` |
|
|
856
|
-
| Default provider | `fmp` |
|
|
857
806
|
| SDK | `supported` |
|
|
858
807
|
| Host | `supported` |
|
|
859
808
|
| Notes | - |
|
|
@@ -862,14 +811,13 @@ Summary: Risk Premium
|
|
|
862
811
|
|
|
863
812
|
| Param | Required | Type | Default | Notes |
|
|
864
813
|
|---|---|---|---|---|
|
|
865
|
-
| `provider` | `no` | `string` | `fmp` | - |
|
|
866
814
|
|
|
867
815
|
---
|
|
868
816
|
|
|
869
817
|
### `economy.share_price_index`
|
|
870
818
|
|
|
871
819
|
```python
|
|
872
|
-
data.economy.share_price_index(start_time=None, end_time=None, country='united_states', frequency='monthly'
|
|
820
|
+
data.economy.share_price_index(start_time=None, end_time=None, country='united_states', frequency='monthly')
|
|
873
821
|
```
|
|
874
822
|
|
|
875
823
|
Summary: Share Price Index
|
|
@@ -879,7 +827,6 @@ Summary: Share Price Index
|
|
|
879
827
|
| Endpoint ID | `economy.share_price_index` |
|
|
880
828
|
| HTTP | `GET` |
|
|
881
829
|
| Path | `/inner/v1/agent-data/economy/share_price_index` |
|
|
882
|
-
| Default provider | `oecd` |
|
|
883
830
|
| SDK | `supported` |
|
|
884
831
|
| Host | `supported` |
|
|
885
832
|
| Notes | - |
|
|
@@ -890,16 +837,15 @@ Summary: Share Price Index
|
|
|
890
837
|
|---|---|---|---|---|
|
|
891
838
|
| `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. |
|
|
892
839
|
| `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. |
|
|
893
|
-
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed
|
|
840
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
894
841
|
| `frequency` | `no` | `string` | `monthly` | The frequency of the data. |
|
|
895
|
-
| `provider` | `no` | `string` | `oecd` | - |
|
|
896
842
|
|
|
897
843
|
---
|
|
898
844
|
|
|
899
845
|
### `economy.shipping.chokepoint_info`
|
|
900
846
|
|
|
901
847
|
```python
|
|
902
|
-
data.economy.shipping.chokepoint_info(theme=None
|
|
848
|
+
data.economy.shipping.chokepoint_info(theme=None)
|
|
903
849
|
```
|
|
904
850
|
|
|
905
851
|
Summary: Chokepoint Info
|
|
@@ -909,7 +855,6 @@ Summary: Chokepoint Info
|
|
|
909
855
|
| Endpoint ID | `economy.shipping.chokepoint_info` |
|
|
910
856
|
| HTTP | `GET` |
|
|
911
857
|
| Path | `/inner/v1/agent-data/economy/shipping/chokepoint_info` |
|
|
912
|
-
| Default provider | `imf` |
|
|
913
858
|
| SDK | `supported` |
|
|
914
859
|
| Host | `supported` |
|
|
915
860
|
| Notes | - |
|
|
@@ -918,15 +863,14 @@ Summary: Chokepoint Info
|
|
|
918
863
|
|
|
919
864
|
| Param | Required | Type | Default | Notes |
|
|
920
865
|
|---|---|---|---|---|
|
|
921
|
-
| `theme` | `no` | `string | null` | `-` | Theme for the map. Only valid if `openbb-charting` is installed and `chart` parameter is set to `true`. Default is the 'chart_style' setting in `user_settings.json`, if available, otherwise 'dark'.
|
|
922
|
-
| `provider` | `no` | `string` | `imf` | - |
|
|
866
|
+
| `theme` | `no` | `string | null` | `-` | Theme for the map. Only valid if `openbb-charting` is installed and `chart` parameter is set to `true`. Default is the 'chart_style' setting in `user_settings.json`, if available, otherwise 'dark'. |
|
|
923
867
|
|
|
924
868
|
---
|
|
925
869
|
|
|
926
870
|
### `economy.shipping.chokepoint_volume`
|
|
927
871
|
|
|
928
872
|
```python
|
|
929
|
-
data.economy.shipping.chokepoint_volume(start_time=None, end_time=None, chokepoint=None
|
|
873
|
+
data.economy.shipping.chokepoint_volume(start_time=None, end_time=None, chokepoint=None)
|
|
930
874
|
```
|
|
931
875
|
|
|
932
876
|
Summary: Chokepoint Volume
|
|
@@ -936,7 +880,6 @@ Summary: Chokepoint Volume
|
|
|
936
880
|
| Endpoint ID | `economy.shipping.chokepoint_volume` |
|
|
937
881
|
| HTTP | `GET` |
|
|
938
882
|
| Path | `/inner/v1/agent-data/economy/shipping/chokepoint_volume` |
|
|
939
|
-
| Default provider | `imf` |
|
|
940
883
|
| SDK | `supported` |
|
|
941
884
|
| Host | `supported` |
|
|
942
885
|
| Notes | - |
|
|
@@ -947,15 +890,14 @@ Summary: Chokepoint Volume
|
|
|
947
890
|
|---|---|---|---|---|
|
|
948
891
|
| `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. |
|
|
949
892
|
| `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. |
|
|
950
|
-
| `chokepoint` | `no` | `string | null` | `-` | Name of the chokepoint. Use `None` for all chokepoints. Choices are: - suez_canal - panama_canal - bosporus_strait - bab_el_mandeb_strait - malacca_strait - strait_of_hormuz - cape_of_good_hope - gibraltar_strait - dover_strait - oresund_strait - taiwan_strait - korea_strait - tsugaru_strait - luzon_strait - lombok_strait - ombai_strait - bohai_strait - torres_strait - sunda_strait - makassar_strait - magellan_strait - yucatan_channel - windward_passage - mona_passage Multiple comma separated items allowed.
|
|
951
|
-
| `provider` | `no` | `string` | `imf` | - |
|
|
893
|
+
| `chokepoint` | `no` | `string | null` | `-` | Name of the chokepoint. Use `None` for all chokepoints. Choices are: - suez_canal - panama_canal - bosporus_strait - bab_el_mandeb_strait - malacca_strait - strait_of_hormuz - cape_of_good_hope - gibraltar_strait - dover_strait - oresund_strait - taiwan_strait - korea_strait - tsugaru_strait - luzon_strait - lombok_strait - ombai_strait - bohai_strait - torres_strait - sunda_strait - makassar_strait - magellan_strait - yucatan_channel - windward_passage - mona_passage Multiple comma separated items allowed. |
|
|
952
894
|
|
|
953
895
|
---
|
|
954
896
|
|
|
955
897
|
### `economy.shipping.port_info`
|
|
956
898
|
|
|
957
899
|
```python
|
|
958
|
-
data.economy.shipping.port_info(continent=None, country=None, port_code=None, limit=None
|
|
900
|
+
data.economy.shipping.port_info(continent=None, country=None, port_code=None, limit=None)
|
|
959
901
|
```
|
|
960
902
|
|
|
961
903
|
Summary: Port Info
|
|
@@ -965,7 +907,6 @@ Summary: Port Info
|
|
|
965
907
|
| Endpoint ID | `economy.shipping.port_info` |
|
|
966
908
|
| HTTP | `GET` |
|
|
967
909
|
| Path | `/inner/v1/agent-data/economy/shipping/port_info` |
|
|
968
|
-
| Default provider | `imf` |
|
|
969
910
|
| SDK | `supported` |
|
|
970
911
|
| Host | `supported` |
|
|
971
912
|
| Notes | - |
|
|
@@ -974,18 +915,17 @@ Summary: Port Info
|
|
|
974
915
|
|
|
975
916
|
| Param | Required | Type | Default | Notes |
|
|
976
917
|
|---|---|---|---|---|
|
|
977
|
-
| `continent` | `no` | `string | null` | `-` | Filter by continent. This parameter is ignored when a `country` is provided.
|
|
978
|
-
| `country` | `no` | `string | null` | `-` | Country to focus on. Enter as a 3-letter ISO country code. This parameter supersedes `continent` if both are provided.
|
|
979
|
-
| `port_code` | `no` | `string | null` | `-` | This is a dummy parameter to allow grouping in OpenBB Workspace widgets.
|
|
980
|
-
| `limit` | `no` | `integer | null` | `-` | Limit the number of results returned. Limit is determined by the annual average number of vessels transiting through the port. If not provided, all ports are returned.
|
|
981
|
-
| `provider` | `no` | `string` | `imf` | - |
|
|
918
|
+
| `continent` | `no` | `string | null` | `-` | Filter by continent. This parameter is ignored when a `country` is provided. |
|
|
919
|
+
| `country` | `no` | `string | null` | `-` | Country to focus on. Enter as a 3-letter ISO country code. This parameter supersedes `continent` if both are provided. |
|
|
920
|
+
| `port_code` | `no` | `string | null` | `-` | This is a dummy parameter to allow grouping in OpenBB Workspace widgets. |
|
|
921
|
+
| `limit` | `no` | `integer | null` | `-` | Limit the number of results returned. Limit is determined by the annual average number of vessels transiting through the port. If not provided, all ports are returned. |
|
|
982
922
|
|
|
983
923
|
---
|
|
984
924
|
|
|
985
925
|
### `economy.shipping.port_volume`
|
|
986
926
|
|
|
987
927
|
```python
|
|
988
|
-
data.economy.shipping.port_volume(start_time=None, end_time=None, port_code=None, country=None
|
|
928
|
+
data.economy.shipping.port_volume(start_time=None, end_time=None, port_code=None, country=None)
|
|
989
929
|
```
|
|
990
930
|
|
|
991
931
|
Summary: Port Volume
|
|
@@ -995,7 +935,6 @@ Summary: Port Volume
|
|
|
995
935
|
| Endpoint ID | `economy.shipping.port_volume` |
|
|
996
936
|
| HTTP | `GET` |
|
|
997
937
|
| Path | `/inner/v1/agent-data/economy/shipping/port_volume` |
|
|
998
|
-
| Default provider | - |
|
|
999
938
|
| SDK | `supported` |
|
|
1000
939
|
| Host | `supported` |
|
|
1001
940
|
| Notes | - |
|
|
@@ -1006,16 +945,15 @@ Summary: Port Volume
|
|
|
1006
945
|
|---|---|---|---|---|
|
|
1007
946
|
| `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. |
|
|
1008
947
|
| `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. |
|
|
1009
|
-
| `port_code` | `no` | `string | null` | `-` | Port code to filter results by a specific port. This parameter is ignored if `country` parameter is provided. To get a list of available ports, use `obb.economy.shipping.port_info()`. Multiple comma separated items allowed.
|
|
1010
|
-
| `country` | `no` | `string | null` | `-` | Country to focus on. Enter as a 3-letter ISO country code. This parameter is overridden by `port_code` if both are provided.
|
|
1011
|
-
| `provider` | `yes` | `string` | `-` | enum: econdb, imf |
|
|
948
|
+
| `port_code` | `no` | `string | null` | `-` | Port code to filter results by a specific port. This parameter is ignored if `country` parameter is provided. To get a list of available ports, use `obb.economy.shipping.port_info()`. Multiple comma separated items allowed. |
|
|
949
|
+
| `country` | `no` | `string | null` | `-` | Country to focus on. Enter as a 3-letter ISO country code. This parameter is overridden by `port_code` if both are provided. |
|
|
1012
950
|
|
|
1013
951
|
---
|
|
1014
952
|
|
|
1015
953
|
### `economy.survey.bls_search`
|
|
1016
954
|
|
|
1017
955
|
```python
|
|
1018
|
-
data.economy.survey.bls_search(query='', category=None, include_extras=False, include_code_map=False
|
|
956
|
+
data.economy.survey.bls_search(query='', category=None, include_extras=False, include_code_map=False)
|
|
1019
957
|
```
|
|
1020
958
|
|
|
1021
959
|
Summary: Bls Search
|
|
@@ -1025,7 +963,6 @@ Summary: Bls Search
|
|
|
1025
963
|
| Endpoint ID | `economy.survey.bls_search` |
|
|
1026
964
|
| HTTP | `GET` |
|
|
1027
965
|
| Path | `/inner/v1/agent-data/economy/survey/bls_search` |
|
|
1028
|
-
| Default provider | `bls` |
|
|
1029
966
|
| SDK | `supported` |
|
|
1030
967
|
| Host | `supported` |
|
|
1031
968
|
| Notes | - |
|
|
@@ -1035,17 +972,16 @@ Summary: Bls Search
|
|
|
1035
972
|
| Param | Required | Type | Default | Notes |
|
|
1036
973
|
|---|---|---|---|---|
|
|
1037
974
|
| `query` | `no` | `string` | `` | The search word(s). Use semi-colon to separate multiple queries as an & operator. |
|
|
1038
|
-
| `category` | `no` | `string | null` | `-` | The category of BLS survey to search within. An empty search query will return all series within the category. Options are: cpi - Consumer Price Index pce - Personal Consumption Expenditure ppi - Producer Price Index ip - Industry Productivity jolts - Job Openings and Labor Turnover Survey nfp - Nonfarm Payrolls cps - Current Population Survey lfs - Labor Force Statistics wages - Wages ec - Employer Costs sla - State and Local Area Employment bed - Business Employment Dynamics tu - Time Use
|
|
1039
|
-
| `include_extras` | `no` | `boolean` | `false` | Include additional information in the search results. Extra fields returned are metadata and vary by survey. Fields are undefined strings that typically have names ending with '_code'.
|
|
1040
|
-
| `include_code_map` | `no` | `boolean` | `false` | When True, includes the complete code map for eaçh survey in the category, returned separately as a nested JSON to the `extras['results_metadata']` property of the response. Example content is the NAICS industry map for PPI surveys. Each code is a value within the 'symbol' of the time series.
|
|
1041
|
-
| `provider` | `no` | `string` | `bls` | - |
|
|
975
|
+
| `category` | `no` | `string | null` | `-` | The category of BLS survey to search within. An empty search query will return all series within the category. Options are: cpi - Consumer Price Index pce - Personal Consumption Expenditure ppi - Producer Price Index ip - Industry Productivity jolts - Job Openings and Labor Turnover Survey nfp - Nonfarm Payrolls cps - Current Population Survey lfs - Labor Force Statistics wages - Wages ec - Employer Costs sla - State and Local Area Employment bed - Business Employment Dynamics tu - Time Use |
|
|
976
|
+
| `include_extras` | `no` | `boolean` | `false` | Include additional information in the search results. Extra fields returned are metadata and vary by survey. Fields are undefined strings that typically have names ending with '_code'. |
|
|
977
|
+
| `include_code_map` | `no` | `boolean` | `false` | When True, includes the complete code map for eaçh survey in the category, returned separately as a nested JSON to the `extras['results_metadata']` property of the response. Example content is the NAICS industry map for PPI surveys. Each code is a value within the 'symbol' of the time series. |
|
|
1042
978
|
|
|
1043
979
|
---
|
|
1044
980
|
|
|
1045
981
|
### `economy.survey.bls_series`
|
|
1046
982
|
|
|
1047
983
|
```python
|
|
1048
|
-
data.economy.survey.bls_series(symbol=..., start_time=None, end_time=None, calculations=True, annual_average=False, aspects=False
|
|
984
|
+
data.economy.survey.bls_series(symbol=..., start_time=None, end_time=None, calculations=True, annual_average=False, aspects=False)
|
|
1049
985
|
```
|
|
1050
986
|
|
|
1051
987
|
Summary: Bls Series
|
|
@@ -1055,7 +991,6 @@ Summary: Bls Series
|
|
|
1055
991
|
| Endpoint ID | `economy.survey.bls_series` |
|
|
1056
992
|
| HTTP | `GET` |
|
|
1057
993
|
| Path | `/inner/v1/agent-data/economy/survey/bls_series` |
|
|
1058
|
-
| Default provider | `bls` |
|
|
1059
994
|
| SDK | `supported` |
|
|
1060
995
|
| Host | `supported` |
|
|
1061
996
|
| Notes | - |
|
|
@@ -1064,20 +999,19 @@ Summary: Bls Series
|
|
|
1064
999
|
|
|
1065
1000
|
| Param | Required | Type | Default | Notes |
|
|
1066
1001
|
|---|---|---|---|---|
|
|
1067
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
1002
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
1068
1003
|
| `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. |
|
|
1069
1004
|
| `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. |
|
|
1070
|
-
| `calculations` | `no` | `boolean` | `true` | Include calculations in the response, if available. Default is True.
|
|
1071
|
-
| `annual_average` | `no` | `boolean` | `false` | Include annual averages in the response, if available. Default is False.
|
|
1072
|
-
| `aspects` | `no` | `boolean` | `false` | Include all aspects associated with a data point for a given BLS series ID, if available. Returned with the series metadata, under `extras` of the response object. Default is False.
|
|
1073
|
-
| `provider` | `no` | `string` | `bls` | - |
|
|
1005
|
+
| `calculations` | `no` | `boolean` | `true` | Include calculations in the response, if available. Default is True. |
|
|
1006
|
+
| `annual_average` | `no` | `boolean` | `false` | Include annual averages in the response, if available. Default is False. |
|
|
1007
|
+
| `aspects` | `no` | `boolean` | `false` | Include all aspects associated with a data point for a given BLS series ID, if available. Returned with the series metadata, under `extras` of the response object. Default is False. |
|
|
1074
1008
|
|
|
1075
1009
|
---
|
|
1076
1010
|
|
|
1077
1011
|
### `economy.survey.economic_conditions_chicago`
|
|
1078
1012
|
|
|
1079
1013
|
```python
|
|
1080
|
-
data.economy.survey.economic_conditions_chicago(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None
|
|
1014
|
+
data.economy.survey.economic_conditions_chicago(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
|
|
1081
1015
|
```
|
|
1082
1016
|
|
|
1083
1017
|
Summary: Economic Conditions Chicago
|
|
@@ -1087,7 +1021,6 @@ Summary: Economic Conditions Chicago
|
|
|
1087
1021
|
| Endpoint ID | `economy.survey.economic_conditions_chicago` |
|
|
1088
1022
|
| HTTP | `GET` |
|
|
1089
1023
|
| Path | `/inner/v1/agent-data/economy/survey/economic_conditions_chicago` |
|
|
1090
|
-
| Default provider | `fred` |
|
|
1091
1024
|
| SDK | `supported` |
|
|
1092
1025
|
| Host | `supported` |
|
|
1093
1026
|
| Notes | - |
|
|
@@ -1098,17 +1031,16 @@ Summary: Economic Conditions Chicago
|
|
|
1098
1031
|
|---|---|---|---|---|
|
|
1099
1032
|
| `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. |
|
|
1100
1033
|
| `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. |
|
|
1101
|
-
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly.
|
|
1102
|
-
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period
|
|
1103
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
1104
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
1034
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1035
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1036
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
1105
1037
|
|
|
1106
1038
|
---
|
|
1107
1039
|
|
|
1108
1040
|
### `economy.survey.inflation_expectations`
|
|
1109
1041
|
|
|
1110
1042
|
```python
|
|
1111
|
-
data.economy.survey.inflation_expectations(start_date=None, end_date=None
|
|
1043
|
+
data.economy.survey.inflation_expectations(start_date=None, end_date=None)
|
|
1112
1044
|
```
|
|
1113
1045
|
|
|
1114
1046
|
Summary: Inflation Expectations
|
|
@@ -1118,7 +1050,6 @@ Summary: Inflation Expectations
|
|
|
1118
1050
|
| Endpoint ID | `economy.survey.inflation_expectations` |
|
|
1119
1051
|
| HTTP | `GET` |
|
|
1120
1052
|
| Path | `/inner/v1/agent-data/economy/survey/inflation_expectations` |
|
|
1121
|
-
| Default provider | `federal_reserve` |
|
|
1122
1053
|
| SDK | `supported` |
|
|
1123
1054
|
| Host | `supported` |
|
|
1124
1055
|
| Notes | - |
|
|
@@ -1127,16 +1058,15 @@ Summary: Inflation Expectations
|
|
|
1127
1058
|
|
|
1128
1059
|
| Param | Required | Type | Default | Notes |
|
|
1129
1060
|
|---|---|---|---|---|
|
|
1130
|
-
| `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Data begins from 1970-04-01 and is quarterly.
|
|
1131
|
-
| `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format.
|
|
1132
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
1061
|
+
| `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Data begins from 1970-04-01 and is quarterly. |
|
|
1062
|
+
| `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. |
|
|
1133
1063
|
|
|
1134
1064
|
---
|
|
1135
1065
|
|
|
1136
1066
|
### `economy.survey.manufacturing_outlook_ny`
|
|
1137
1067
|
|
|
1138
1068
|
```python
|
|
1139
|
-
data.economy.survey.manufacturing_outlook_ny(start_time=None, end_time=None, topic='new_orders', seasonally_adjusted=False, frequency=None, aggregation_method=None, transform=None
|
|
1069
|
+
data.economy.survey.manufacturing_outlook_ny(start_time=None, end_time=None, topic='new_orders', seasonally_adjusted=False, frequency=None, aggregation_method=None, transform=None)
|
|
1140
1070
|
```
|
|
1141
1071
|
|
|
1142
1072
|
Summary: Manufacturing Outlook Ny
|
|
@@ -1146,7 +1076,6 @@ Summary: Manufacturing Outlook Ny
|
|
|
1146
1076
|
| Endpoint ID | `economy.survey.manufacturing_outlook_ny` |
|
|
1147
1077
|
| HTTP | `GET` |
|
|
1148
1078
|
| Path | `/inner/v1/agent-data/economy/survey/manufacturing_outlook_ny` |
|
|
1149
|
-
| Default provider | `fred` |
|
|
1150
1079
|
| SDK | `supported` |
|
|
1151
1080
|
| Host | `supported` |
|
|
1152
1081
|
| Notes | - |
|
|
@@ -1157,19 +1086,18 @@ Summary: Manufacturing Outlook Ny
|
|
|
1157
1086
|
|---|---|---|---|---|
|
|
1158
1087
|
| `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. |
|
|
1159
1088
|
| `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. |
|
|
1160
|
-
| `topic` | `no` | `string` | `new_orders` | The topic for the survey response. Multiple comma separated items allowed.
|
|
1161
|
-
| `seasonally_adjusted` | `no` | `boolean` | `false` | Whether the data is seasonally adjusted, default is False
|
|
1162
|
-
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly.
|
|
1163
|
-
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period
|
|
1164
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
1165
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
1089
|
+
| `topic` | `no` | `string` | `new_orders` | The topic for the survey response. Multiple comma separated items allowed. |
|
|
1090
|
+
| `seasonally_adjusted` | `no` | `boolean` | `false` | Whether the data is seasonally adjusted, default is False |
|
|
1091
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1092
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1093
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
1166
1094
|
|
|
1167
1095
|
---
|
|
1168
1096
|
|
|
1169
1097
|
### `economy.survey.manufacturing_outlook_texas`
|
|
1170
1098
|
|
|
1171
1099
|
```python
|
|
1172
|
-
data.economy.survey.manufacturing_outlook_texas(start_time=None, end_time=None, topic='new_orders_growth', frequency=None, aggregation_method=None, transform=None
|
|
1100
|
+
data.economy.survey.manufacturing_outlook_texas(start_time=None, end_time=None, topic='new_orders_growth', frequency=None, aggregation_method=None, transform=None)
|
|
1173
1101
|
```
|
|
1174
1102
|
|
|
1175
1103
|
Summary: Manufacturing Outlook Texas
|
|
@@ -1179,7 +1107,6 @@ Summary: Manufacturing Outlook Texas
|
|
|
1179
1107
|
| Endpoint ID | `economy.survey.manufacturing_outlook_texas` |
|
|
1180
1108
|
| HTTP | `GET` |
|
|
1181
1109
|
| Path | `/inner/v1/agent-data/economy/survey/manufacturing_outlook_texas` |
|
|
1182
|
-
| Default provider | `fred` |
|
|
1183
1110
|
| SDK | `supported` |
|
|
1184
1111
|
| Host | `supported` |
|
|
1185
1112
|
| Notes | - |
|
|
@@ -1190,18 +1117,17 @@ Summary: Manufacturing Outlook Texas
|
|
|
1190
1117
|
|---|---|---|---|---|
|
|
1191
1118
|
| `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. |
|
|
1192
1119
|
| `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. |
|
|
1193
|
-
| `topic` | `no` | `string` | `new_orders_growth` | The topic for the survey response. Multiple comma separated items allowed.
|
|
1194
|
-
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly.
|
|
1195
|
-
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period
|
|
1196
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
1197
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
1120
|
+
| `topic` | `no` | `string` | `new_orders_growth` | The topic for the survey response. Multiple comma separated items allowed. |
|
|
1121
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1122
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1123
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
1198
1124
|
|
|
1199
1125
|
---
|
|
1200
1126
|
|
|
1201
1127
|
### `economy.survey.nonfarm_payrolls`
|
|
1202
1128
|
|
|
1203
1129
|
```python
|
|
1204
|
-
data.economy.survey.nonfarm_payrolls(date=None, category='employees_nsa'
|
|
1130
|
+
data.economy.survey.nonfarm_payrolls(date=None, category='employees_nsa')
|
|
1205
1131
|
```
|
|
1206
1132
|
|
|
1207
1133
|
Summary: Nonfarm Payrolls
|
|
@@ -1211,7 +1137,6 @@ Summary: Nonfarm Payrolls
|
|
|
1211
1137
|
| Endpoint ID | `economy.survey.nonfarm_payrolls` |
|
|
1212
1138
|
| HTTP | `GET` |
|
|
1213
1139
|
| Path | `/inner/v1/agent-data/economy/survey/nonfarm_payrolls` |
|
|
1214
|
-
| Default provider | `fred` |
|
|
1215
1140
|
| SDK | `supported` |
|
|
1216
1141
|
| Host | `supported` |
|
|
1217
1142
|
| Notes | - |
|
|
@@ -1220,16 +1145,15 @@ Summary: Nonfarm Payrolls
|
|
|
1220
1145
|
|
|
1221
1146
|
| Param | Required | Type | Default | Notes |
|
|
1222
1147
|
|---|---|---|---|---|
|
|
1223
|
-
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Default is the latest report. Multiple comma separated items allowed
|
|
1224
|
-
| `category` | `no` | `string` | `employees_nsa` | The category to query.
|
|
1225
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
1148
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Default is the latest report. Multiple comma separated items allowed |
|
|
1149
|
+
| `category` | `no` | `string` | `employees_nsa` | The category to query. |
|
|
1226
1150
|
|
|
1227
1151
|
---
|
|
1228
1152
|
|
|
1229
1153
|
### `economy.survey.sloos`
|
|
1230
1154
|
|
|
1231
1155
|
```python
|
|
1232
|
-
data.economy.survey.sloos(start_time=None, end_time=None, category='spreads', transform=None
|
|
1156
|
+
data.economy.survey.sloos(start_time=None, end_time=None, category='spreads', transform=None)
|
|
1233
1157
|
```
|
|
1234
1158
|
|
|
1235
1159
|
Summary: Sloos
|
|
@@ -1239,7 +1163,6 @@ Summary: Sloos
|
|
|
1239
1163
|
| Endpoint ID | `economy.survey.sloos` |
|
|
1240
1164
|
| HTTP | `GET` |
|
|
1241
1165
|
| Path | `/inner/v1/agent-data/economy/survey/sloos` |
|
|
1242
|
-
| Default provider | `fred` |
|
|
1243
1166
|
| SDK | `supported` |
|
|
1244
1167
|
| Host | `supported` |
|
|
1245
1168
|
| Notes | - |
|
|
@@ -1250,16 +1173,15 @@ Summary: Sloos
|
|
|
1250
1173
|
|---|---|---|---|---|
|
|
1251
1174
|
| `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. |
|
|
1252
1175
|
| `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. |
|
|
1253
|
-
| `category` | `no` | `string` | `spreads` | Category of survey response.
|
|
1254
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
1255
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
1176
|
+
| `category` | `no` | `string` | `spreads` | Category of survey response. |
|
|
1177
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
1256
1178
|
|
|
1257
1179
|
---
|
|
1258
1180
|
|
|
1259
1181
|
### `economy.survey.university_of_michigan`
|
|
1260
1182
|
|
|
1261
1183
|
```python
|
|
1262
|
-
data.economy.survey.university_of_michigan(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None
|
|
1184
|
+
data.economy.survey.university_of_michigan(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
|
|
1263
1185
|
```
|
|
1264
1186
|
|
|
1265
1187
|
Summary: University Of Michigan
|
|
@@ -1269,7 +1191,6 @@ Summary: University Of Michigan
|
|
|
1269
1191
|
| Endpoint ID | `economy.survey.university_of_michigan` |
|
|
1270
1192
|
| HTTP | `GET` |
|
|
1271
1193
|
| Path | `/inner/v1/agent-data/economy/survey/university_of_michigan` |
|
|
1272
|
-
| Default provider | `fred` |
|
|
1273
1194
|
| SDK | `supported` |
|
|
1274
1195
|
| Host | `supported` |
|
|
1275
1196
|
| Notes | - |
|
|
@@ -1280,17 +1201,16 @@ Summary: University Of Michigan
|
|
|
1280
1201
|
|---|---|---|---|---|
|
|
1281
1202
|
| `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. |
|
|
1282
1203
|
| `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. |
|
|
1283
|
-
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly.
|
|
1284
|
-
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period
|
|
1285
|
-
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log
|
|
1286
|
-
| `provider` | `no` | `string` | `fred` | - |
|
|
1204
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1205
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1206
|
+
| `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
|
|
1287
1207
|
|
|
1288
1208
|
---
|
|
1289
1209
|
|
|
1290
1210
|
### `economy.total_factor_productivity`
|
|
1291
1211
|
|
|
1292
1212
|
```python
|
|
1293
|
-
data.economy.total_factor_productivity(frequency='quarter', start_date=None, end_date=None
|
|
1213
|
+
data.economy.total_factor_productivity(frequency='quarter', start_date=None, end_date=None)
|
|
1294
1214
|
```
|
|
1295
1215
|
|
|
1296
1216
|
Summary: Total Factor Productivity
|
|
@@ -1300,7 +1220,6 @@ Summary: Total Factor Productivity
|
|
|
1300
1220
|
| Endpoint ID | `economy.total_factor_productivity` |
|
|
1301
1221
|
| HTTP | `GET` |
|
|
1302
1222
|
| Path | `/inner/v1/agent-data/economy/total_factor_productivity` |
|
|
1303
|
-
| Default provider | `federal_reserve` |
|
|
1304
1223
|
| SDK | `supported` |
|
|
1305
1224
|
| Host | `supported` |
|
|
1306
1225
|
| Notes | - |
|
|
@@ -1309,17 +1228,16 @@ Summary: Total Factor Productivity
|
|
|
1309
1228
|
|
|
1310
1229
|
| Param | Required | Type | Default | Notes |
|
|
1311
1230
|
|---|---|---|---|---|
|
|
1312
|
-
| `frequency` | `no` | `string` | `quarter` | Type of data to return. 'quarter' for quarterly time series, 'annual' for annual time series, 'summary' for summary statistics (period means).
|
|
1313
|
-
| `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Only applicable for time series data (quarter/annual).
|
|
1314
|
-
| `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Only applicable for time series data (quarter/annual).
|
|
1315
|
-
| `provider` | `no` | `string` | `federal_reserve` | - |
|
|
1231
|
+
| `frequency` | `no` | `string` | `quarter` | Type of data to return. 'quarter' for quarterly time series, 'annual' for annual time series, 'summary' for summary statistics (period means). |
|
|
1232
|
+
| `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Only applicable for time series data (quarter/annual). |
|
|
1233
|
+
| `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Only applicable for time series data (quarter/annual). |
|
|
1316
1234
|
|
|
1317
1235
|
---
|
|
1318
1236
|
|
|
1319
1237
|
### `economy.unemployment`
|
|
1320
1238
|
|
|
1321
1239
|
```python
|
|
1322
|
-
data.economy.unemployment(start_time=None, end_time=None, country='united_states', frequency='monthly', sex='total', age='total', seasonal_adjustment=False
|
|
1240
|
+
data.economy.unemployment(start_time=None, end_time=None, country='united_states', frequency='monthly', sex='total', age='total', seasonal_adjustment=False)
|
|
1323
1241
|
```
|
|
1324
1242
|
|
|
1325
1243
|
Summary: Unemployment
|
|
@@ -1329,7 +1247,6 @@ Summary: Unemployment
|
|
|
1329
1247
|
| Endpoint ID | `economy.unemployment` |
|
|
1330
1248
|
| HTTP | `GET` |
|
|
1331
1249
|
| Path | `/inner/v1/agent-data/economy/unemployment` |
|
|
1332
|
-
| Default provider | `oecd` |
|
|
1333
1250
|
| SDK | `supported` |
|
|
1334
1251
|
| Host | `supported` |
|
|
1335
1252
|
| Notes | - |
|
|
@@ -1340,9 +1257,8 @@ Summary: Unemployment
|
|
|
1340
1257
|
|---|---|---|---|---|
|
|
1341
1258
|
| `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. |
|
|
1342
1259
|
| `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. |
|
|
1343
|
-
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed
|
|
1260
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
1344
1261
|
| `frequency` | `no` | `string` | `monthly` | The frequency of the data. |
|
|
1345
|
-
| `sex` | `no` | `string` | `total` | Sex to get unemployment for.
|
|
1346
|
-
| `age` | `no` | `string` | `total` | Age group to get unemployment for. Total indicates 15 years or over
|
|
1347
|
-
| `seasonal_adjustment` | `no` | `boolean` | `false` | Whether to get seasonally adjusted unemployment. Defaults to False.
|
|
1348
|
-
| `provider` | `no` | `string` | `oecd` | - |
|
|
1262
|
+
| `sex` | `no` | `string` | `total` | Sex to get unemployment for. |
|
|
1263
|
+
| `age` | `no` | `string` | `total` | Age group to get unemployment for. Total indicates 15 years or over |
|
|
1264
|
+
| `seasonal_adjustment` | `no` | `boolean` | `false` | Whether to get seasonally adjusted unemployment. Defaults to False. |
|