@bitget-ai/getagent-skill 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +15 -4
- package/.claude-plugin/plugin.json +1 -1
- package/VERSION +1 -1
- package/package.json +1 -1
- package/skills/getagent/SKILL.md +169 -6
- package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
- package/skills/getagent/references/api/confirm.md +59 -0
- package/skills/getagent/references/api/index.md +9 -7
- package/skills/getagent/references/api/publish.md +13 -6
- package/skills/getagent/references/api/run.md +5 -5
- package/skills/getagent/references/api/upload.md +22 -4
- package/skills/getagent/references/backtest-engine.md +82 -152
- package/skills/getagent/references/package-schema.md +31 -8
- package/skills/getagent/references/sdk/backtest/catalog.md +17 -2
- package/skills/getagent/references/sdk/data/arxiv.md +8 -10
- package/skills/getagent/references/sdk/data/catalog.md +3 -8
- package/skills/getagent/references/sdk/data/commodity.md +71 -39
- package/skills/getagent/references/sdk/data/coverage.md +0 -3
- package/skills/getagent/references/sdk/data/crypto.md +1583 -402
- package/skills/getagent/references/sdk/data/currency.md +55 -15
- package/skills/getagent/references/sdk/data/derivatives.md +161 -50
- package/skills/getagent/references/sdk/data/economy.md +911 -259
- package/skills/getagent/references/sdk/data/equity.md +1719 -393
- package/skills/getagent/references/sdk/data/etf.md +550 -64
- package/skills/getagent/references/sdk/data/famafrench.md +38 -50
- package/skills/getagent/references/sdk/data/fixedincome.md +574 -139
- package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
- package/skills/getagent/references/sdk/data/index.md +18 -32
- package/skills/getagent/references/sdk/data/news.md +128 -58
- package/skills/getagent/references/sdk/data/regulators.md +108 -43
- package/skills/getagent/references/sdk/data/sentiment.md +188 -34
- package/skills/getagent/references/sdk/data/uscongress.md +13 -21
- package/skills/getagent/references/sdk/data/web_search.md +3 -7
- package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
- package/skills/getagent/references/sdk.md +14 -5
- package/skills/getagent/scripts/validate.py +109 -3
- package/skills/getagent/scripts/version_check.sh +13 -12
- package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9871
|
@@ -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,44 @@ 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
|
-
|
|
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. |
|
|
79
|
+
|
|
80
|
+
#### Response fields
|
|
81
|
+
|
|
82
|
+
| Field | Type | Notes |
|
|
83
|
+
|---|---|---|
|
|
84
|
+
| `symbol_root` | `string` | The root symbol representing the indicator. |
|
|
85
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. The root symbol with additional codes. |
|
|
86
|
+
| `country` | `string` | The name of the country, region, or entity represented by the symbol. |
|
|
87
|
+
| `iso` | `string` | The ISO code of the country, region, or entity represented by the symbol. |
|
|
88
|
+
| `description` | `string` | The description of the indicator. |
|
|
89
|
+
| `frequency` | `string` | The frequency of the indicator data. |
|
|
90
|
+
| `currency` | `string` | The currency, or unit, the data is based in. |
|
|
91
|
+
| `scale` | `string` | The scale of the data. |
|
|
92
|
+
| `multiplier` | `integer` | The multiplier of the data to arrive at whole units. |
|
|
93
|
+
| `transformation` | `string` | Transformation type. |
|
|
94
|
+
| `source` | `string` | The original source of the data. |
|
|
95
|
+
| `first_date` | `string` | The first date of the data. |
|
|
96
|
+
| `last_date` | `string` | The last date of the data. |
|
|
97
|
+
| `last_insert_timestamp` | `string` | The time of the last update. Data is typically reported with a lag. |
|
|
98
|
+
| `agency_id` | `string` | The agency ID responsible for the indicator. |
|
|
99
|
+
| `dataflow_id` | `string` | The IMF dataflow ID associated with the indicator. |
|
|
100
|
+
| `dataflow_name` | `string` | The name of the IMF dataflow (symbol root). |
|
|
101
|
+
| `structure_id` | `string` | The data structure ID associated with the indicator. |
|
|
102
|
+
| `dimension_id` | `string` | The dimension ID of the indicator in the data structure. |
|
|
103
|
+
| `long_description` | `string` | Detailed description of the indicator. |
|
|
104
|
+
| `member_of` | `array` | List of table symbols (dataflow_id::table_id) this indicator belongs to. |
|
|
81
105
|
|
|
82
106
|
---
|
|
83
107
|
|
|
84
108
|
### `economy.balance_of_payments`
|
|
85
109
|
|
|
86
110
|
```python
|
|
87
|
-
data.economy.balance_of_payments(start_time=None, end_time=None, report_type='main', frequency='monthly', country=None
|
|
111
|
+
data.economy.balance_of_payments(start_time=None, end_time=None, report_type='main', frequency='monthly', country=None)
|
|
88
112
|
```
|
|
89
113
|
|
|
90
114
|
Summary: Balance Of Payments
|
|
@@ -94,7 +118,6 @@ Summary: Balance Of Payments
|
|
|
94
118
|
| Endpoint ID | `economy.balance_of_payments` |
|
|
95
119
|
| HTTP | `GET` |
|
|
96
120
|
| Path | `/inner/v1/agent-data/economy/balance_of_payments` |
|
|
97
|
-
| Default provider | - |
|
|
98
121
|
| SDK | `supported` |
|
|
99
122
|
| Host | `supported` |
|
|
100
123
|
| Notes | - |
|
|
@@ -105,17 +128,149 @@ Summary: Balance Of Payments
|
|
|
105
128
|
|---|---|---|---|---|
|
|
106
129
|
| `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
130
|
| `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
|
-
|
|
131
|
+
| `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. |
|
|
132
|
+
| `frequency` | `no` | `string` | `monthly` | enum: monthly, quarterly The frequency of the data. Monthly is valid only for ['main', 'summary']. |
|
|
133
|
+
| `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. |
|
|
134
|
+
|
|
135
|
+
#### Response fields
|
|
136
|
+
|
|
137
|
+
| Field | Type | Notes |
|
|
138
|
+
|---|---|---|
|
|
139
|
+
| `period` | `string` | The date representing the beginning of the reporting period. |
|
|
140
|
+
| `balance_percent_of_gdp` | `number` | Current Account Balance as Percent of GDP |
|
|
141
|
+
| `balance_total` | `number` | Current Account Total Balance (USD) |
|
|
142
|
+
| `balance_total_services` | `number` | Current Account Total Services Balance (USD) |
|
|
143
|
+
| `balance_total_secondary_income` | `number` | Current Account Total Secondary Income Balance (USD) |
|
|
144
|
+
| `balance_total_goods` | `number` | Current Account Total Goods Balance (USD) |
|
|
145
|
+
| `balance_total_primary_income` | `number` | Current Account Total Primary Income Balance (USD) |
|
|
146
|
+
| `credits_services_percent_of_goods_and_services` | `number` | Current Account Credits Services as Percent of Goods and Services |
|
|
147
|
+
| `credits_services_percent_of_current_account` | `number` | Current Account Credits Services as Percent of Current Account |
|
|
148
|
+
| `credits_total_services` | `number` | Current Account Credits Total Services (USD) |
|
|
149
|
+
| `credits_total_goods` | `number` | Current Account Credits Total Goods (USD) |
|
|
150
|
+
| `credits_total_primary_income` | `number` | Current Account Credits Total Primary Income (USD) |
|
|
151
|
+
| `credits_total_secondary_income` | `number` | Current Account Credits Total Secondary Income (USD) |
|
|
152
|
+
| `credits_total` | `number` | Current Account Credits Total (USD) |
|
|
153
|
+
| `debits_services_percent_of_goods_and_services` | `number` | Current Account Debits Services as Percent of Goods and Services |
|
|
154
|
+
| `debits_services_percent_of_current_account` | `number` | Current Account Debits Services as Percent of Current Account |
|
|
155
|
+
| `debits_total_services` | `number` | Current Account Debits Total Services (USD) |
|
|
156
|
+
| `debits_total_goods` | `number` | Current Account Debits Total Goods (USD) |
|
|
157
|
+
| `debits_total_primary_income` | `number` | Current Account Debits Total Primary Income (USD) |
|
|
158
|
+
| `debits_total` | `number` | Current Account Debits Total (USD) |
|
|
159
|
+
| `debits_total_secondary_income` | `number` | Current Account Debits Total Secondary Income (USD) |
|
|
160
|
+
| `current_account_balance` | `number` | Current Account Balance (Billions of EUR) |
|
|
161
|
+
| `current_account_credit` | `number` | Current Account Credit (Billions of EUR) |
|
|
162
|
+
| `current_account_debit` | `number` | Current Account Debit (Billions of EUR) |
|
|
163
|
+
| `goods_balance` | `number` | Goods Balance (Billions of EUR) |
|
|
164
|
+
| `goods_credit` | `number` | Goods Credit (Billions of EUR) |
|
|
165
|
+
| `goods_debit` | `number` | Goods Debit (Billions of EUR) |
|
|
166
|
+
| `services_balance` | `number` | Services Balance (Billions of EUR) |
|
|
167
|
+
| `services_credit` | `number` | Services Credit (Billions of EUR) |
|
|
168
|
+
| `services_debit` | `number` | Services Debit (Billions of EUR) |
|
|
169
|
+
| `primary_income_balance` | `number` | Primary Income Balance (Billions of EUR) |
|
|
170
|
+
| `primary_income_credit` | `number` | Primary Income Credit (Billions of EUR) |
|
|
171
|
+
| `primary_income_debit` | `number` | Primary Income Debit (Billions of EUR) |
|
|
172
|
+
| `investment_income_balance` | `number` | Investment Income Balance (Billions of EUR) |
|
|
173
|
+
| `investment_income_credit` | `number` | Investment Income Credits (Billions of EUR) |
|
|
174
|
+
| `investment_income_debit` | `number` | Investment Income Debits (Billions of EUR) |
|
|
175
|
+
| `secondary_income_balance` | `number` | Secondary Income Balance (Billions of EUR) |
|
|
176
|
+
| `secondary_income_credit` | `number` | Secondary Income Credit (Billions of EUR) |
|
|
177
|
+
| `secondary_income_debit` | `number` | Secondary Income Debit (Billions of EUR) |
|
|
178
|
+
| `capital_account_balance` | `number` | Capital Account Balance (Billions of EUR) |
|
|
179
|
+
| `capital_account_credit` | `number` | Capital Account Credit (Billions of EUR) |
|
|
180
|
+
| `capital_account_debit` | `number` | Capital Account Debit (Billions of EUR) |
|
|
181
|
+
| `assets_total` | `number` | Assets Total (Billions of EUR) |
|
|
182
|
+
| `assets_currency_and_deposits` | `number` | Assets Currency and Deposits (Billions of EUR) |
|
|
183
|
+
| `assets_loans` | `number` | Assets Loans (Billions of EUR) |
|
|
184
|
+
| `assets_trade_credit_and_advances` | `number` | Assets Trade Credits and Advances (Billions of EUR) |
|
|
185
|
+
| `assets_eurosystem` | `number` | Assets Eurosystem (Billions of EUR) |
|
|
186
|
+
| `assets_other_mfi_ex_eurosystem` | `number` | Assets Other MFIs outside Eurosystem (Billions of EUR) |
|
|
187
|
+
| `assets_government` | `number` | Assets Government (Billions of EUR) |
|
|
188
|
+
| `assets_other_sectors` | `number` | Assets Other Sectors (Billions of EUR) |
|
|
189
|
+
| `liabilities_total` | `number` | Liabilities Total (Billions of EUR) |
|
|
190
|
+
| `liabilities_currency_and_deposits` | `number` | Liabilities Currency and Deposits (Billions of EUR) |
|
|
191
|
+
| `liabilities_loans` | `number` | Liabilities Loans (Billions of EUR) |
|
|
192
|
+
| `liabilities_trade_credit_and_advances` | `number` | Liabilities Trade Credits and Advances (Billions of EUR) |
|
|
193
|
+
| `liabilities_eurosystem` | `number` | Liabilities Eurosystem (Billions of EUR) |
|
|
194
|
+
| `liabilities_other_mfi_ex_eurosystem` | `number` | Liabilities Other MFIs outside Eurosystem (Billions of EUR) |
|
|
195
|
+
| `liabilities_government` | `number` | Liabilities Government (Billions of EUR) |
|
|
196
|
+
| `liabilities_other_sectors` | `number` | Liabilities Other Sectors (Billions of EUR) |
|
|
197
|
+
| `assets_equity_and_fund_shares` | `number` | Assets Equity and Investment Fund Shares (Billions of EUR) |
|
|
198
|
+
| `assets_equity_shares` | `number` | Assets Equity Shares (Billions of EUR) |
|
|
199
|
+
| `assets_investment_fund_shares` | `number` | Assets Investment Fund Shares (Billions of EUR) |
|
|
200
|
+
| `assets_debt_short_term` | `number` | Assets Debt Short Term (Billions of EUR) |
|
|
201
|
+
| `assets_debt_long_term` | `number` | Assets Debt Long Term (Billions of EUR) |
|
|
202
|
+
| `assets_resident_sector_eurosystem` | `number` | Assets Resident Sector Eurosystem (Billions of EUR) |
|
|
203
|
+
| `assets_resident_sector_mfi_ex_eurosystem` | `number` | Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) |
|
|
204
|
+
| `assets_resident_sector_government` | `number` | Assets Resident Sector Government (Billions of EUR) |
|
|
205
|
+
| `assets_resident_sector_other` | `number` | Assets Resident Sector Other (Billions of EUR) |
|
|
206
|
+
| `liabilities_equity_and_fund_shares` | `number` | Liabilities Equity and Investment Fund Shares (Billions of EUR) |
|
|
207
|
+
| `liabilities_equity` | `number` | Liabilities Equity (Billions of EUR) |
|
|
208
|
+
| `liabilities_investment_fund_shares` | `number` | Liabilities Investment Fund Shares (Billions of EUR) |
|
|
209
|
+
| `liabilities_debt_short_term` | `number` | Liabilities Debt Short Term (Billions of EUR) |
|
|
210
|
+
| `liabilities_debt_long_term` | `number` | Liabilities Debt Long Term (Billions of EUR) |
|
|
211
|
+
| `liabilities_resident_sector_government` | `number` | Liabilities Resident Sector Government (Billions of EUR) |
|
|
212
|
+
| `liabilities_resident_sector_other` | `number` | Liabilities Resident Sector Other (Billions of EUR) |
|
|
213
|
+
| `assets_equity` | `number` | Assets Equity (Billions of EUR) |
|
|
214
|
+
| `assets_debt_instruments` | `number` | Assets Debt Instruments (Billions of EUR) |
|
|
215
|
+
| `assets_mfi` | `number` | Assets MFIs (Billions of EUR) |
|
|
216
|
+
| `assets_non_mfi` | `number` | Assets Non MFIs (Billions of EUR) |
|
|
217
|
+
| `assets_direct_investment_abroad` | `number` | Assets Direct Investment Abroad (Billions of EUR) |
|
|
218
|
+
| `liabilities_debt_instruments` | `number` | Liabilities Debt Instruments (Billions of EUR) |
|
|
219
|
+
| `liabilities_mfi` | `number` | Liabilities MFIs (Billions of EUR) |
|
|
220
|
+
| `liabilities_non_mfi` | `number` | Liabilities Non MFIs (Billions of EUR) |
|
|
221
|
+
| `liabilities_direct_investment_euro_area` | `number` | Liabilities Direct Investment in Euro Area (Billions of EUR) |
|
|
222
|
+
| `investment_total_credit` | `number` | Investment Total Credit (Billions of EUR) |
|
|
223
|
+
| `investment_total_debit` | `number` | Investment Total Debit (Billions of EUR) |
|
|
224
|
+
| `equity_credit` | `number` | Equity Credit (Billions of EUR) |
|
|
225
|
+
| `equity_reinvested_earnings_credit` | `number` | Equity Reinvested Earnings Credit (Billions of EUR) |
|
|
226
|
+
| `equity_debit` | `number` | Equity Debit (Billions of EUR) |
|
|
227
|
+
| `equity_reinvested_earnings_debit` | `number` | Equity Reinvested Earnings Debit (Billions of EUR) |
|
|
228
|
+
| `debt_instruments_credit` | `number` | Debt Instruments Credit (Billions of EUR) |
|
|
229
|
+
| `debt_instruments_debit` | `number` | Debt Instruments Debit (Billions of EUR) |
|
|
230
|
+
| `portfolio_investment_equity_credit` | `number` | Portfolio Investment Equity Credit (Billions of EUR) |
|
|
231
|
+
| `portfolio_investment_equity_debit` | `number` | Portfolio Investment Equity Debit (Billions of EUR) |
|
|
232
|
+
| `portfolio_investment_debt_instruments_credit` | `number` | Portfolio Investment Debt Instruments Credit (Billions of EUR) |
|
|
233
|
+
| `portofolio_investment_debt_instruments_debit` | `number` | Portfolio Investment Debt Instruments Debit (Billions of EUR) |
|
|
234
|
+
| `other_investment_credit` | `number` | Other Investment Credit (Billions of EUR) |
|
|
235
|
+
| `other_investment_debit` | `number` | Other Investment Debit (Billions of EUR) |
|
|
236
|
+
| `reserve_assets_credit` | `number` | Reserve Assets Credit (Billions of EUR) |
|
|
237
|
+
| `services_total_credit` | `number` | Services Total Credit (Billions of EUR) |
|
|
238
|
+
| `services_total_debit` | `number` | Services Total Debit (Billions of EUR) |
|
|
239
|
+
| `transport_credit` | `number` | Transport Credit (Billions of EUR) |
|
|
240
|
+
| `transport_debit` | `number` | Transport Debit (Billions of EUR) |
|
|
241
|
+
| `travel_credit` | `number` | Travel Credit (Billions of EUR) |
|
|
242
|
+
| `travel_debit` | `number` | Travel Debit (Billions of EUR) |
|
|
243
|
+
| `financial_services_credit` | `number` | Financial Services Credit (Billions of EUR) |
|
|
244
|
+
| `financial_services_debit` | `number` | Financial Services Debit (Billions of EUR) |
|
|
245
|
+
| `communications_credit` | `number` | Communications Credit (Billions of EUR) |
|
|
246
|
+
| `communications_debit` | `number` | Communications Debit (Billions of EUR) |
|
|
247
|
+
| `other_business_services_credit` | `number` | Other Business Services Credit (Billions of EUR) |
|
|
248
|
+
| `other_business_services_debit` | `number` | Other Business Services Debit (Billions of EUR) |
|
|
249
|
+
| `other_services_credit` | `number` | Other Services Credit (Billions of EUR) |
|
|
250
|
+
| `other_services_debit` | `number` | Other Services Debit (Billions of EUR) |
|
|
251
|
+
| `primary_income_employee_compensation_credit` | `number` | Primary Income Employee Compensation Credit (Billions of EUR) |
|
|
252
|
+
| `primary_income_employee_compensation_debit` | `number` | Primary Income Employee Compensation Debit (Billions of EUR) |
|
|
253
|
+
| `current_account` | `number` | Current Account Balance (Billions of EUR) |
|
|
254
|
+
| `goods` | `number` | Goods Balance (Billions of EUR) |
|
|
255
|
+
| `services` | `number` | Services Balance (Billions of EUR) |
|
|
256
|
+
| `primary_income` | `number` | Primary Income Balance (Billions of EUR) |
|
|
257
|
+
| `secondary_income` | `number` | Secondary Income Balance (Billions of EUR) |
|
|
258
|
+
| `capital_account` | `number` | Capital Account Balance (Billions of EUR) |
|
|
259
|
+
| `net_lending_to_rest_of_world` | `number` | Balance of net lending to the rest of the world (Billions of EUR) |
|
|
260
|
+
| `financial_account` | `number` | Financial Account Balance (Billions of EUR) |
|
|
261
|
+
| `direct_investment` | `number` | Direct Investment Balance (Billions of EUR) |
|
|
262
|
+
| `portfolio_investment` | `number` | Portfolio Investment Balance (Billions of EUR) |
|
|
263
|
+
| `financial_derivatives` | `number` | Financial Derivatives Balance (Billions of EUR) |
|
|
264
|
+
| `other_investment` | `number` | Other Investment Balance (Billions of EUR) |
|
|
265
|
+
| `reserve_assets` | `number` | Reserve Assets Balance (Billions of EUR) |
|
|
266
|
+
| `errors_and_omissions` | `number` | Errors and Omissions (Billions of EUR) |
|
|
112
267
|
|
|
113
268
|
---
|
|
114
269
|
|
|
115
270
|
### `economy.calendar`
|
|
116
271
|
|
|
117
272
|
```python
|
|
118
|
-
data.economy.calendar(start_time=None, end_time=None, release_id=None, country=None, importance=None, group=None, calendar_id=None
|
|
273
|
+
data.economy.calendar(start_time=None, end_time=None, release_id=None, country=None, importance=None, group=None, calendar_id=None)
|
|
119
274
|
```
|
|
120
275
|
|
|
121
276
|
Summary: Calendar
|
|
@@ -125,7 +280,6 @@ Summary: Calendar
|
|
|
125
280
|
| Endpoint ID | `economy.calendar` |
|
|
126
281
|
| HTTP | `GET` |
|
|
127
282
|
| Path | `/inner/v1/agent-data/economy/calendar` |
|
|
128
|
-
| Default provider | - |
|
|
129
283
|
| SDK | `supported` |
|
|
130
284
|
| Host | `supported` |
|
|
131
285
|
| Notes | - |
|
|
@@ -136,19 +290,49 @@ Summary: Calendar
|
|
|
136
290
|
|---|---|---|---|---|
|
|
137
291
|
| `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
292
|
| `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
|
-
|
|
293
|
+
| `release_id` | `no` | `integer | null` | `-` | Filter by release ID. |
|
|
294
|
+
| `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. |
|
|
295
|
+
| `importance` | `no` | `string | null` | `-` | Importance of the event. |
|
|
296
|
+
| `group` | `no` | `string | null` | `-` | Grouping of events. |
|
|
297
|
+
| `calendar_id` | `no` | `integer | string | null` | `-` | Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. |
|
|
298
|
+
|
|
299
|
+
#### Response fields
|
|
300
|
+
|
|
301
|
+
| Field | Type | Notes |
|
|
302
|
+
|---|---|---|
|
|
303
|
+
| `date` | `string` | The date of the data. |
|
|
304
|
+
| `country` | `string` | Country of event. |
|
|
305
|
+
| `category` | `string` | Category of event. |
|
|
306
|
+
| `event` | `string` | Event name. |
|
|
307
|
+
| `importance` | `string` | The importance level for the event. |
|
|
308
|
+
| `source` | `string` | Source of the data. |
|
|
309
|
+
| `currency` | `string` | Currency of the data. |
|
|
310
|
+
| `unit` | `string` | Unit of the data. |
|
|
311
|
+
| `consensus` | `string` | Average forecast among a representative group of economists. |
|
|
312
|
+
| `previous` | `string` | Value for the previous period after the revision (if revision is applicable). |
|
|
313
|
+
| `revised` | `string` | Revised previous value, if applicable. |
|
|
314
|
+
| `actual` | `string` | Latest released value. |
|
|
315
|
+
| `release_id` | `integer` | Release ID associated with the economic event. |
|
|
316
|
+
| `description` | `string` | Event description. |
|
|
317
|
+
| `change` | `number` | Value change since previous. |
|
|
318
|
+
| `change_percent` | `number` | Percentage change since previous. |
|
|
319
|
+
| `forecast` | `string` | TradingEconomics projections. |
|
|
320
|
+
| `reference` | `string` | Abbreviated period for which released data refers to. |
|
|
321
|
+
| `reference_date` | `string` | Date for the reference period. |
|
|
322
|
+
| `calendar_id` | `integer` | TradingEconomics Calendar ID. |
|
|
323
|
+
| `date_span` | `integer` | Date span of the event. |
|
|
324
|
+
| `symbol` | `string` | TradingEconomics Symbol. |
|
|
325
|
+
| `ticker` | `string` | TradingEconomics Ticker symbol. |
|
|
326
|
+
| `te_url` | `string` | TradingEconomics URL path. |
|
|
327
|
+
| `source_url` | `string` | Source URL. |
|
|
328
|
+
| `last_updated` | `string` | Last update of the data. |
|
|
145
329
|
|
|
146
330
|
---
|
|
147
331
|
|
|
148
332
|
### `economy.central_bank_holdings`
|
|
149
333
|
|
|
150
334
|
```python
|
|
151
|
-
data.economy.central_bank_holdings(date=None, holding_type='all_treasury', summary=False, cusip=None, wam=False, monthly=False
|
|
335
|
+
data.economy.central_bank_holdings(date=None, holding_type='all_treasury', summary=False, cusip=None, wam=False, monthly=False)
|
|
152
336
|
```
|
|
153
337
|
|
|
154
338
|
Summary: Central Bank Holdings
|
|
@@ -158,7 +342,6 @@ Summary: Central Bank Holdings
|
|
|
158
342
|
| Endpoint ID | `economy.central_bank_holdings` |
|
|
159
343
|
| HTTP | `GET` |
|
|
160
344
|
| Path | `/inner/v1/agent-data/economy/central_bank_holdings` |
|
|
161
|
-
| Default provider | `federal_reserve` |
|
|
162
345
|
| SDK | `supported` |
|
|
163
346
|
| Host | `supported` |
|
|
164
347
|
| Notes | - |
|
|
@@ -168,19 +351,47 @@ Summary: Central Bank Holdings
|
|
|
168
351
|
| Param | Required | Type | Default | Notes |
|
|
169
352
|
|---|---|---|---|---|
|
|
170
353
|
| `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.
|
|
354
|
+
| `holding_type` | `no` | `string` | `all_treasury` | Type of holdings to return. |
|
|
355
|
+
| `summary` | `no` | `boolean` | `false` | If True, returns historical weekly summary by holding type. This parameter takes priority over other parameters. |
|
|
173
356
|
| `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
|
-
|
|
357
|
+
| `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`. |
|
|
358
|
+
| `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'. |
|
|
359
|
+
|
|
360
|
+
#### Response fields
|
|
361
|
+
|
|
362
|
+
| Field | Type | Notes |
|
|
363
|
+
|---|---|---|
|
|
364
|
+
| `date` | `string` | The date of the data. |
|
|
365
|
+
| `security_type` | `string` | Type of security - i.e. TIPs, FRNs, etc. |
|
|
366
|
+
| `description` | `string` | Description of the security. Only returned for Agency securities. |
|
|
367
|
+
| `is_aggregated` | `string` | Whether the security is aggregated. Only returned for Agency securities. |
|
|
368
|
+
| `cusip` | `string` | cusip |
|
|
369
|
+
| `issuer` | `string` | Issuer of the security. |
|
|
370
|
+
| `maturity_date` | `string` | Maturity date of the security. |
|
|
371
|
+
| `term` | `string` | Term of the security. Only returned for Agency securities. |
|
|
372
|
+
| `face_value` | `number` | Current face value of the security (Thousands of $USD). |
|
|
373
|
+
| `par_value` | `number` | Par value of the security (Thousands of $USD). |
|
|
374
|
+
| `coupon` | `number` | Coupon rate of the security. |
|
|
375
|
+
| `spread` | `number` | Spread to the current reference rate, as determined at each security's initial auction. |
|
|
376
|
+
| `percent_outstanding` | `number` | Total percent of the outstanding CUSIP issuance. |
|
|
377
|
+
| `bills` | `number` | Treasury bills amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
378
|
+
| `frn` | `number` | Floating rate Treasury notes amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
379
|
+
| `notes_and_bonds` | `number` | Treasury Notes and bonds amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
380
|
+
| `tips` | `number` | Treasury inflation-protected securities amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
381
|
+
| `mbs` | `number` | Mortgage-backed securities amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
382
|
+
| `cmbs` | `number` | Commercial mortgage-backed securities amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
383
|
+
| `agencies` | `number` | Agency securities amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
384
|
+
| `total` | `number` | Total SOMA holdings amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
385
|
+
| `inflationCompensation` | `number` | Treasury inflation-protected securities inflation compensation amount (Thousands of $USD). Only returned when 'summary' is True. |
|
|
386
|
+
| `change_prior_week` | `number` | Change in SOMA holdings from the prior week (Thousands of $USD). |
|
|
387
|
+
| `change_prior_year` | `number` | Change in SOMA holdings from the prior year (Thousands of $USD). |
|
|
177
388
|
|
|
178
389
|
---
|
|
179
390
|
|
|
180
391
|
### `economy.composite_leading_indicator`
|
|
181
392
|
|
|
182
393
|
```python
|
|
183
|
-
data.economy.composite_leading_indicator(start_time=None, end_time=None, country='g20', adjustment='amplitude', growth_rate=False
|
|
394
|
+
data.economy.composite_leading_indicator(start_time=None, end_time=None, country='g20', adjustment='amplitude', growth_rate=False)
|
|
184
395
|
```
|
|
185
396
|
|
|
186
397
|
Summary: Composite Leading Indicator
|
|
@@ -190,7 +401,6 @@ Summary: Composite Leading Indicator
|
|
|
190
401
|
| Endpoint ID | `economy.composite_leading_indicator` |
|
|
191
402
|
| HTTP | `GET` |
|
|
192
403
|
| Path | `/inner/v1/agent-data/economy/composite_leading_indicator` |
|
|
193
|
-
| Default provider | `oecd` |
|
|
194
404
|
| SDK | `supported` |
|
|
195
405
|
| Host | `supported` |
|
|
196
406
|
| Notes | - |
|
|
@@ -201,17 +411,24 @@ Summary: Composite Leading Indicator
|
|
|
201
411
|
|---|---|---|---|---|
|
|
202
412
|
| `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
413
|
| `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
|
-
|
|
414
|
+
| `country` | `no` | `string` | `g20` | Country to get the CLI for, default is G20. Multiple comma separated items allowed. |
|
|
415
|
+
| `adjustment` | `no` | `string` | `amplitude` | Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude. |
|
|
416
|
+
| `growth_rate` | `no` | `boolean` | `false` | Return the 1-year growth rate (%) of the CLI, default is False. |
|
|
417
|
+
|
|
418
|
+
#### Response fields
|
|
419
|
+
|
|
420
|
+
| Field | Type | Notes |
|
|
421
|
+
|---|---|---|
|
|
422
|
+
| `date` | `string` | The date of the data. |
|
|
423
|
+
| `value` | `number` | CLI value |
|
|
424
|
+
| `country` | `string` | Country for the CLI value. |
|
|
208
425
|
|
|
209
426
|
---
|
|
210
427
|
|
|
211
428
|
### `economy.country_profile`
|
|
212
429
|
|
|
213
430
|
```python
|
|
214
|
-
data.economy.country_profile(country=..., latest=True, use_cache=True
|
|
431
|
+
data.economy.country_profile(country=..., latest=True, use_cache=True)
|
|
215
432
|
```
|
|
216
433
|
|
|
217
434
|
Summary: Country Profile
|
|
@@ -221,7 +438,6 @@ Summary: Country Profile
|
|
|
221
438
|
| Endpoint ID | `economy.country_profile` |
|
|
222
439
|
| HTTP | `GET` |
|
|
223
440
|
| Path | `/inner/v1/agent-data/economy/country_profile` |
|
|
224
|
-
| Default provider | `econdb` |
|
|
225
441
|
| SDK | `supported` |
|
|
226
442
|
| Host | `supported` |
|
|
227
443
|
| Notes | - |
|
|
@@ -230,17 +446,35 @@ Summary: Country Profile
|
|
|
230
446
|
|
|
231
447
|
| Param | Required | Type | Default | Notes |
|
|
232
448
|
|---|---|---|---|---|
|
|
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
|
-
|
|
449
|
+
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed |
|
|
450
|
+
| `latest` | `no` | `boolean` | `true` | If True, return only the latest data. If False, return all available data for each indicator. |
|
|
451
|
+
| `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. |
|
|
452
|
+
|
|
453
|
+
#### Response fields
|
|
454
|
+
|
|
455
|
+
| Field | Type | Notes |
|
|
456
|
+
|---|---|---|
|
|
457
|
+
| `country` | `string` | country |
|
|
458
|
+
| `population` | `integer` | Population. |
|
|
459
|
+
| `gdp_usd` | `number` | Gross Domestic Product, in billions of USD. |
|
|
460
|
+
| `gdp_qoq` | `number` | GDP growth quarter-over-quarter change, as a normalized percent. |
|
|
461
|
+
| `gdp_yoy` | `number` | GDP growth year-over-year change, as a normalized percent. |
|
|
462
|
+
| `cpi_yoy` | `number` | Consumer Price Index year-over-year change, as a normalized percent. |
|
|
463
|
+
| `core_yoy` | `number` | Core Consumer Price Index year-over-year change, as a normalized percent. |
|
|
464
|
+
| `retail_sales_yoy` | `number` | Retail Sales year-over-year change, as a normalized percent. |
|
|
465
|
+
| `industrial_production_yoy` | `number` | Industrial Production year-over-year change, as a normalized percent. |
|
|
466
|
+
| `policy_rate` | `number` | Short term policy rate, as a normalized percent. |
|
|
467
|
+
| `yield_10y` | `number` | 10-year government bond yield, as a normalized percent. |
|
|
468
|
+
| `govt_debt_gdp` | `number` | Government debt as a percent (normalized) of GDP. |
|
|
469
|
+
| `current_account_gdp` | `number` | Current account balance as a percent (normalized) of GDP. |
|
|
470
|
+
| `jobless_rate` | `number` | Unemployment rate, as a normalized percent. |
|
|
237
471
|
|
|
238
472
|
---
|
|
239
473
|
|
|
240
474
|
### `economy.cpi`
|
|
241
475
|
|
|
242
476
|
```python
|
|
243
|
-
data.economy.cpi(start_time=None, end_time=None, country='united_states', transform='yoy', frequency='monthly', harmonized=False, expenditure='total', limit=None
|
|
477
|
+
data.economy.cpi(start_time=None, end_time=None, country='united_states', transform='yoy', frequency='monthly', harmonized=False, expenditure='total', limit=None)
|
|
244
478
|
```
|
|
245
479
|
|
|
246
480
|
Summary: Cpi
|
|
@@ -250,7 +484,6 @@ Summary: Cpi
|
|
|
250
484
|
| Endpoint ID | `economy.cpi` |
|
|
251
485
|
| HTTP | `GET` |
|
|
252
486
|
| Path | `/inner/v1/agent-data/economy/cpi` |
|
|
253
|
-
| Default provider | - |
|
|
254
487
|
| SDK | `supported` |
|
|
255
488
|
| Host | `supported` |
|
|
256
489
|
| Notes | - |
|
|
@@ -261,20 +494,34 @@ Summary: Cpi
|
|
|
261
494
|
|---|---|---|---|---|
|
|
262
495
|
| `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
496
|
| `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
|
|
497
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
265
498
|
| `transform` | `no` | `string` | `yoy` | Transformation of the CPI data. |
|
|
266
499
|
| `frequency` | `no` | `string` | `monthly` | enum: annual, quarter, monthly The frequency of the data. |
|
|
267
500
|
| `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
|
-
|
|
501
|
+
| `expenditure` | `no` | `string` | `total` | Expenditure component of CPI. |
|
|
502
|
+
| `limit` | `no` | `integer | null` | `-` | Maximum number of records to retrieve per series and country. If None, retrieves all available records. |
|
|
503
|
+
|
|
504
|
+
#### Response fields
|
|
505
|
+
|
|
506
|
+
| Field | Type | Notes |
|
|
507
|
+
|---|---|---|
|
|
508
|
+
| `date` | `string` | The date of the data. |
|
|
509
|
+
| `country` | `string` | Country |
|
|
510
|
+
| `value` | `number` | CPI index value or period change. |
|
|
511
|
+
| `expenditure` | `string` | Expenditure component of CPI. |
|
|
512
|
+
| `unit` | `string` | Unit of measurement. |
|
|
513
|
+
| `unit_multiplier` | `integer` | Unit multiplier for the observation value. |
|
|
514
|
+
| `country_code` | `string` | ISO3 country code. |
|
|
515
|
+
| `series_id` | `string` | IMF series identifier. |
|
|
516
|
+
| `title` | `string` | Complete reference title for the series. |
|
|
517
|
+
| `order` | `integer` | Sort order for expenditure categories and table presentations. |
|
|
271
518
|
|
|
272
519
|
---
|
|
273
520
|
|
|
274
521
|
### `economy.direction_of_trade`
|
|
275
522
|
|
|
276
523
|
```python
|
|
277
|
-
data.economy.direction_of_trade(start_time=None, end_time=None, country=None, counterpart=None, direction='balance', frequency='month', limit=None
|
|
524
|
+
data.economy.direction_of_trade(start_time=None, end_time=None, country=None, counterpart=None, direction='balance', frequency='month', limit=None)
|
|
278
525
|
```
|
|
279
526
|
|
|
280
527
|
Summary: Direction Of Trade
|
|
@@ -284,7 +531,6 @@ Summary: Direction Of Trade
|
|
|
284
531
|
| Endpoint ID | `economy.direction_of_trade` |
|
|
285
532
|
| HTTP | `GET` |
|
|
286
533
|
| Path | `/inner/v1/agent-data/economy/direction_of_trade` |
|
|
287
|
-
| Default provider | `imf` |
|
|
288
534
|
| SDK | `supported` |
|
|
289
535
|
| Host | `supported` |
|
|
290
536
|
| Notes | - |
|
|
@@ -295,19 +541,34 @@ Summary: Direction Of Trade
|
|
|
295
541
|
|---|---|---|---|---|
|
|
296
542
|
| `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
543
|
| `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
|
|
544
|
+
| `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 |
|
|
545
|
+
| `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
546
|
| `direction` | `no` | `string` | `balance` | Trade direction. Use 'all' to get all data for this dimension. |
|
|
301
547
|
| `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
|
-
|
|
548
|
+
| `limit` | `no` | `integer | null` | `-` | Limit the number of results returned, the most recent data points first. |
|
|
549
|
+
|
|
550
|
+
#### Response fields
|
|
551
|
+
|
|
552
|
+
| Field | Type | Notes |
|
|
553
|
+
|---|---|---|
|
|
554
|
+
| `date` | `string` | The date of the data. |
|
|
555
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. Concatenated series identifier. |
|
|
556
|
+
| `country` | `string` | The country or region to the trade. |
|
|
557
|
+
| `counterpart` | `string` | Counterpart country or region to the trade. |
|
|
558
|
+
| `title` | `string` | Title corresponding to the symbol. |
|
|
559
|
+
| `value` | `number` | Trade value. |
|
|
560
|
+
| `scale` | `string` | Scale of the value. |
|
|
561
|
+
| `unit` | `string` | Unit of the value. |
|
|
562
|
+
| `country_code` | `string` | IMF country code. |
|
|
563
|
+
| `counterpart_code` | `string` | IMF counterpart country code. |
|
|
564
|
+
| `unit_multiplier` | `integer` | Unit multiplier of the value. |
|
|
304
565
|
|
|
305
566
|
---
|
|
306
567
|
|
|
307
568
|
### `economy.export_destinations`
|
|
308
569
|
|
|
309
570
|
```python
|
|
310
|
-
data.economy.export_destinations(country
|
|
571
|
+
data.economy.export_destinations(country=...)
|
|
311
572
|
```
|
|
312
573
|
|
|
313
574
|
Summary: Export Destinations
|
|
@@ -317,7 +578,6 @@ Summary: Export Destinations
|
|
|
317
578
|
| Endpoint ID | `economy.export_destinations` |
|
|
318
579
|
| HTTP | `GET` |
|
|
319
580
|
| Path | `/inner/v1/agent-data/economy/export_destinations` |
|
|
320
|
-
| Default provider | `econdb` |
|
|
321
581
|
| SDK | `supported` |
|
|
322
582
|
| Host | `supported` |
|
|
323
583
|
| Notes | - |
|
|
@@ -326,15 +586,25 @@ Summary: Export Destinations
|
|
|
326
586
|
|
|
327
587
|
| Param | Required | Type | Default | Notes |
|
|
328
588
|
|---|---|---|---|---|
|
|
329
|
-
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed
|
|
330
|
-
|
|
589
|
+
| `country` | `yes` | `string` | `-` | The country to get data. Multiple comma separated items allowed |
|
|
590
|
+
|
|
591
|
+
#### Response fields
|
|
592
|
+
|
|
593
|
+
| Field | Type | Notes |
|
|
594
|
+
|---|---|---|
|
|
595
|
+
| `origin_country` | `string` | The country of origin. |
|
|
596
|
+
| `destination_country` | `string` | The destination country. |
|
|
597
|
+
| `value` | `number` | The value of the export. |
|
|
598
|
+
| `units` | `string` | The units of measurement for the value. |
|
|
599
|
+
| `title` | `string` | The title of the data. |
|
|
600
|
+
| `footnote` | `string` | The footnote for the data. |
|
|
331
601
|
|
|
332
602
|
---
|
|
333
603
|
|
|
334
604
|
### `economy.fomc_documents`
|
|
335
605
|
|
|
336
606
|
```python
|
|
337
|
-
data.economy.fomc_documents(year=None, document_type=None
|
|
607
|
+
data.economy.fomc_documents(year=None, document_type=None)
|
|
338
608
|
```
|
|
339
609
|
|
|
340
610
|
Summary: Fomc Documents
|
|
@@ -344,7 +614,6 @@ Summary: Fomc Documents
|
|
|
344
614
|
| Endpoint ID | `economy.fomc_documents` |
|
|
345
615
|
| HTTP | `GET` |
|
|
346
616
|
| Path | `/inner/v1/agent-data/economy/fomc_documents` |
|
|
347
|
-
| Default provider | `federal_reserve` |
|
|
348
617
|
| SDK | `supported` |
|
|
349
618
|
| Host | `supported` |
|
|
350
619
|
| Notes | - |
|
|
@@ -353,16 +622,24 @@ Summary: Fomc Documents
|
|
|
353
622
|
|
|
354
623
|
| Param | Required | Type | Default | Notes |
|
|
355
624
|
|---|---|---|---|---|
|
|
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
|
-
|
|
625
|
+
| `year` | `no` | `integer | null` | `-` | The year of FOMC documents to retrieve. If None, all years since 1959 are returned. |
|
|
626
|
+
| `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 |
|
|
627
|
+
|
|
628
|
+
#### Response fields
|
|
629
|
+
|
|
630
|
+
| Field | Type | Notes |
|
|
631
|
+
|---|---|---|
|
|
632
|
+
| `date` | `string` | The date of the document, formatted as YYYY-MM-DD. |
|
|
633
|
+
| `doc_type` | `string` | The type of the FOMC document. |
|
|
634
|
+
| `doc_format` | `string` | The format of the document (e.g., pdf, htm). |
|
|
635
|
+
| `url` | `string` | The URL of the document. |
|
|
359
636
|
|
|
360
637
|
---
|
|
361
638
|
|
|
362
639
|
### `economy.fred_regional`
|
|
363
640
|
|
|
364
641
|
```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
|
|
642
|
+
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
643
|
```
|
|
367
644
|
|
|
368
645
|
Summary: Fred Regional
|
|
@@ -372,7 +649,6 @@ Summary: Fred Regional
|
|
|
372
649
|
| Endpoint ID | `economy.fred_regional` |
|
|
373
650
|
| HTTP | `GET` |
|
|
374
651
|
| Path | `/inner/v1/agent-data/economy/fred_regional` |
|
|
375
|
-
| Default provider | `fred` |
|
|
376
652
|
| SDK | `supported` |
|
|
377
653
|
| Host | `supported` |
|
|
378
654
|
| Notes | - |
|
|
@@ -381,25 +657,34 @@ Summary: Fred Regional
|
|
|
381
657
|
|
|
382
658
|
| Param | Required | Type | Default | Notes |
|
|
383
659
|
|---|---|---|---|---|
|
|
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.
|
|
660
|
+
| `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
661
|
| `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
662
|
| `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
663
|
| `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
|
-
|
|
664
|
+
| `is_series_group` | `no` | `boolean` | `false` | When True, the symbol provided is for a series_group, else it is for a series ID. |
|
|
665
|
+
| `region_type` | `no` | `string | null` | `-` | The type of regional data. Parameter is only valid when `is_series_group` is True. |
|
|
666
|
+
| `season` | `no` | `string` | `nsa` | The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. |
|
|
667
|
+
| `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. |
|
|
668
|
+
| `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 |
|
|
669
|
+
| `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 |
|
|
670
|
+
| `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 |
|
|
671
|
+
|
|
672
|
+
#### Response fields
|
|
673
|
+
|
|
674
|
+
| Field | Type | Notes |
|
|
675
|
+
|---|---|---|
|
|
676
|
+
| `date` | `string` | The date of the data. |
|
|
677
|
+
| `region` | `string` | The name of the region. |
|
|
678
|
+
| `code` | `string` | The code of the region. |
|
|
679
|
+
| `value` | `integer` | The observation value. The units are defined in the search results by series ID. |
|
|
680
|
+
| `series_id` | `string` | The individual series ID for the region. |
|
|
396
681
|
|
|
397
682
|
---
|
|
398
683
|
|
|
399
684
|
### `economy.fred_release_table`
|
|
400
685
|
|
|
401
686
|
```python
|
|
402
|
-
data.economy.fred_release_table(release_id=..., element_id=None, date=None
|
|
687
|
+
data.economy.fred_release_table(release_id=..., element_id=None, date=None)
|
|
403
688
|
```
|
|
404
689
|
|
|
405
690
|
Summary: Fred Release Table
|
|
@@ -409,7 +694,6 @@ Summary: Fred Release Table
|
|
|
409
694
|
| Endpoint ID | `economy.fred_release_table` |
|
|
410
695
|
| HTTP | `GET` |
|
|
411
696
|
| Path | `/inner/v1/agent-data/economy/fred_release_table` |
|
|
412
|
-
| Default provider | `fred` |
|
|
413
697
|
| SDK | `supported` |
|
|
414
698
|
| Host | `supported` |
|
|
415
699
|
| Notes | - |
|
|
@@ -420,15 +704,29 @@ Summary: Fred Release Table
|
|
|
420
704
|
|---|---|---|---|---|
|
|
421
705
|
| `release_id` | `yes` | `string` | `-` | The ID of the release. Use `fred_search` to find releases. |
|
|
422
706
|
| `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
|
-
|
|
707
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed |
|
|
708
|
+
|
|
709
|
+
#### Response fields
|
|
710
|
+
|
|
711
|
+
| Field | Type | Notes |
|
|
712
|
+
|---|---|---|
|
|
713
|
+
| `date` | `string` | The date of the data. |
|
|
714
|
+
| `level` | `integer` | The indentation level of the element. |
|
|
715
|
+
| `element_type` | `string` | The type of the element. |
|
|
716
|
+
| `line` | `integer` | The line number of the element. |
|
|
717
|
+
| `element_id` | `string` | The element id in the parent/child relationship. |
|
|
718
|
+
| `parent_id` | `string` | The parent id in the parent/child relationship. |
|
|
719
|
+
| `children` | `string` | The element_id of each child, as a comma-separated string. |
|
|
720
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
721
|
+
| `name` | `string` | The name of the series. |
|
|
722
|
+
| `value` | `number` | The reported value of the series. |
|
|
425
723
|
|
|
426
724
|
---
|
|
427
725
|
|
|
428
726
|
### `economy.fred_search`
|
|
429
727
|
|
|
430
728
|
```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
|
|
729
|
+
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
730
|
```
|
|
433
731
|
|
|
434
732
|
Summary: Fred Search
|
|
@@ -438,7 +736,6 @@ Summary: Fred Search
|
|
|
438
736
|
| Endpoint ID | `economy.fred_search` |
|
|
439
737
|
| HTTP | `GET` |
|
|
440
738
|
| Path | `/inner/v1/agent-data/economy/fred_search` |
|
|
441
|
-
| Default provider | `fred` |
|
|
442
739
|
| SDK | `supported` |
|
|
443
740
|
| Host | `supported` |
|
|
444
741
|
| Notes | - |
|
|
@@ -448,25 +745,51 @@ Summary: Fred Search
|
|
|
448
745
|
| Param | Required | Type | Default | Notes |
|
|
449
746
|
|---|---|---|---|---|
|
|
450
747
|
| `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
|
-
|
|
748
|
+
| `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. |
|
|
749
|
+
| `release_id` | `no` | `integer | null` | `-` | A specific release ID to target. |
|
|
750
|
+
| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (1-1000) |
|
|
751
|
+
| `offset` | `no` | `integer | null` | `0` | Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'. |
|
|
752
|
+
| `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'. |
|
|
753
|
+
| `sort_order` | `no` | `string` | `desc` | Sort the 'order_by' item in ascending or descending order. The default is 'desc'. |
|
|
754
|
+
| `filter_variable` | `no` | `string | null` | `-` | Filter by an attribute. |
|
|
755
|
+
| `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'. |
|
|
756
|
+
| `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. |
|
|
757
|
+
| `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. |
|
|
758
|
+
| `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. |
|
|
759
|
+
|
|
760
|
+
#### Response fields
|
|
761
|
+
|
|
762
|
+
| Field | Type | Notes |
|
|
763
|
+
|---|---|---|
|
|
764
|
+
| `release_id` | `string` | The release ID for queries. |
|
|
765
|
+
| `series_id` | `string` | The series ID for the item in the release. |
|
|
766
|
+
| `series_group` | `string` | The series group ID of the series. This value is used to query for regional data. |
|
|
767
|
+
| `region_type` | `string` | The region type of the series. |
|
|
768
|
+
| `name` | `string` | The name of the release. |
|
|
769
|
+
| `title` | `string` | The title of the series. |
|
|
770
|
+
| `observation_start` | `string` | The date of the first observation in the series. |
|
|
771
|
+
| `observation_end` | `string` | The date of the last observation in the series. |
|
|
772
|
+
| `frequency` | `string` | The frequency of the data. |
|
|
773
|
+
| `frequency_short` | `string` | Short form of the data frequency. |
|
|
774
|
+
| `units` | `string` | The units of the data. |
|
|
775
|
+
| `units_short` | `string` | Short form of the data units. |
|
|
776
|
+
| `seasonal_adjustment` | `string` | The seasonal adjustment of the data. |
|
|
777
|
+
| `seasonal_adjustment_short` | `string` | Short form of the data seasonal adjustment. |
|
|
778
|
+
| `last_updated` | `string` | The datetime of the last update to the data. |
|
|
779
|
+
| `popularity` | `integer` | Popularity of the series |
|
|
780
|
+
| `group_popularity` | `integer` | Group popularity of the release |
|
|
781
|
+
| `realtime_start` | `string` | The realtime start date of the series. |
|
|
782
|
+
| `realtime_end` | `string` | The realtime end date of the series. |
|
|
783
|
+
| `notes` | `string` | Description of the release. |
|
|
784
|
+
| `press_release` | `boolean` | If the release is a press release. |
|
|
785
|
+
| `url` | `string` | URL to the release. |
|
|
463
786
|
|
|
464
787
|
---
|
|
465
788
|
|
|
466
789
|
### `economy.fred_series`
|
|
467
790
|
|
|
468
791
|
```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
|
|
792
|
+
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
793
|
```
|
|
471
794
|
|
|
472
795
|
Summary: Fred Series
|
|
@@ -476,7 +799,6 @@ Summary: Fred Series
|
|
|
476
799
|
| Endpoint ID | `economy.fred_series` |
|
|
477
800
|
| HTTP | `GET` |
|
|
478
801
|
| Path | `/inner/v1/agent-data/economy/fred_series` |
|
|
479
|
-
| Default provider | - |
|
|
480
802
|
| SDK | `supported` |
|
|
481
803
|
| Host | `supported` |
|
|
482
804
|
| Notes | Replacement target for future data.macro.* facade work. |
|
|
@@ -485,23 +807,29 @@ Summary: Fred Series
|
|
|
485
807
|
|
|
486
808
|
| Param | Required | Type | Default | Notes |
|
|
487
809
|
|---|---|---|---|---|
|
|
488
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
810
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
489
811
|
| `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
812
|
| `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
813
|
| `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
|
-
|
|
814
|
+
| `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 |
|
|
815
|
+
| `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 |
|
|
816
|
+
| `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 |
|
|
817
|
+
| `all_pages` | `no` | `boolean | null` | `false` | Returns all pages of data from the API call at once. |
|
|
818
|
+
| `sleep` | `no` | `number | null` | `1.0` | Time to sleep between requests to avoid rate limiting. |
|
|
819
|
+
|
|
820
|
+
#### Response fields
|
|
821
|
+
|
|
822
|
+
| Field | Type | Notes |
|
|
823
|
+
|---|---|---|
|
|
824
|
+
| `date` | `string` | The date of the data. |
|
|
825
|
+
| `value` | `number` | Value of the index. |
|
|
498
826
|
|
|
499
827
|
---
|
|
500
828
|
|
|
501
829
|
### `economy.gdp.forecast`
|
|
502
830
|
|
|
503
831
|
```python
|
|
504
|
-
data.economy.gdp.forecast(start_time=None, end_time=None, country='all', frequency='annual', units='volume'
|
|
832
|
+
data.economy.gdp.forecast(start_time=None, end_time=None, country='all', frequency='annual', units='volume')
|
|
505
833
|
```
|
|
506
834
|
|
|
507
835
|
Summary: Forecast
|
|
@@ -511,7 +839,6 @@ Summary: Forecast
|
|
|
511
839
|
| Endpoint ID | `economy.gdp.forecast` |
|
|
512
840
|
| HTTP | `GET` |
|
|
513
841
|
| Path | `/inner/v1/agent-data/economy/gdp/forecast` |
|
|
514
|
-
| Default provider | `oecd` |
|
|
515
842
|
| SDK | `supported` |
|
|
516
843
|
| Host | `supported` |
|
|
517
844
|
| Notes | - |
|
|
@@ -522,17 +849,24 @@ Summary: Forecast
|
|
|
522
849
|
|---|---|---|---|---|
|
|
523
850
|
| `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
851
|
| `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
|
-
|
|
852
|
+
| `country` | `no` | `string` | `all` | Country, or countries, to get forward GDP projections for. Default is all. Multiple comma separated items allowed. |
|
|
853
|
+
| `frequency` | `no` | `string` | `annual` | Frequency of the data, default is annual. |
|
|
854
|
+
| `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. |
|
|
855
|
+
|
|
856
|
+
#### Response fields
|
|
857
|
+
|
|
858
|
+
| Field | Type | Notes |
|
|
859
|
+
|---|---|---|
|
|
860
|
+
| `date` | `string` | The date of the data. |
|
|
861
|
+
| `country` | `string` | Country |
|
|
862
|
+
| `value` | `integer` | Forecasted GDP value for the country and date. |
|
|
529
863
|
|
|
530
864
|
---
|
|
531
865
|
|
|
532
866
|
### `economy.gdp.nominal`
|
|
533
867
|
|
|
534
868
|
```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'
|
|
869
|
+
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
870
|
```
|
|
537
871
|
|
|
538
872
|
Summary: Nominal
|
|
@@ -542,7 +876,6 @@ Summary: Nominal
|
|
|
542
876
|
| Endpoint ID | `economy.gdp.nominal` |
|
|
543
877
|
| HTTP | `GET` |
|
|
544
878
|
| Path | `/inner/v1/agent-data/economy/gdp/nominal` |
|
|
545
|
-
| Default provider | - |
|
|
546
879
|
| SDK | `supported` |
|
|
547
880
|
| Host | `supported` |
|
|
548
881
|
| Notes | - |
|
|
@@ -553,19 +886,28 @@ Summary: Nominal
|
|
|
553
886
|
|---|---|---|---|---|
|
|
554
887
|
| `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
888
|
| `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
|
-
|
|
889
|
+
| `country` | `no` | `string` | `united_states` | The country to get data.Use 'all' to get data for all available countries. |
|
|
890
|
+
| `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. |
|
|
891
|
+
| `frequency` | `no` | `string` | `quarter` | enum: quarter, annual Frequency of the data. |
|
|
892
|
+
| `units` | `no` | `string` | `level` | enum: level, index, capita The unit of measurement for the data.Both 'level' and 'capita' (per) are measured in USD. |
|
|
893
|
+
| `price_base` | `no` | `string` | `current_prices` | enum: current_prices, volume Price base for the data, volume is chain linked volume. |
|
|
894
|
+
|
|
895
|
+
#### Response fields
|
|
896
|
+
|
|
897
|
+
| Field | Type | Notes |
|
|
898
|
+
|---|---|---|
|
|
899
|
+
| `date` | `string` | The date of the data. |
|
|
900
|
+
| `country` | `string` | The country represented by the GDP value. |
|
|
901
|
+
| `value` | `integer` | GDP value for the country and date. |
|
|
902
|
+
| `nominal_growth_qoq` | `number` | Nominal GDP growth rate quarter over quarter. |
|
|
903
|
+
| `nominal_growth_yoy` | `number` | Nominal GDP growth rate year over year. |
|
|
562
904
|
|
|
563
905
|
---
|
|
564
906
|
|
|
565
907
|
### `economy.gdp.real`
|
|
566
908
|
|
|
567
909
|
```python
|
|
568
|
-
data.economy.gdp.real(start_time=None, end_time=None, country='united_states', use_cache=True, frequency='quarter'
|
|
910
|
+
data.economy.gdp.real(start_time=None, end_time=None, country='united_states', use_cache=True, frequency='quarter')
|
|
569
911
|
```
|
|
570
912
|
|
|
571
913
|
Summary: Real
|
|
@@ -575,7 +917,6 @@ Summary: Real
|
|
|
575
917
|
| Endpoint ID | `economy.gdp.real` |
|
|
576
918
|
| HTTP | `GET` |
|
|
577
919
|
| Path | `/inner/v1/agent-data/economy/gdp/real` |
|
|
578
|
-
| Default provider | - |
|
|
579
920
|
| SDK | `supported` |
|
|
580
921
|
| Host | `supported` |
|
|
581
922
|
| Notes | - |
|
|
@@ -586,17 +927,26 @@ Summary: Real
|
|
|
586
927
|
|---|---|---|---|---|
|
|
587
928
|
| `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
929
|
| `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
|
-
|
|
930
|
+
| `country` | `no` | `string` | `united_states` | The country to get data.Use 'all' to get data for all available countries. |
|
|
931
|
+
| `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. |
|
|
932
|
+
| `frequency` | `no` | `string` | `quarter` | enum: quarter, annual Frequency of the data. |
|
|
933
|
+
|
|
934
|
+
#### Response fields
|
|
935
|
+
|
|
936
|
+
| Field | Type | Notes |
|
|
937
|
+
|---|---|---|
|
|
938
|
+
| `date` | `string` | The date of the data. |
|
|
939
|
+
| `country` | `string` | The country represented by the Real GDP value. |
|
|
940
|
+
| `value` | `integer` | Real GDP value for the country and date. |
|
|
941
|
+
| `real_growth_qoq` | `number` | Real GDP growth rate quarter over quarter. |
|
|
942
|
+
| `real_growth_yoy` | `number` | Real GDP growth rate year over year. |
|
|
593
943
|
|
|
594
944
|
---
|
|
595
945
|
|
|
596
946
|
### `economy.house_price_index`
|
|
597
947
|
|
|
598
948
|
```python
|
|
599
|
-
data.economy.house_price_index(start_time=None, end_time=None, country='united_states', frequency='quarter', transform='index'
|
|
949
|
+
data.economy.house_price_index(start_time=None, end_time=None, country='united_states', frequency='quarter', transform='index')
|
|
600
950
|
```
|
|
601
951
|
|
|
602
952
|
Summary: House Price Index
|
|
@@ -606,7 +956,6 @@ Summary: House Price Index
|
|
|
606
956
|
| Endpoint ID | `economy.house_price_index` |
|
|
607
957
|
| HTTP | `GET` |
|
|
608
958
|
| Path | `/inner/v1/agent-data/economy/house_price_index` |
|
|
609
|
-
| Default provider | `oecd` |
|
|
610
959
|
| SDK | `supported` |
|
|
611
960
|
| Host | `supported` |
|
|
612
961
|
| Notes | - |
|
|
@@ -617,17 +966,24 @@ Summary: House Price Index
|
|
|
617
966
|
|---|---|---|---|---|
|
|
618
967
|
| `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
968
|
| `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
|
|
969
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
621
970
|
| `frequency` | `no` | `string` | `quarter` | The frequency of the data. |
|
|
622
971
|
| `transform` | `no` | `string` | `index` | Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy). |
|
|
623
|
-
|
|
972
|
+
|
|
973
|
+
#### Response fields
|
|
974
|
+
|
|
975
|
+
| Field | Type | Notes |
|
|
976
|
+
|---|---|---|
|
|
977
|
+
| `date` | `string` | The date of the data. |
|
|
978
|
+
| `country` | `string` | country |
|
|
979
|
+
| `value` | `number` | Share price index value. |
|
|
624
980
|
|
|
625
981
|
---
|
|
626
982
|
|
|
627
983
|
### `economy.indicators`
|
|
628
984
|
|
|
629
985
|
```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
|
|
986
|
+
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
987
|
```
|
|
632
988
|
|
|
633
989
|
Summary: Indicators
|
|
@@ -637,7 +993,6 @@ Summary: Indicators
|
|
|
637
993
|
| Endpoint ID | `economy.indicators` |
|
|
638
994
|
| HTTP | `GET` |
|
|
639
995
|
| Path | `/inner/v1/agent-data/economy/indicators` |
|
|
640
|
-
| Default provider | - |
|
|
641
996
|
| SDK | `supported` |
|
|
642
997
|
| Host | `supported` |
|
|
643
998
|
| Notes | - |
|
|
@@ -646,24 +1001,41 @@ Summary: Indicators
|
|
|
646
1001
|
|
|
647
1002
|
| Param | Required | Type | Default | Notes |
|
|
648
1003
|
|---|---|---|---|---|
|
|
649
|
-
| `symbol` | `yes` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
1004
|
+
| `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
1005
|
| `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
1006
|
| `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
|
-
|
|
1007
|
+
| `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. |
|
|
1008
|
+
| `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. |
|
|
1009
|
+
| `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. |
|
|
1010
|
+
| `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. |
|
|
1011
|
+
| `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. |
|
|
1012
|
+
| `limit` | `no` | `integer | null` | `-` | Maximum number of records to retrieve per series. |
|
|
1013
|
+
| `pivot` | `no` | `boolean` | `false` | If True, pivots the data to presentation view with 'indicator' and 'country' as the index, date as values. |
|
|
1014
|
+
|
|
1015
|
+
#### Response fields
|
|
1016
|
+
|
|
1017
|
+
| Field | Type | Notes |
|
|
1018
|
+
|---|---|---|
|
|
1019
|
+
| `date` | `string` | The date of the data. |
|
|
1020
|
+
| `symbol_root` | `string` | The root symbol for the indicator (e.g. GDP). |
|
|
1021
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1022
|
+
| `country` | `string` | The country represented by the data. |
|
|
1023
|
+
| `value` | `integer` | value |
|
|
1024
|
+
| `unit` | `string` | The unit of measurement. |
|
|
1025
|
+
| `unit_multiplier` | `integer` | The multiplier for the unit. |
|
|
1026
|
+
| `scale` | `string` | The scale/multiplier of the value. |
|
|
1027
|
+
| `order` | `integer` | Sort order within the table hierarchy. |
|
|
1028
|
+
| `level` | `integer` | Indentation level in the table hierarchy. |
|
|
1029
|
+
| `Indicator` | `string` | Human-readable title of the series. |
|
|
1030
|
+
| `description` | `string` | Description of the indicator. |
|
|
1031
|
+
| `country_code` | `string` | ISO3 country code. |
|
|
660
1032
|
|
|
661
1033
|
---
|
|
662
1034
|
|
|
663
1035
|
### `economy.interest_rates`
|
|
664
1036
|
|
|
665
1037
|
```python
|
|
666
|
-
data.economy.interest_rates(start_time=None, end_time=None, country='united_states', duration='short', frequency='monthly'
|
|
1038
|
+
data.economy.interest_rates(start_time=None, end_time=None, country='united_states', duration='short', frequency='monthly')
|
|
667
1039
|
```
|
|
668
1040
|
|
|
669
1041
|
Summary: Interest Rates
|
|
@@ -673,7 +1045,6 @@ Summary: Interest Rates
|
|
|
673
1045
|
| Endpoint ID | `economy.interest_rates` |
|
|
674
1046
|
| HTTP | `GET` |
|
|
675
1047
|
| Path | `/inner/v1/agent-data/economy/interest_rates` |
|
|
676
|
-
| Default provider | `oecd` |
|
|
677
1048
|
| SDK | `supported` |
|
|
678
1049
|
| Host | `supported` |
|
|
679
1050
|
| Notes | - |
|
|
@@ -684,17 +1055,24 @@ Summary: Interest Rates
|
|
|
684
1055
|
|---|---|---|---|---|
|
|
685
1056
|
| `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
1057
|
| `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
|
-
|
|
1058
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
1059
|
+
| `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. |
|
|
1060
|
+
| `frequency` | `no` | `string` | `monthly` | enum: monthly, quarter, annual Frequency to get interest rate for for. |
|
|
1061
|
+
|
|
1062
|
+
#### Response fields
|
|
1063
|
+
|
|
1064
|
+
| Field | Type | Notes |
|
|
1065
|
+
|---|---|---|
|
|
1066
|
+
| `date` | `string` | The date of the data. |
|
|
1067
|
+
| `value` | `number` | The interest rate value. |
|
|
1068
|
+
| `country` | `string` | Country for which the interest rate is given. |
|
|
691
1069
|
|
|
692
1070
|
---
|
|
693
1071
|
|
|
694
1072
|
### `economy.money_measures`
|
|
695
1073
|
|
|
696
1074
|
```python
|
|
697
|
-
data.economy.money_measures(start_time=None, end_time=None, adjusted=True
|
|
1075
|
+
data.economy.money_measures(start_time=None, end_time=None, adjusted=True)
|
|
698
1076
|
```
|
|
699
1077
|
|
|
700
1078
|
Summary: Money Measures
|
|
@@ -704,7 +1082,6 @@ Summary: Money Measures
|
|
|
704
1082
|
| Endpoint ID | `economy.money_measures` |
|
|
705
1083
|
| HTTP | `GET` |
|
|
706
1084
|
| Path | `/inner/v1/agent-data/economy/money_measures` |
|
|
707
|
-
| Default provider | `federal_reserve` |
|
|
708
1085
|
| SDK | `supported` |
|
|
709
1086
|
| Host | `supported` |
|
|
710
1087
|
| Notes | - |
|
|
@@ -716,14 +1093,26 @@ Summary: Money Measures
|
|
|
716
1093
|
| `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
1094
|
| `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
1095
|
| `adjusted` | `no` | `boolean | null` | `true` | Whether to return seasonally adjusted data. |
|
|
719
|
-
|
|
1096
|
+
|
|
1097
|
+
#### Response fields
|
|
1098
|
+
|
|
1099
|
+
| Field | Type | Notes |
|
|
1100
|
+
|---|---|---|
|
|
1101
|
+
| `month` | `string` | The date of the data. |
|
|
1102
|
+
| `m1` | `number` | Value of the M1 money supply in billions. |
|
|
1103
|
+
| `m2` | `number` | Value of the M2 money supply in billions. |
|
|
1104
|
+
| `currency` | `number` | Value of currency in circulation in billions. |
|
|
1105
|
+
| `demand_deposits` | `number` | Value of demand deposits in billions. |
|
|
1106
|
+
| `retail_money_market_funds` | `number` | Value of retail money market funds in billions. |
|
|
1107
|
+
| `other_liquid_deposits` | `number` | Value of other liquid deposits in billions. |
|
|
1108
|
+
| `small_denomination_time_deposits` | `number` | Value of small denomination time deposits in billions. |
|
|
720
1109
|
|
|
721
1110
|
---
|
|
722
1111
|
|
|
723
1112
|
### `economy.pce`
|
|
724
1113
|
|
|
725
1114
|
```python
|
|
726
|
-
data.economy.pce(date=None, category='personal_income'
|
|
1115
|
+
data.economy.pce(date=None, category='personal_income')
|
|
727
1116
|
```
|
|
728
1117
|
|
|
729
1118
|
Summary: Pce
|
|
@@ -733,7 +1122,6 @@ Summary: Pce
|
|
|
733
1122
|
| Endpoint ID | `economy.pce` |
|
|
734
1123
|
| HTTP | `GET` |
|
|
735
1124
|
| Path | `/inner/v1/agent-data/economy/pce` |
|
|
736
|
-
| Default provider | `fred` |
|
|
737
1125
|
| SDK | `supported` |
|
|
738
1126
|
| Host | `supported` |
|
|
739
1127
|
| Notes | - |
|
|
@@ -742,16 +1130,29 @@ Summary: Pce
|
|
|
742
1130
|
|
|
743
1131
|
| Param | Required | Type | Default | Notes |
|
|
744
1132
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1133
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Default is the latest report. Multiple comma separated items allowed |
|
|
1134
|
+
| `category` | `no` | `string` | `personal_income` | The category to query. |
|
|
1135
|
+
|
|
1136
|
+
#### Response fields
|
|
1137
|
+
|
|
1138
|
+
| Field | Type | Notes |
|
|
1139
|
+
|---|---|---|
|
|
1140
|
+
| `date` | `string` | The date of the data. |
|
|
1141
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1142
|
+
| `value` | `number` | value |
|
|
1143
|
+
| `name` | `string` | The name of the series. |
|
|
1144
|
+
| `element_id` | `string` | The element id in the parent/child relationship. |
|
|
1145
|
+
| `parent_id` | `string` | The parent id in the parent/child relationship. |
|
|
1146
|
+
| `children` | `string` | The element_id of each child, as a comma-separated string. |
|
|
1147
|
+
| `level` | `integer` | The indentation level of the element. |
|
|
1148
|
+
| `line` | `integer` | The line number of the series in the table. |
|
|
748
1149
|
|
|
749
1150
|
---
|
|
750
1151
|
|
|
751
1152
|
### `economy.primary_dealer_fails`
|
|
752
1153
|
|
|
753
1154
|
```python
|
|
754
|
-
data.economy.primary_dealer_fails(start_time=None, end_time=None, asset_class='all', unit='value'
|
|
1155
|
+
data.economy.primary_dealer_fails(start_time=None, end_time=None, asset_class='all', unit='value')
|
|
755
1156
|
```
|
|
756
1157
|
|
|
757
1158
|
Summary: Primary Dealer Fails
|
|
@@ -761,7 +1162,6 @@ Summary: Primary Dealer Fails
|
|
|
761
1162
|
| Endpoint ID | `economy.primary_dealer_fails` |
|
|
762
1163
|
| HTTP | `GET` |
|
|
763
1164
|
| Path | `/inner/v1/agent-data/economy/primary_dealer_fails` |
|
|
764
|
-
| Default provider | `federal_reserve` |
|
|
765
1165
|
| SDK | `supported` |
|
|
766
1166
|
| Host | `supported` |
|
|
767
1167
|
| Notes | - |
|
|
@@ -772,16 +1172,24 @@ Summary: Primary Dealer Fails
|
|
|
772
1172
|
|---|---|---|---|---|
|
|
773
1173
|
| `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
1174
|
| `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
|
-
|
|
1175
|
+
| `asset_class` | `no` | `string` | `all` | enum: all, treasuries, tips, agency, mbs, corporate Asset class to return, default is 'all'. |
|
|
1176
|
+
| `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. |
|
|
1177
|
+
|
|
1178
|
+
#### Response fields
|
|
1179
|
+
|
|
1180
|
+
| Field | Type | Notes |
|
|
1181
|
+
|---|---|---|
|
|
1182
|
+
| `date` | `string` | The date of the data. |
|
|
1183
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1184
|
+
| `title` | `string` | Title of the series' symbol. |
|
|
1185
|
+
| `value` | `integer` | Value of the data returned, in millions of USD if the `unit` parameter is 'value' else a normalized percent. |
|
|
778
1186
|
|
|
779
1187
|
---
|
|
780
1188
|
|
|
781
1189
|
### `economy.primary_dealer_positioning`
|
|
782
1190
|
|
|
783
1191
|
```python
|
|
784
|
-
data.economy.primary_dealer_positioning(start_time=None, end_time=None, category='treasuries'
|
|
1192
|
+
data.economy.primary_dealer_positioning(start_time=None, end_time=None, category='treasuries')
|
|
785
1193
|
```
|
|
786
1194
|
|
|
787
1195
|
Summary: Primary Dealer Positioning
|
|
@@ -791,7 +1199,6 @@ Summary: Primary Dealer Positioning
|
|
|
791
1199
|
| Endpoint ID | `economy.primary_dealer_positioning` |
|
|
792
1200
|
| HTTP | `GET` |
|
|
793
1201
|
| Path | `/inner/v1/agent-data/economy/primary_dealer_positioning` |
|
|
794
|
-
| Default provider | `federal_reserve` |
|
|
795
1202
|
| SDK | `supported` |
|
|
796
1203
|
| Host | `supported` |
|
|
797
1204
|
| Notes | - |
|
|
@@ -802,15 +1209,24 @@ Summary: Primary Dealer Positioning
|
|
|
802
1209
|
|---|---|---|---|---|
|
|
803
1210
|
| `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
1211
|
| `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
|
-
|
|
1212
|
+
| `category` | `no` | `string` | `treasuries` | The category of asset to return, defaults to 'treasuries'. |
|
|
1213
|
+
|
|
1214
|
+
#### Response fields
|
|
1215
|
+
|
|
1216
|
+
| Field | Type | Notes |
|
|
1217
|
+
|---|---|---|
|
|
1218
|
+
| `date` | `string` | The date of the data. |
|
|
1219
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1220
|
+
| `value` | `integer` | The reported value of the net position (long - short), in millions of $USD. |
|
|
1221
|
+
| `name` | `string` | Short name for the series. |
|
|
1222
|
+
| `title` | `string` | Title of the series. |
|
|
807
1223
|
|
|
808
1224
|
---
|
|
809
1225
|
|
|
810
1226
|
### `economy.retail_prices`
|
|
811
1227
|
|
|
812
1228
|
```python
|
|
813
|
-
data.economy.retail_prices(start_time=None, end_time=None, item=None, country='united_states', region='all_city', frequency='monthly', transform=None
|
|
1229
|
+
data.economy.retail_prices(start_time=None, end_time=None, item=None, country='united_states', region='all_city', frequency='monthly', transform=None)
|
|
814
1230
|
```
|
|
815
1231
|
|
|
816
1232
|
Summary: Retail Prices
|
|
@@ -820,7 +1236,6 @@ Summary: Retail Prices
|
|
|
820
1236
|
| Endpoint ID | `economy.retail_prices` |
|
|
821
1237
|
| HTTP | `GET` |
|
|
822
1238
|
| Path | `/inner/v1/agent-data/economy/retail_prices` |
|
|
823
|
-
| Default provider | `fred` |
|
|
824
1239
|
| SDK | `supported` |
|
|
825
1240
|
| Host | `supported` |
|
|
826
1241
|
| Notes | - |
|
|
@@ -833,17 +1248,26 @@ Summary: Retail Prices
|
|
|
833
1248
|
| `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
1249
|
| `item` | `no` | `string | null` | `-` | The item or basket of items to query. |
|
|
835
1250
|
| `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
|
-
|
|
1251
|
+
| `region` | `no` | `string` | `all_city` | The region to get average price levels for. |
|
|
1252
|
+
| `frequency` | `no` | `string` | `monthly` | The frequency of the data. |
|
|
1253
|
+
| `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 |
|
|
1254
|
+
|
|
1255
|
+
#### Response fields
|
|
1256
|
+
|
|
1257
|
+
| Field | Type | Notes |
|
|
1258
|
+
|---|---|---|
|
|
1259
|
+
| `date` | `string` | The date of the data. |
|
|
1260
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1261
|
+
| `country` | `string` | country |
|
|
1262
|
+
| `description` | `string` | Description of the item. |
|
|
1263
|
+
| `value` | `number` | Price, or change in price, per unit. |
|
|
840
1264
|
|
|
841
1265
|
---
|
|
842
1266
|
|
|
843
1267
|
### `economy.risk_premium`
|
|
844
1268
|
|
|
845
1269
|
```python
|
|
846
|
-
data.economy.risk_premium(
|
|
1270
|
+
data.economy.risk_premium()
|
|
847
1271
|
```
|
|
848
1272
|
|
|
849
1273
|
Summary: Risk Premium
|
|
@@ -853,7 +1277,6 @@ Summary: Risk Premium
|
|
|
853
1277
|
| Endpoint ID | `economy.risk_premium` |
|
|
854
1278
|
| HTTP | `GET` |
|
|
855
1279
|
| Path | `/inner/v1/agent-data/economy/risk_premium` |
|
|
856
|
-
| Default provider | `fmp` |
|
|
857
1280
|
| SDK | `supported` |
|
|
858
1281
|
| Host | `supported` |
|
|
859
1282
|
| Notes | - |
|
|
@@ -862,14 +1285,22 @@ Summary: Risk Premium
|
|
|
862
1285
|
|
|
863
1286
|
| Param | Required | Type | Default | Notes |
|
|
864
1287
|
|---|---|---|---|---|
|
|
865
|
-
|
|
1288
|
+
|
|
1289
|
+
#### Response fields
|
|
1290
|
+
|
|
1291
|
+
| Field | Type | Notes |
|
|
1292
|
+
|---|---|---|
|
|
1293
|
+
| `country` | `string` | Market country. |
|
|
1294
|
+
| `continent` | `string` | Continent of the country. |
|
|
1295
|
+
| `total_equity_risk_premium` | `number` | Total equity risk premium for the country. |
|
|
1296
|
+
| `country_risk_premium` | `number` | Country-specific risk premium. |
|
|
866
1297
|
|
|
867
1298
|
---
|
|
868
1299
|
|
|
869
1300
|
### `economy.share_price_index`
|
|
870
1301
|
|
|
871
1302
|
```python
|
|
872
|
-
data.economy.share_price_index(start_time=None, end_time=None, country='united_states', frequency='monthly'
|
|
1303
|
+
data.economy.share_price_index(start_time=None, end_time=None, country='united_states', frequency='monthly')
|
|
873
1304
|
```
|
|
874
1305
|
|
|
875
1306
|
Summary: Share Price Index
|
|
@@ -879,7 +1310,6 @@ Summary: Share Price Index
|
|
|
879
1310
|
| Endpoint ID | `economy.share_price_index` |
|
|
880
1311
|
| HTTP | `GET` |
|
|
881
1312
|
| Path | `/inner/v1/agent-data/economy/share_price_index` |
|
|
882
|
-
| Default provider | `oecd` |
|
|
883
1313
|
| SDK | `supported` |
|
|
884
1314
|
| Host | `supported` |
|
|
885
1315
|
| Notes | - |
|
|
@@ -890,16 +1320,23 @@ Summary: Share Price Index
|
|
|
890
1320
|
|---|---|---|---|---|
|
|
891
1321
|
| `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
1322
|
| `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
|
|
1323
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
894
1324
|
| `frequency` | `no` | `string` | `monthly` | The frequency of the data. |
|
|
895
|
-
|
|
1325
|
+
|
|
1326
|
+
#### Response fields
|
|
1327
|
+
|
|
1328
|
+
| Field | Type | Notes |
|
|
1329
|
+
|---|---|---|
|
|
1330
|
+
| `date` | `string` | The date of the data. |
|
|
1331
|
+
| `country` | `string` | country |
|
|
1332
|
+
| `value` | `number` | Share price index value. |
|
|
896
1333
|
|
|
897
1334
|
---
|
|
898
1335
|
|
|
899
1336
|
### `economy.shipping.chokepoint_info`
|
|
900
1337
|
|
|
901
1338
|
```python
|
|
902
|
-
data.economy.shipping.chokepoint_info(theme=None
|
|
1339
|
+
data.economy.shipping.chokepoint_info(theme=None)
|
|
903
1340
|
```
|
|
904
1341
|
|
|
905
1342
|
Summary: Chokepoint Info
|
|
@@ -909,7 +1346,6 @@ Summary: Chokepoint Info
|
|
|
909
1346
|
| Endpoint ID | `economy.shipping.chokepoint_info` |
|
|
910
1347
|
| HTTP | `GET` |
|
|
911
1348
|
| Path | `/inner/v1/agent-data/economy/shipping/chokepoint_info` |
|
|
912
|
-
| Default provider | `imf` |
|
|
913
1349
|
| SDK | `supported` |
|
|
914
1350
|
| Host | `supported` |
|
|
915
1351
|
| Notes | - |
|
|
@@ -918,15 +1354,32 @@ Summary: Chokepoint Info
|
|
|
918
1354
|
|
|
919
1355
|
| Param | Required | Type | Default | Notes |
|
|
920
1356
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1357
|
+
| `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'. |
|
|
1358
|
+
|
|
1359
|
+
#### Response fields
|
|
1360
|
+
|
|
1361
|
+
| Field | Type | Notes |
|
|
1362
|
+
|---|---|---|
|
|
1363
|
+
| `chokepoint_code` | `string` | Unique ID assigned to the chokepoint by the source. |
|
|
1364
|
+
| `name` | `string` | Port name. |
|
|
1365
|
+
| `latitude` | `number` | Latitude of the chokepoint location. |
|
|
1366
|
+
| `longitude` | `number` | Longitude of the chokepoint location. |
|
|
1367
|
+
| `vessel_count_total` | `integer` | Yearly average number of all ships transiting through the chokepoint. |
|
|
1368
|
+
| `vessel_count_tanker` | `integer` | Yearly average number of tankers transiting through the chokepoint. |
|
|
1369
|
+
| `vessel_count_container` | `integer` | Yearly average number of containers transiting through the chokepoint. |
|
|
1370
|
+
| `vessel_count_general_cargo` | `integer` | Yearly average number of general cargo ships transiting through the chokepoint. |
|
|
1371
|
+
| `vessel_count_dry_bulk` | `integer` | Yearly average number of dry bulk carriers transiting through the chokepoint. |
|
|
1372
|
+
| `vessel_count_roro` | `integer` | Yearly average number of Ro-Ro ships transiting through the chokepoint. |
|
|
1373
|
+
| `industry_top_1` | `string` | First dominant traded industries based on the volume of goods estimated to flow through the chokepoint. |
|
|
1374
|
+
| `industry_top_2` | `string` | Second dominant traded industries based on the volume of goods estimated to flow through the chokepoint. |
|
|
1375
|
+
| `industry_top_3` | `string` | Third dominant traded industries based on the volume of goods estimated to flow through the chokepoint. |
|
|
923
1376
|
|
|
924
1377
|
---
|
|
925
1378
|
|
|
926
1379
|
### `economy.shipping.chokepoint_volume`
|
|
927
1380
|
|
|
928
1381
|
```python
|
|
929
|
-
data.economy.shipping.chokepoint_volume(start_time=None, end_time=None, chokepoint=None
|
|
1382
|
+
data.economy.shipping.chokepoint_volume(start_time=None, end_time=None, chokepoint=None)
|
|
930
1383
|
```
|
|
931
1384
|
|
|
932
1385
|
Summary: Chokepoint Volume
|
|
@@ -936,7 +1389,6 @@ Summary: Chokepoint Volume
|
|
|
936
1389
|
| Endpoint ID | `economy.shipping.chokepoint_volume` |
|
|
937
1390
|
| HTTP | `GET` |
|
|
938
1391
|
| Path | `/inner/v1/agent-data/economy/shipping/chokepoint_volume` |
|
|
939
|
-
| Default provider | `imf` |
|
|
940
1392
|
| SDK | `supported` |
|
|
941
1393
|
| Host | `supported` |
|
|
942
1394
|
| Notes | - |
|
|
@@ -947,15 +1399,35 @@ Summary: Chokepoint Volume
|
|
|
947
1399
|
|---|---|---|---|---|
|
|
948
1400
|
| `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
1401
|
| `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
|
-
|
|
1402
|
+
| `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. |
|
|
1403
|
+
|
|
1404
|
+
#### Response fields
|
|
1405
|
+
|
|
1406
|
+
| Field | Type | Notes |
|
|
1407
|
+
|---|---|---|
|
|
1408
|
+
| `date` | `string` | The date of the data. |
|
|
1409
|
+
| `chokepoint` | `string` | Name of the chokepoint. |
|
|
1410
|
+
| `vessels_total` | `integer` | Number of all ships transiting through the chokepoint on that date. |
|
|
1411
|
+
| `vessels_cargo` | `integer` | Total number of ships (excluding tankers) transiting through the chokepoint at this date. |
|
|
1412
|
+
| `vessels_tanker` | `integer` | Number of tankers transiting through the chokepoint on that date. |
|
|
1413
|
+
| `vessels_container` | `integer` | Number of containers transiting through the chokepoint on that date. |
|
|
1414
|
+
| `vessels_general_cargo` | `integer` | Number of general cargo ships transiting through the chokepoint on that date. |
|
|
1415
|
+
| `vessels_dry_bulk` | `integer` | Yearly average number of dry bulk carriers transiting through the chokepoint. |
|
|
1416
|
+
| `vessels_roro` | `integer` | Yearly average number of Ro-Ro ships transiting through the chokepoint. |
|
|
1417
|
+
| `capacity_total` | `number` | Total trade volume (in metric tons) of all ships transiting through the chokepoint at this date. |
|
|
1418
|
+
| `capacity_cargo` | `number` | Total trade volume (in metric tons) of all ships (excluding tankers) transiting through the chokepoint at this date. |
|
|
1419
|
+
| `capacity_tanker` | `number` | Total trade volume (in metric tons) of tankers transiting through the chokepoint at this date. |
|
|
1420
|
+
| `capacity_container` | `number` | Total trade volume (in metric tons) of containers transiting through the chokepoint at this date. |
|
|
1421
|
+
| `capacity_general_cargo` | `number` | Total trade volume (in metric tons) of general cargo Vessels transiting through the chokepoint at this date. |
|
|
1422
|
+
| `capacity_dry_bulk` | `number` | Total trade volume (in metric tons) of dry bulk carriers transiting through the chokepoint at this date. |
|
|
1423
|
+
| `capacity_roro` | `number` | Total trade volume (in metric tons) of Ro-Ro ships transiting through the chokepoint at this date. |
|
|
952
1424
|
|
|
953
1425
|
---
|
|
954
1426
|
|
|
955
1427
|
### `economy.shipping.port_info`
|
|
956
1428
|
|
|
957
1429
|
```python
|
|
958
|
-
data.economy.shipping.port_info(continent=None, country=None, port_code=None, limit=None
|
|
1430
|
+
data.economy.shipping.port_info(continent=None, country=None, port_code=None, limit=None)
|
|
959
1431
|
```
|
|
960
1432
|
|
|
961
1433
|
Summary: Port Info
|
|
@@ -965,7 +1437,6 @@ Summary: Port Info
|
|
|
965
1437
|
| Endpoint ID | `economy.shipping.port_info` |
|
|
966
1438
|
| HTTP | `GET` |
|
|
967
1439
|
| Path | `/inner/v1/agent-data/economy/shipping/port_info` |
|
|
968
|
-
| Default provider | `imf` |
|
|
969
1440
|
| SDK | `supported` |
|
|
970
1441
|
| Host | `supported` |
|
|
971
1442
|
| Notes | - |
|
|
@@ -974,18 +1445,41 @@ Summary: Port Info
|
|
|
974
1445
|
|
|
975
1446
|
| Param | Required | Type | Default | Notes |
|
|
976
1447
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1448
|
+
| `continent` | `no` | `string | null` | `-` | Filter by continent. This parameter is ignored when a `country` is provided. |
|
|
1449
|
+
| `country` | `no` | `string | null` | `-` | Country to focus on. Enter as a 3-letter ISO country code. This parameter supersedes `continent` if both are provided. |
|
|
1450
|
+
| `port_code` | `no` | `string | null` | `-` | This is a dummy parameter to allow grouping in OpenBB Workspace widgets. |
|
|
1451
|
+
| `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. |
|
|
1452
|
+
|
|
1453
|
+
#### Response fields
|
|
1454
|
+
|
|
1455
|
+
| Field | Type | Notes |
|
|
1456
|
+
|---|---|---|
|
|
1457
|
+
| `port_code` | `string` | Unique ID assigned to the port. |
|
|
1458
|
+
| `continent` | `string` | Continent where the port is located. |
|
|
1459
|
+
| `country` | `string` | Country where the port is located. |
|
|
1460
|
+
| `country_code` | `string` | 3-letter ISO code of the country where the port is located. |
|
|
1461
|
+
| `port_name` | `string` | Port name. |
|
|
1462
|
+
| `port_full_name` | `string` | Full name of the port. |
|
|
1463
|
+
| `latitude` | `number` | Latitude of the port. |
|
|
1464
|
+
| `longitude` | `number` | Longitude of the port. |
|
|
1465
|
+
| `vessel_count_total` | `integer` | Yearly average number of all ships transiting through the port. |
|
|
1466
|
+
| `vessel_count_tanker` | `integer` | Yearly average number of tankers transiting through the port. |
|
|
1467
|
+
| `vessel_count_container` | `integer` | Yearly average number of containers transiting through the port. |
|
|
1468
|
+
| `vessel_count_general_cargo` | `integer` | Yearly average number of general cargo ships transiting through the port. |
|
|
1469
|
+
| `vessel_count_dry_bulk` | `integer` | Yearly average number of dry bulk carriers transiting through the port. |
|
|
1470
|
+
| `vessel_count_roro` | `integer` | Yearly average number of Ro-Ro ships transiting through the port. |
|
|
1471
|
+
| `industry_top_1` | `string` | First dominant traded industries based on the volume of goods estimated to flow through the port. |
|
|
1472
|
+
| `industry_top_2` | `string` | Second dominant traded industries based on the volume of goods estimated to flow through the port. |
|
|
1473
|
+
| `industry_top_3` | `string` | Third dominant traded industries based on the volume of goods estimated to flow through the port. |
|
|
1474
|
+
| `share_country_maritime_import` | `number` | Share of the total maritime imports of the country that are estimated to flow through the port. |
|
|
1475
|
+
| `share_country_maritime_export` | `number` | Share of the total maritime exports of the country that are estimated to flow through the port. |
|
|
982
1476
|
|
|
983
1477
|
---
|
|
984
1478
|
|
|
985
1479
|
### `economy.shipping.port_volume`
|
|
986
1480
|
|
|
987
1481
|
```python
|
|
988
|
-
data.economy.shipping.port_volume(start_time=None, end_time=None, port_code=None, country=None
|
|
1482
|
+
data.economy.shipping.port_volume(start_time=None, end_time=None, port_code=None, country=None)
|
|
989
1483
|
```
|
|
990
1484
|
|
|
991
1485
|
Summary: Port Volume
|
|
@@ -995,7 +1489,6 @@ Summary: Port Volume
|
|
|
995
1489
|
| Endpoint ID | `economy.shipping.port_volume` |
|
|
996
1490
|
| HTTP | `GET` |
|
|
997
1491
|
| Path | `/inner/v1/agent-data/economy/shipping/port_volume` |
|
|
998
|
-
| Default provider | - |
|
|
999
1492
|
| SDK | `supported` |
|
|
1000
1493
|
| Host | `supported` |
|
|
1001
1494
|
| Notes | - |
|
|
@@ -1006,16 +1499,49 @@ Summary: Port Volume
|
|
|
1006
1499
|
|---|---|---|---|---|
|
|
1007
1500
|
| `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
1501
|
| `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
|
-
|
|
1502
|
+
| `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. |
|
|
1503
|
+
| `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. |
|
|
1504
|
+
|
|
1505
|
+
#### Response fields
|
|
1506
|
+
|
|
1507
|
+
| Field | Type | Notes |
|
|
1508
|
+
|---|---|---|
|
|
1509
|
+
| `date` | `string` | The date of the data. |
|
|
1510
|
+
| `port_code` | `string` | Port code. |
|
|
1511
|
+
| `port_name` | `string` | Port name. |
|
|
1512
|
+
| `country` | `string` | Country where the port is located. |
|
|
1513
|
+
| `country_code` | `string` | 3-letter ISO country code of the country where the port is located. |
|
|
1514
|
+
| `portcalls` | `integer` | Total number of ships entering the port at this date. |
|
|
1515
|
+
| `portcalls_tanker` | `integer` | Number of tankers transiting through the chokepoint or making a port call. |
|
|
1516
|
+
| `portcalls_container` | `integer` | Number of containers transiting through the chokepoint or making a port call. |
|
|
1517
|
+
| `portcalls_general_cargo` | `integer` | Number of general cargo ships transiting through the chokepoint or making a port call. |
|
|
1518
|
+
| `portcalls_dry_bulk` | `integer` | Number of dry bulk carriers transiting through the chokepoint or making a port call. |
|
|
1519
|
+
| `portcalls_roro` | `integer` | Number of Ro-Ro ships transiting through the chokepoint or making a port call. |
|
|
1520
|
+
| `imports` | `number` | Total import volume (in metric tons) of all ships entering the port at this date. |
|
|
1521
|
+
| `imports_cargo` | `number` | Total import volume (in metric tons) of all ships (excluding tankers) entering the port at this date. |
|
|
1522
|
+
| `imports_tanker` | `number` | Total import volume (in metric tons) of tankers entering the port at this date. |
|
|
1523
|
+
| `imports_container` | `number` | Total import volume (in metric tons) of all container ships entering the port at this date. |
|
|
1524
|
+
| `imports_general_cargo` | `number` | Total import volume (in metric tons) of general cargo ships entering the port at this date. |
|
|
1525
|
+
| `imports_dry_bulk` | `number` | Total import volume (in metric tons) of dry bulk carriers entering the port at this date. |
|
|
1526
|
+
| `imports_roro` | `number` | Total import volume (in metric tons) of Ro-Ro ships entering the port at this date. |
|
|
1527
|
+
| `exports` | `number` | Total export volume (in metric tons) of all ships entering the port at this date. |
|
|
1528
|
+
| `exports_cargo` | `number` | Total export volume (in metric tons) of all ships (excluding tankers) entering the port at this date. |
|
|
1529
|
+
| `exports_tanker` | `number` | Total export volume (in metric tons) of tankers entering the port at this date. |
|
|
1530
|
+
| `exports_container` | `number` | Total export volume (in metric tons) of all container ships entering the port at this date. |
|
|
1531
|
+
| `exports_general_cargo` | `number` | Total export volume (in metric tons) of general cargo ships entering the port at this date. |
|
|
1532
|
+
| `exports_dry_bulk` | `number` | Total export volume (in metric tons) of dry bulk carriers entering the port at this date. |
|
|
1533
|
+
| `exports_roro` | `number` | Total export volume (in metric tons) of Ro-Ro ships entering the port at this date. |
|
|
1534
|
+
| `export_dwell_time` | `number` | EconDB model estimate for the average number of days from when a container enters the terminal gates until it is loaded on a vessel. |
|
|
1535
|
+
| `import_dwell_time` | `number` | EconDB model estimate for the average number of days from when a container is discharged from a vessel until it exits the terminal gates. |
|
|
1536
|
+
| `import_teu` | `integer` | EconDB model estimate for the number of TEUs of containers imported through the port. |
|
|
1537
|
+
| `export_teu` | `integer` | EconDB model estimate for the number of TEUs of containers exported through the port. |
|
|
1012
1538
|
|
|
1013
1539
|
---
|
|
1014
1540
|
|
|
1015
1541
|
### `economy.survey.bls_search`
|
|
1016
1542
|
|
|
1017
1543
|
```python
|
|
1018
|
-
data.economy.survey.bls_search(query='', category=None, include_extras=False, include_code_map=False
|
|
1544
|
+
data.economy.survey.bls_search(query='', category=None, include_extras=False, include_code_map=False)
|
|
1019
1545
|
```
|
|
1020
1546
|
|
|
1021
1547
|
Summary: Bls Search
|
|
@@ -1025,7 +1551,6 @@ Summary: Bls Search
|
|
|
1025
1551
|
| Endpoint ID | `economy.survey.bls_search` |
|
|
1026
1552
|
| HTTP | `GET` |
|
|
1027
1553
|
| Path | `/inner/v1/agent-data/economy/survey/bls_search` |
|
|
1028
|
-
| Default provider | `bls` |
|
|
1029
1554
|
| SDK | `supported` |
|
|
1030
1555
|
| Host | `supported` |
|
|
1031
1556
|
| Notes | - |
|
|
@@ -1035,17 +1560,24 @@ Summary: Bls Search
|
|
|
1035
1560
|
| Param | Required | Type | Default | Notes |
|
|
1036
1561
|
|---|---|---|---|---|
|
|
1037
1562
|
| `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
|
-
|
|
1563
|
+
| `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 |
|
|
1564
|
+
| `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'. |
|
|
1565
|
+
| `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. |
|
|
1566
|
+
|
|
1567
|
+
#### Response fields
|
|
1568
|
+
|
|
1569
|
+
| Field | Type | Notes |
|
|
1570
|
+
|---|---|---|
|
|
1571
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1572
|
+
| `title` | `string` | The title of the series. |
|
|
1573
|
+
| `survey_name` | `string` | The name of the survey. |
|
|
1042
1574
|
|
|
1043
1575
|
---
|
|
1044
1576
|
|
|
1045
1577
|
### `economy.survey.bls_series`
|
|
1046
1578
|
|
|
1047
1579
|
```python
|
|
1048
|
-
data.economy.survey.bls_series(symbol=..., start_time=None, end_time=None, calculations=True, annual_average=False, aspects=False
|
|
1580
|
+
data.economy.survey.bls_series(symbol=..., start_time=None, end_time=None, calculations=True, annual_average=False, aspects=False)
|
|
1049
1581
|
```
|
|
1050
1582
|
|
|
1051
1583
|
Summary: Bls Series
|
|
@@ -1055,7 +1587,6 @@ Summary: Bls Series
|
|
|
1055
1587
|
| Endpoint ID | `economy.survey.bls_series` |
|
|
1056
1588
|
| HTTP | `GET` |
|
|
1057
1589
|
| Path | `/inner/v1/agent-data/economy/survey/bls_series` |
|
|
1058
|
-
| Default provider | `bls` |
|
|
1059
1590
|
| SDK | `supported` |
|
|
1060
1591
|
| Host | `supported` |
|
|
1061
1592
|
| Notes | - |
|
|
@@ -1064,20 +1595,38 @@ Summary: Bls Series
|
|
|
1064
1595
|
|
|
1065
1596
|
| Param | Required | Type | Default | Notes |
|
|
1066
1597
|
|---|---|---|---|---|
|
|
1067
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
1598
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
1068
1599
|
| `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
1600
|
| `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
|
-
|
|
1601
|
+
| `calculations` | `no` | `boolean` | `true` | Include calculations in the response, if available. Default is True. |
|
|
1602
|
+
| `annual_average` | `no` | `boolean` | `false` | Include annual averages in the response, if available. Default is False. |
|
|
1603
|
+
| `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. |
|
|
1604
|
+
|
|
1605
|
+
#### Response fields
|
|
1606
|
+
|
|
1607
|
+
| Field | Type | Notes |
|
|
1608
|
+
|---|---|---|
|
|
1609
|
+
| `date` | `string` | The date of the data. |
|
|
1610
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1611
|
+
| `title` | `string` | Title of the series. |
|
|
1612
|
+
| `value` | `number` | Observation value for the symbol and date. |
|
|
1613
|
+
| `change_1_m` | `number` | One month change in value. |
|
|
1614
|
+
| `change_3_m` | `number` | Three month change in value. |
|
|
1615
|
+
| `change_6_m` | `number` | Six month change in value. |
|
|
1616
|
+
| `change_12_m` | `number` | One year change in value. |
|
|
1617
|
+
| `change_percent_1_m` | `number` | One month change in percent. |
|
|
1618
|
+
| `change_percent_3_m` | `number` | Three month change in percent. |
|
|
1619
|
+
| `change_percent_6_m` | `number` | Six month change in percent. |
|
|
1620
|
+
| `change_percent_12_m` | `number` | One year change in percent. |
|
|
1621
|
+
| `latest` | `boolean` | Latest value indicator. |
|
|
1622
|
+
| `footnotes` | `string` | Footnotes accompanying the value. |
|
|
1074
1623
|
|
|
1075
1624
|
---
|
|
1076
1625
|
|
|
1077
1626
|
### `economy.survey.economic_conditions_chicago`
|
|
1078
1627
|
|
|
1079
1628
|
```python
|
|
1080
|
-
data.economy.survey.economic_conditions_chicago(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None
|
|
1629
|
+
data.economy.survey.economic_conditions_chicago(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
|
|
1081
1630
|
```
|
|
1082
1631
|
|
|
1083
1632
|
Summary: Economic Conditions Chicago
|
|
@@ -1087,7 +1636,6 @@ Summary: Economic Conditions Chicago
|
|
|
1087
1636
|
| Endpoint ID | `economy.survey.economic_conditions_chicago` |
|
|
1088
1637
|
| HTTP | `GET` |
|
|
1089
1638
|
| Path | `/inner/v1/agent-data/economy/survey/economic_conditions_chicago` |
|
|
1090
|
-
| Default provider | `fred` |
|
|
1091
1639
|
| SDK | `supported` |
|
|
1092
1640
|
| Host | `supported` |
|
|
1093
1641
|
| Notes | - |
|
|
@@ -1098,17 +1646,31 @@ Summary: Economic Conditions Chicago
|
|
|
1098
1646
|
|---|---|---|---|---|
|
|
1099
1647
|
| `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
1648
|
| `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
|
-
|
|
1649
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1650
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1651
|
+
| `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 |
|
|
1652
|
+
|
|
1653
|
+
#### Response fields
|
|
1654
|
+
|
|
1655
|
+
| Field | Type | Notes |
|
|
1656
|
+
|---|---|---|
|
|
1657
|
+
| `date` | `string` | The date of the data. |
|
|
1658
|
+
| `activity_index` | `number` | Activity Index. |
|
|
1659
|
+
| `one_year_outlook` | `number` | One Year Outlook Index. |
|
|
1660
|
+
| `manufacturing_activity` | `number` | Manufacturing Activity Index. |
|
|
1661
|
+
| `non_manufacturing_activity` | `number` | Non-Manufacturing Activity Index. |
|
|
1662
|
+
| `capital_expenditures_expectations` | `number` | Capital Expenditures Expectations Index. |
|
|
1663
|
+
| `hiring_expectations` | `number` | Hiring Expectations Index. |
|
|
1664
|
+
| `current_hiring` | `number` | Current Hiring Index. |
|
|
1665
|
+
| `labor_costs` | `number` | Labor Costs Index. |
|
|
1666
|
+
| `non_labor_costs` | `number` | Non-Labor Costs Index. |
|
|
1105
1667
|
|
|
1106
1668
|
---
|
|
1107
1669
|
|
|
1108
1670
|
### `economy.survey.inflation_expectations`
|
|
1109
1671
|
|
|
1110
1672
|
```python
|
|
1111
|
-
data.economy.survey.inflation_expectations(start_date=None, end_date=None
|
|
1673
|
+
data.economy.survey.inflation_expectations(start_date=None, end_date=None)
|
|
1112
1674
|
```
|
|
1113
1675
|
|
|
1114
1676
|
Summary: Inflation Expectations
|
|
@@ -1118,7 +1680,6 @@ Summary: Inflation Expectations
|
|
|
1118
1680
|
| Endpoint ID | `economy.survey.inflation_expectations` |
|
|
1119
1681
|
| HTTP | `GET` |
|
|
1120
1682
|
| Path | `/inner/v1/agent-data/economy/survey/inflation_expectations` |
|
|
1121
|
-
| Default provider | `federal_reserve` |
|
|
1122
1683
|
| SDK | `supported` |
|
|
1123
1684
|
| Host | `supported` |
|
|
1124
1685
|
| Notes | - |
|
|
@@ -1127,16 +1688,24 @@ Summary: Inflation Expectations
|
|
|
1127
1688
|
|
|
1128
1689
|
| Param | Required | Type | Default | Notes |
|
|
1129
1690
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1691
|
+
| `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Data begins from 1970-04-01 and is quarterly. |
|
|
1692
|
+
| `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. |
|
|
1693
|
+
|
|
1694
|
+
#### Response fields
|
|
1695
|
+
|
|
1696
|
+
| Field | Type | Notes |
|
|
1697
|
+
|---|---|---|
|
|
1698
|
+
| `date` | `string` | The date of the survey (first day of the survey quarter). |
|
|
1699
|
+
| `infpgdp1yr` | `number` | One-year-ahead annual-average GDP price index inflation forecast. |
|
|
1700
|
+
| `infcpi1yr` | `number` | One-year-ahead annual-average CPI inflation forecast. |
|
|
1701
|
+
| `infcpi10yr` | `number` | Ten-year-ahead annual-average CPI inflation forecast. |
|
|
1133
1702
|
|
|
1134
1703
|
---
|
|
1135
1704
|
|
|
1136
1705
|
### `economy.survey.manufacturing_outlook_ny`
|
|
1137
1706
|
|
|
1138
1707
|
```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
|
|
1708
|
+
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
1709
|
```
|
|
1141
1710
|
|
|
1142
1711
|
Summary: Manufacturing Outlook Ny
|
|
@@ -1146,7 +1715,6 @@ Summary: Manufacturing Outlook Ny
|
|
|
1146
1715
|
| Endpoint ID | `economy.survey.manufacturing_outlook_ny` |
|
|
1147
1716
|
| HTTP | `GET` |
|
|
1148
1717
|
| Path | `/inner/v1/agent-data/economy/survey/manufacturing_outlook_ny` |
|
|
1149
|
-
| Default provider | `fred` |
|
|
1150
1718
|
| SDK | `supported` |
|
|
1151
1719
|
| Host | `supported` |
|
|
1152
1720
|
| Notes | - |
|
|
@@ -1157,19 +1725,29 @@ Summary: Manufacturing Outlook Ny
|
|
|
1157
1725
|
|---|---|---|---|---|
|
|
1158
1726
|
| `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
1727
|
| `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
|
-
|
|
1728
|
+
| `topic` | `no` | `string` | `new_orders` | The topic for the survey response. Multiple comma separated items allowed. |
|
|
1729
|
+
| `seasonally_adjusted` | `no` | `boolean` | `false` | Whether the data is seasonally adjusted, default is False |
|
|
1730
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1731
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1732
|
+
| `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 |
|
|
1733
|
+
|
|
1734
|
+
#### Response fields
|
|
1735
|
+
|
|
1736
|
+
| Field | Type | Notes |
|
|
1737
|
+
|---|---|---|
|
|
1738
|
+
| `date` | `string` | The date of the data. |
|
|
1739
|
+
| `topic` | `string` | Topic of the survey response. |
|
|
1740
|
+
| `diffusion_index` | `number` | Diffusion Index. |
|
|
1741
|
+
| `percent_reporting_increase` | `number` | Percent of respondents reporting an increase over the last month. |
|
|
1742
|
+
| `percent_reporting_decrease` | `number` | Percent of respondents reporting a decrease over the last month. |
|
|
1743
|
+
| `percent_reporting_no_change` | `number` | Percent of respondents reporting no change over the last month. |
|
|
1166
1744
|
|
|
1167
1745
|
---
|
|
1168
1746
|
|
|
1169
1747
|
### `economy.survey.manufacturing_outlook_texas`
|
|
1170
1748
|
|
|
1171
1749
|
```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
|
|
1750
|
+
data.economy.survey.manufacturing_outlook_texas(start_time=None, end_time=None, topic='new_orders_growth', frequency=None, aggregation_method=None, transform=None)
|
|
1173
1751
|
```
|
|
1174
1752
|
|
|
1175
1753
|
Summary: Manufacturing Outlook Texas
|
|
@@ -1179,7 +1757,6 @@ Summary: Manufacturing Outlook Texas
|
|
|
1179
1757
|
| Endpoint ID | `economy.survey.manufacturing_outlook_texas` |
|
|
1180
1758
|
| HTTP | `GET` |
|
|
1181
1759
|
| Path | `/inner/v1/agent-data/economy/survey/manufacturing_outlook_texas` |
|
|
1182
|
-
| Default provider | `fred` |
|
|
1183
1760
|
| SDK | `supported` |
|
|
1184
1761
|
| Host | `supported` |
|
|
1185
1762
|
| Notes | - |
|
|
@@ -1190,18 +1767,28 @@ Summary: Manufacturing Outlook Texas
|
|
|
1190
1767
|
|---|---|---|---|---|
|
|
1191
1768
|
| `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
1769
|
| `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
|
-
|
|
1770
|
+
| `topic` | `no` | `string` | `new_orders_growth` | The topic for the survey response. Multiple comma separated items allowed. |
|
|
1771
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1772
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1773
|
+
| `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 |
|
|
1774
|
+
|
|
1775
|
+
#### Response fields
|
|
1776
|
+
|
|
1777
|
+
| Field | Type | Notes |
|
|
1778
|
+
|---|---|---|
|
|
1779
|
+
| `date` | `string` | The date of the data. |
|
|
1780
|
+
| `topic` | `string` | Topic of the survey response. |
|
|
1781
|
+
| `diffusion_index` | `number` | Diffusion Index. |
|
|
1782
|
+
| `percent_reporting_increase` | `number` | Percent of respondents reporting an increase over the last month. |
|
|
1783
|
+
| `percent_reporting_decrease` | `number` | Percent of respondents reporting a decrease over the last month. |
|
|
1784
|
+
| `percent_reporting_no_change` | `number` | Percent of respondents reporting no change over the last month. |
|
|
1198
1785
|
|
|
1199
1786
|
---
|
|
1200
1787
|
|
|
1201
1788
|
### `economy.survey.nonfarm_payrolls`
|
|
1202
1789
|
|
|
1203
1790
|
```python
|
|
1204
|
-
data.economy.survey.nonfarm_payrolls(date=None, category='employees_nsa'
|
|
1791
|
+
data.economy.survey.nonfarm_payrolls(date=None, category='employees_nsa')
|
|
1205
1792
|
```
|
|
1206
1793
|
|
|
1207
1794
|
Summary: Nonfarm Payrolls
|
|
@@ -1211,7 +1798,6 @@ Summary: Nonfarm Payrolls
|
|
|
1211
1798
|
| Endpoint ID | `economy.survey.nonfarm_payrolls` |
|
|
1212
1799
|
| HTTP | `GET` |
|
|
1213
1800
|
| Path | `/inner/v1/agent-data/economy/survey/nonfarm_payrolls` |
|
|
1214
|
-
| Default provider | `fred` |
|
|
1215
1801
|
| SDK | `supported` |
|
|
1216
1802
|
| Host | `supported` |
|
|
1217
1803
|
| Notes | - |
|
|
@@ -1220,16 +1806,28 @@ Summary: Nonfarm Payrolls
|
|
|
1220
1806
|
|
|
1221
1807
|
| Param | Required | Type | Default | Notes |
|
|
1222
1808
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1809
|
+
| `date` | `no` | `string | null` | `-` | A specific date to get data for. Default is the latest report. Multiple comma separated items allowed |
|
|
1810
|
+
| `category` | `no` | `string` | `employees_nsa` | The category to query. |
|
|
1811
|
+
|
|
1812
|
+
#### Response fields
|
|
1813
|
+
|
|
1814
|
+
| Field | Type | Notes |
|
|
1815
|
+
|---|---|---|
|
|
1816
|
+
| `date` | `string` | The date of the data. |
|
|
1817
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1818
|
+
| `value` | `number` | value |
|
|
1819
|
+
| `name` | `string` | The name of the series. |
|
|
1820
|
+
| `element_id` | `string` | The element id in the parent/child relationship. |
|
|
1821
|
+
| `parent_id` | `string` | The parent id in the parent/child relationship. |
|
|
1822
|
+
| `children` | `string` | The element_id of each child, as a comma-separated string. |
|
|
1823
|
+
| `level` | `integer` | The indentation level of the element. |
|
|
1226
1824
|
|
|
1227
1825
|
---
|
|
1228
1826
|
|
|
1229
1827
|
### `economy.survey.sloos`
|
|
1230
1828
|
|
|
1231
1829
|
```python
|
|
1232
|
-
data.economy.survey.sloos(start_time=None, end_time=None, category='spreads', transform=None
|
|
1830
|
+
data.economy.survey.sloos(start_time=None, end_time=None, category='spreads', transform=None)
|
|
1233
1831
|
```
|
|
1234
1832
|
|
|
1235
1833
|
Summary: Sloos
|
|
@@ -1239,7 +1837,6 @@ Summary: Sloos
|
|
|
1239
1837
|
| Endpoint ID | `economy.survey.sloos` |
|
|
1240
1838
|
| HTTP | `GET` |
|
|
1241
1839
|
| Path | `/inner/v1/agent-data/economy/survey/sloos` |
|
|
1242
|
-
| Default provider | `fred` |
|
|
1243
1840
|
| SDK | `supported` |
|
|
1244
1841
|
| Host | `supported` |
|
|
1245
1842
|
| Notes | - |
|
|
@@ -1250,16 +1847,24 @@ Summary: Sloos
|
|
|
1250
1847
|
|---|---|---|---|---|
|
|
1251
1848
|
| `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
1849
|
| `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
|
-
|
|
1850
|
+
| `category` | `no` | `string` | `spreads` | Category of survey response. |
|
|
1851
|
+
| `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 |
|
|
1852
|
+
|
|
1853
|
+
#### Response fields
|
|
1854
|
+
|
|
1855
|
+
| Field | Type | Notes |
|
|
1856
|
+
|---|---|---|
|
|
1857
|
+
| `date` | `string` | The date of the data. |
|
|
1858
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1859
|
+
| `value` | `number` | Survey value. |
|
|
1860
|
+
| `title` | `string` | Survey title. |
|
|
1256
1861
|
|
|
1257
1862
|
---
|
|
1258
1863
|
|
|
1259
1864
|
### `economy.survey.university_of_michigan`
|
|
1260
1865
|
|
|
1261
1866
|
```python
|
|
1262
|
-
data.economy.survey.university_of_michigan(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None
|
|
1867
|
+
data.economy.survey.university_of_michigan(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
|
|
1263
1868
|
```
|
|
1264
1869
|
|
|
1265
1870
|
Summary: University Of Michigan
|
|
@@ -1269,7 +1874,6 @@ Summary: University Of Michigan
|
|
|
1269
1874
|
| Endpoint ID | `economy.survey.university_of_michigan` |
|
|
1270
1875
|
| HTTP | `GET` |
|
|
1271
1876
|
| Path | `/inner/v1/agent-data/economy/survey/university_of_michigan` |
|
|
1272
|
-
| Default provider | `fred` |
|
|
1273
1877
|
| SDK | `supported` |
|
|
1274
1878
|
| Host | `supported` |
|
|
1275
1879
|
| Notes | - |
|
|
@@ -1280,17 +1884,24 @@ Summary: University Of Michigan
|
|
|
1280
1884
|
|---|---|---|---|---|
|
|
1281
1885
|
| `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
1886
|
| `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
|
-
|
|
1887
|
+
| `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert monthly data to lower frequency. None is monthly. |
|
|
1888
|
+
| `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
|
|
1889
|
+
| `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 |
|
|
1890
|
+
|
|
1891
|
+
#### Response fields
|
|
1892
|
+
|
|
1893
|
+
| Field | Type | Notes |
|
|
1894
|
+
|---|---|---|
|
|
1895
|
+
| `date` | `string` | The date of the data. |
|
|
1896
|
+
| `consumer_sentiment` | `number` | Index of the results of the University of Michigan's monthly Survey of Consumers (1966:Q1=100). |
|
|
1897
|
+
| `inflation_expectation` | `number` | Median expected price change next 12 months, Surveys of Consumers. |
|
|
1287
1898
|
|
|
1288
1899
|
---
|
|
1289
1900
|
|
|
1290
1901
|
### `economy.total_factor_productivity`
|
|
1291
1902
|
|
|
1292
1903
|
```python
|
|
1293
|
-
data.economy.total_factor_productivity(frequency='quarter', start_date=None, end_date=None
|
|
1904
|
+
data.economy.total_factor_productivity(frequency='quarter', start_date=None, end_date=None)
|
|
1294
1905
|
```
|
|
1295
1906
|
|
|
1296
1907
|
Summary: Total Factor Productivity
|
|
@@ -1300,7 +1911,6 @@ Summary: Total Factor Productivity
|
|
|
1300
1911
|
| Endpoint ID | `economy.total_factor_productivity` |
|
|
1301
1912
|
| HTTP | `GET` |
|
|
1302
1913
|
| Path | `/inner/v1/agent-data/economy/total_factor_productivity` |
|
|
1303
|
-
| Default provider | `federal_reserve` |
|
|
1304
1914
|
| SDK | `supported` |
|
|
1305
1915
|
| Host | `supported` |
|
|
1306
1916
|
| Notes | - |
|
|
@@ -1309,17 +1919,53 @@ Summary: Total Factor Productivity
|
|
|
1309
1919
|
|
|
1310
1920
|
| Param | Required | Type | Default | Notes |
|
|
1311
1921
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1922
|
+
| `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). |
|
|
1923
|
+
| `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Only applicable for time series data (quarter/annual). |
|
|
1924
|
+
| `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Only applicable for time series data (quarter/annual). |
|
|
1925
|
+
|
|
1926
|
+
#### Response fields
|
|
1927
|
+
|
|
1928
|
+
| Field | Type | Notes |
|
|
1929
|
+
|---|---|---|
|
|
1930
|
+
| `variable` | `string` | The variable name (e.g., 'd_y', 'd_tfp', 'd_tfp_util'). |
|
|
1931
|
+
| `variable_title` | `string` | Human-readable title for the variable. |
|
|
1932
|
+
| `full_sample_mean` | `number` | Mean value over the full sample period. |
|
|
1933
|
+
| `past_4_quarters` | `number` | Mean value over the past 4 quarters. |
|
|
1934
|
+
| `past_8_quarters` | `number` | Mean value over the past 8 quarters. |
|
|
1935
|
+
| `since_2019` | `number` | Mean value since 2019:Q4. |
|
|
1936
|
+
| `period_2004_2019` | `number` | Mean value for the period 2004:Q4 to 2019:Q4. |
|
|
1937
|
+
| `period_1995_2004` | `number` | Mean value for the period 1995:Q4 to 2004:Q4. |
|
|
1938
|
+
| `period_1973_1995` | `number` | Mean value for the period 1973:Q1 to 1995:Q4. |
|
|
1939
|
+
| `period_1947_1973` | `number` | Mean value for the period 1947:Q1 to 1973:Q1. |
|
|
1940
|
+
| `date` | `string` | The date of the data. |
|
|
1941
|
+
| `d_y_prod` | `number` | Business output, expenditure (product) side. |
|
|
1942
|
+
| `d_y_inc` | `number` | Business output, measured from income side. |
|
|
1943
|
+
| `d_y` | `number` | Output. Average of d_y_prod and d_y_inc. |
|
|
1944
|
+
| `d_hours` | `number` | Hours worked in the business sector. |
|
|
1945
|
+
| `d_lp` | `number` | Business-sector labor productivity. |
|
|
1946
|
+
| `d_k` | `number` | Capital input. |
|
|
1947
|
+
| `d_lq_bls_interpolated` | `number` | Labor composition/quality from BLS (pre-1979 interpolated). |
|
|
1948
|
+
| `d_lq_aaronson_sullivan` | `number` | Labor composition/quality following Aaronson-Sullivan (1979 onwards). |
|
|
1949
|
+
| `d_lq` | `number` | Labor composition/quality actually used. |
|
|
1950
|
+
| `alpha` | `number` | Capital's share of income (ratio between 0 and 1). |
|
|
1951
|
+
| `d_tfp` | `number` | Business sector Total Factor Productivity. |
|
|
1952
|
+
| `d_util` | `number` | Utilization adjustment for capital and labor. |
|
|
1953
|
+
| `d_tfp_util` | `number` | Utilization-adjusted Total Factor Productivity. |
|
|
1954
|
+
| `relative_price` | `number` | Relative price growth of 'consumption' to price of 'equipment'. |
|
|
1955
|
+
| `inv_share` | `number` | Equipment and consumer durables share of business output (ratio between 0 and 1). |
|
|
1956
|
+
| `d_tfp_i` | `number` | TFP in equipment and consumer durables sector. |
|
|
1957
|
+
| `d_tfp_c` | `number` | TFP in non-equipment business output ('consumption' goods and services). |
|
|
1958
|
+
| `d_u_invest` | `number` | Utilization adjustment in producing investment goods. |
|
|
1959
|
+
| `d_u_consumption` | `number` | Utilization adjustment in producing non-investment business output. |
|
|
1960
|
+
| `d_tfp_i_util` | `number` | Utilization-adjusted TFP in producing equipment and consumer durables. |
|
|
1961
|
+
| `d_tfp_c_util` | `number` | Utilization-adjusted TFP in producing non-equipment business output. |
|
|
1316
1962
|
|
|
1317
1963
|
---
|
|
1318
1964
|
|
|
1319
1965
|
### `economy.unemployment`
|
|
1320
1966
|
|
|
1321
1967
|
```python
|
|
1322
|
-
data.economy.unemployment(start_time=None, end_time=None, country='united_states', frequency='monthly', sex='total', age='total', seasonal_adjustment=False
|
|
1968
|
+
data.economy.unemployment(start_time=None, end_time=None, country='united_states', frequency='monthly', sex='total', age='total', seasonal_adjustment=False)
|
|
1323
1969
|
```
|
|
1324
1970
|
|
|
1325
1971
|
Summary: Unemployment
|
|
@@ -1329,7 +1975,6 @@ Summary: Unemployment
|
|
|
1329
1975
|
| Endpoint ID | `economy.unemployment` |
|
|
1330
1976
|
| HTTP | `GET` |
|
|
1331
1977
|
| Path | `/inner/v1/agent-data/economy/unemployment` |
|
|
1332
|
-
| Default provider | `oecd` |
|
|
1333
1978
|
| SDK | `supported` |
|
|
1334
1979
|
| Host | `supported` |
|
|
1335
1980
|
| Notes | - |
|
|
@@ -1340,9 +1985,16 @@ Summary: Unemployment
|
|
|
1340
1985
|
|---|---|---|---|---|
|
|
1341
1986
|
| `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
1987
|
| `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
|
|
1988
|
+
| `country` | `no` | `string` | `united_states` | The country to get data. Multiple comma separated items allowed |
|
|
1344
1989
|
| `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
|
-
|
|
1990
|
+
| `sex` | `no` | `string` | `total` | Sex to get unemployment for. |
|
|
1991
|
+
| `age` | `no` | `string` | `total` | Age group to get unemployment for. Total indicates 15 years or over |
|
|
1992
|
+
| `seasonal_adjustment` | `no` | `boolean` | `false` | Whether to get seasonally adjusted unemployment. Defaults to False. |
|
|
1993
|
+
|
|
1994
|
+
#### Response fields
|
|
1995
|
+
|
|
1996
|
+
| Field | Type | Notes |
|
|
1997
|
+
|---|---|---|
|
|
1998
|
+
| `date` | `string` | The date of the data. |
|
|
1999
|
+
| `country` | `string` | Country for which unemployment rate is given |
|
|
2000
|
+
| `value` | `number` | Unemployment rate, as a normalized percent. |
|