@bitget-ai/getagent-skill 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/VERSION +1 -1
  4. package/package.json +1 -1
  5. package/skills/getagent/SKILL.md +29 -1
  6. package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
  7. package/skills/getagent/references/api/publish.md +4 -0
  8. package/skills/getagent/references/backtest-engine.md +80 -151
  9. package/skills/getagent/references/package-schema.md +30 -8
  10. package/skills/getagent/references/sdk/backtest/catalog.md +15 -2
  11. package/skills/getagent/references/sdk/data/arxiv.md +8 -10
  12. package/skills/getagent/references/sdk/data/catalog.md +1 -4
  13. package/skills/getagent/references/sdk/data/commodity.md +25 -39
  14. package/skills/getagent/references/sdk/data/coverage.md +0 -3
  15. package/skills/getagent/references/sdk/data/crypto.md +158 -357
  16. package/skills/getagent/references/sdk/data/currency.md +7 -15
  17. package/skills/getagent/references/sdk/data/derivatives.md +35 -50
  18. package/skills/getagent/references/sdk/data/economy.md +175 -259
  19. package/skills/getagent/references/sdk/data/equity.md +257 -393
  20. package/skills/getagent/references/sdk/data/etf.md +40 -64
  21. package/skills/getagent/references/sdk/data/famafrench.md +38 -50
  22. package/skills/getagent/references/sdk/data/fixedincome.md +89 -139
  23. package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
  24. package/skills/getagent/references/sdk/data/index.md +18 -32
  25. package/skills/getagent/references/sdk/data/news.md +52 -58
  26. package/skills/getagent/references/sdk/data/playbook-supported.md +965 -1600
  27. package/skills/getagent/references/sdk/data/regulators.md +23 -43
  28. package/skills/getagent/references/sdk/data/sentiment.md +12 -34
  29. package/skills/getagent/references/sdk/data/uscongress.md +13 -21
  30. package/skills/getagent/references/sdk/data/web_search.md +3 -7
  31. package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
  32. package/skills/getagent/scripts/validate.py +127 -1
@@ -36,7 +36,7 @@ are callable through the DataSDK wrapper.
36
36
  ### `fixedincome.bond_indices`
37
37
 
38
38
  ```python
39
- data.fixedincome.bond_indices(start_time=None, end_time=None, index_type='yield', category='us', index='yield_curve', frequency=None, aggregation_method='avg', transform=None, provider='fred')
39
+ data.fixedincome.bond_indices(start_time=None, end_time=None, index_type='yield', category='us', index='yield_curve', frequency=None, aggregation_method='avg', transform=None)
40
40
  ```
41
41
 
42
42
  Summary: Bond Indices
@@ -46,7 +46,6 @@ Summary: Bond Indices
46
46
  | Endpoint ID | `fixedincome.bond_indices` |
47
47
  | HTTP | `GET` |
48
48
  | Path | `/inner/v1/agent-data/fixedincome/bond_indices` |
49
- | Default provider | `fred` |
50
49
  | SDK | `supported` |
51
50
  | Host | `supported` |
52
51
  | Notes | - |
@@ -58,19 +57,18 @@ Summary: Bond Indices
58
57
  | `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. |
59
58
  | `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. |
60
59
  | `index_type` | `no` | `string` | `yield` | The type of series. OAS is the option-adjusted spread. Default is yield. |
61
- | `category` | `no` | `string` | `us` | The type of index category. Used in conjunction with 'index', default is 'us'. (provider: fred) |
62
- | `index` | `no` | `string` | `yield_curve` | The specific index to query. Used in conjunction with 'category' and 'index_type', default is 'yield_curve'. Possible values are: corporate seasoned_corporate liquid_corporate yield_curve crossover public_sector private_sector non_financial high_grade high_yield liquid_emea emea liquid_asia asia liquid_latam latam liquid_aaa liquid_bbb aaa aa a bbb bb b ccc Multiple comma separated items allowed. (provider: fred) |
63
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily 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 (provider: fred) |
64
- | `aggregation_method` | `no` | `string` | `avg` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set, default is 'avg'. avg = Average sum = Sum eop = End of Period (provider: fred) |
65
- | `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 (provider: fred) |
66
- | `provider` | `no` | `string` | `fred` | - |
60
+ | `category` | `no` | `string` | `us` | The type of index category. Used in conjunction with 'index', default is 'us'. |
61
+ | `index` | `no` | `string` | `yield_curve` | The specific index to query. Used in conjunction with 'category' and 'index_type', default is 'yield_curve'. Possible values are: corporate seasoned_corporate liquid_corporate yield_curve crossover public_sector private_sector non_financial high_grade high_yield liquid_emea emea liquid_asia asia liquid_latam latam liquid_aaa liquid_bbb aaa aa a bbb bb b ccc Multiple comma separated items allowed. |
62
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily 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 |
63
+ | `aggregation_method` | `no` | `string` | `avg` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set, default is 'avg'. avg = Average sum = Sum eop = End of Period |
64
+ | `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 |
67
65
 
68
66
  ---
69
67
 
70
68
  ### `fixedincome.corporate.bond_prices`
71
69
 
72
70
  ```python
73
- data.fixedincome.corporate.bond_prices(country=None, issuer_name=None, isin=None, lei=None, currency=None, coupon_min=None, coupon_max=None, issued_amount_min=None, issued_amount_max=None, maturity_date_min=None, maturity_date_max=None, issue_date_min=None, issue_date_max=None, last_traded_min=None, use_cache=True, provider='tmx')
71
+ data.fixedincome.corporate.bond_prices(country=None, issuer_name=None, isin=None, lei=None, currency=None, coupon_min=None, coupon_max=None, issued_amount_min=None, issued_amount_max=None, maturity_date_min=None, maturity_date_max=None, issue_date_min=None, issue_date_max=None, last_traded_min=None, use_cache=True)
74
72
  ```
75
73
 
76
74
  Summary: Bond Prices
@@ -80,7 +78,6 @@ Summary: Bond Prices
80
78
  | Endpoint ID | `fixedincome.corporate.bond_prices` |
81
79
  | HTTP | `GET` |
82
80
  | Path | `/inner/v1/agent-data/fixedincome/corporate/bond_prices` |
83
- | Default provider | `tmx` |
84
81
  | SDK | `supported` |
85
82
  | Host | `supported` |
86
83
  | Notes | - |
@@ -91,7 +88,7 @@ Summary: Bond Prices
91
88
  |---|---|---|---|---|
92
89
  | `country` | `no` | `string | null` | `-` | The country to get data. Matches partial name. |
93
90
  | `issuer_name` | `no` | `string | null` | `-` | Name of the issuer. Returns partial matches and is case insensitive. |
94
- | `isin` | `no` | `array | string | null` | `-` | accepts array values International Securities Identification Number(s) of the bond(s). Multiple comma separated items allowed for provider(s): tmx. |
91
+ | `isin` | `no` | `array | string | null` | `-` | accepts array values International Securities Identification Number(s) of the bond(s). Multiple comma separated items allowed |
95
92
  | `lei` | `no` | `string | null` | `-` | Legal Entity Identifier of the issuing entity. |
96
93
  | `currency` | `no` | `array | string | null` | `-` | accepts array values Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). |
97
94
  | `coupon_min` | `no` | `number | null` | `-` | Minimum coupon rate of the bond. |
@@ -100,18 +97,17 @@ Summary: Bond Prices
100
97
  | `issued_amount_max` | `no` | `string | null` | `-` | Maximum issued amount of the bond. |
101
98
  | `maturity_date_min` | `no` | `string | null` | `-` | Minimum maturity date of the bond. |
102
99
  | `maturity_date_max` | `no` | `string | null` | `-` | Maximum maturity date of the bond. |
103
- | `issue_date_min` | `no` | `string | null` | `-` | Filter by the minimum original issue date. (provider: tmx) |
104
- | `issue_date_max` | `no` | `string | null` | `-` | Filter by the maximum original issue date. (provider: tmx) |
105
- | `last_traded_min` | `no` | `string | null` | `-` | Filter by the minimum last trade date. (provider: tmx) |
106
- | `use_cache` | `no` | `boolean` | `true` | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. (provider: tmx) |
107
- | `provider` | `no` | `string` | `tmx` | - |
100
+ | `issue_date_min` | `no` | `string | null` | `-` | Filter by the minimum original issue date. |
101
+ | `issue_date_max` | `no` | `string | null` | `-` | Filter by the maximum original issue date. |
102
+ | `last_traded_min` | `no` | `string | null` | `-` | Filter by the minimum last trade date. |
103
+ | `use_cache` | `no` | `boolean` | `true` | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. |
108
104
 
109
105
  ---
110
106
 
111
107
  ### `fixedincome.corporate.commercial_paper`
112
108
 
113
109
  ```python
114
- data.fixedincome.corporate.commercial_paper(start_time=None, end_time=None, maturity='all', category='all', frequency=None, aggregation_method=None, transform=None, provider='fred')
110
+ data.fixedincome.corporate.commercial_paper(start_time=None, end_time=None, maturity='all', category='all', frequency=None, aggregation_method=None, transform=None)
115
111
  ```
116
112
 
117
113
  Summary: Commercial Paper
@@ -121,7 +117,6 @@ Summary: Commercial Paper
121
117
  | Endpoint ID | `fixedincome.corporate.commercial_paper` |
122
118
  | HTTP | `GET` |
123
119
  | Path | `/inner/v1/agent-data/fixedincome/corporate/commercial_paper` |
124
- | Default provider | `fred` |
125
120
  | SDK | `supported` |
126
121
  | Host | `supported` |
127
122
  | Notes | - |
@@ -132,19 +127,18 @@ Summary: Commercial Paper
132
127
  |---|---|---|---|---|
133
128
  | `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. |
134
129
  | `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. |
135
- | `maturity` | `no` | `string` | `all` | A target maturity. Multiple comma separated items allowed. (provider: fred) |
136
- | `category` | `no` | `string` | `all` | The category of asset. Multiple comma separated items allowed. (provider: fred) |
137
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 (provider: fred) |
138
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
139
- | `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 (provider: fred) |
140
- | `provider` | `no` | `string` | `fred` | - |
130
+ | `maturity` | `no` | `string` | `all` | A target maturity. Multiple comma separated items allowed. |
131
+ | `category` | `no` | `string` | `all` | The category of asset. Multiple comma separated items allowed. |
132
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 |
133
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
134
+ | `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 |
141
135
 
142
136
  ---
143
137
 
144
138
  ### `fixedincome.corporate.hqm`
145
139
 
146
140
  ```python
147
- data.fixedincome.corporate.hqm(date=None, yield_curve='spot', provider='fred')
141
+ data.fixedincome.corporate.hqm(date=None, yield_curve='spot')
148
142
  ```
149
143
 
150
144
  Summary: Hqm
@@ -154,7 +148,6 @@ Summary: Hqm
154
148
  | Endpoint ID | `fixedincome.corporate.hqm` |
155
149
  | HTTP | `GET` |
156
150
  | Path | `/inner/v1/agent-data/fixedincome/corporate/hqm` |
157
- | Default provider | `fred` |
158
151
  | SDK | `supported` |
159
152
  | Host | `supported` |
160
153
  | Notes | - |
@@ -163,16 +156,15 @@ Summary: Hqm
163
156
 
164
157
  | Param | Required | Type | Default | Notes |
165
158
  |---|---|---|---|---|
166
- | `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed for provider(s): fred. |
167
- | `yield_curve` | `no` | `string` | `spot` | The yield curve type. (provider: fred) |
168
- | `provider` | `no` | `string` | `fred` | - |
159
+ | `date` | `no` | `string | null` | `-` | A specific date to get data for. Multiple comma separated items allowed |
160
+ | `yield_curve` | `no` | `string` | `spot` | The yield curve type. |
169
161
 
170
162
  ---
171
163
 
172
164
  ### `fixedincome.corporate.spot_rates`
173
165
 
174
166
  ```python
175
- data.fixedincome.corporate.spot_rates(start_time=None, end_time=None, maturity=10.0, category='spot_rate', provider='fred')
167
+ data.fixedincome.corporate.spot_rates(start_time=None, end_time=None, maturity=10.0, category='spot_rate')
176
168
  ```
177
169
 
178
170
  Summary: Spot Rates
@@ -182,7 +174,6 @@ Summary: Spot Rates
182
174
  | Endpoint ID | `fixedincome.corporate.spot_rates` |
183
175
  | HTTP | `GET` |
184
176
  | Path | `/inner/v1/agent-data/fixedincome/corporate/spot_rates` |
185
- | Default provider | `fred` |
186
177
  | SDK | `supported` |
187
178
  | Host | `supported` |
188
179
  | Notes | - |
@@ -193,16 +184,15 @@ Summary: Spot Rates
193
184
  |---|---|---|---|---|
194
185
  | `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. |
195
186
  | `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. |
196
- | `maturity` | `no` | `number | string` | `10.0` | Maturities in years. Multiple comma separated items allowed for provider(s): fred. |
197
- | `category` | `no` | `string` | `spot_rate` | Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred. |
198
- | `provider` | `no` | `string` | `fred` | - |
187
+ | `maturity` | `no` | `number | string` | `10.0` | Maturities in years. Multiple comma separated items allowed |
188
+ | `category` | `no` | `string` | `spot_rate` | Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed |
199
189
 
200
190
  ---
201
191
 
202
192
  ### `fixedincome.government.svensson_yield_curve`
203
193
 
204
194
  ```python
205
- data.fixedincome.government.svensson_yield_curve(series_type='all', start_date=None, end_date=None, provider='federal_reserve')
195
+ data.fixedincome.government.svensson_yield_curve(series_type='all', start_date=None, end_date=None)
206
196
  ```
207
197
 
208
198
  Summary: Svensson Yield Curve
@@ -212,7 +202,6 @@ Summary: Svensson Yield Curve
212
202
  | Endpoint ID | `fixedincome.government.svensson_yield_curve` |
213
203
  | HTTP | `GET` |
214
204
  | Path | `/inner/v1/agent-data/fixedincome/government/svensson_yield_curve` |
215
- | Default provider | `federal_reserve` |
216
205
  | SDK | `supported` |
217
206
  | Host | `supported` |
218
207
  | Notes | - |
@@ -221,17 +210,16 @@ Summary: Svensson Yield Curve
221
210
 
222
211
  | Param | Required | Type | Default | Notes |
223
212
  |---|---|---|---|---|
224
- | `series_type` | `no` | `string` | `all` | Type of yield curve series to return. Accepts a single value or comma-separated list for multiple selections. Group options: - 'all' (default) - 'zero_coupon' (SVENY, continuously compounded) - 'par_yield'(SVENPY, coupon-equivalent) - 'forward_instantaneous' (SVENF, continuously compounded) - 'forward_1y' (SVEN1F, coupon-equivalent) - 'parameters' (BETA0-BETA3, TAU1-TAU2) Individual columns can also be specified (e.g., 'sveny10,sveny20,beta0'). Used to filter columns after fetching. Multiple comma separated items allowed. (provider: federal_reserve) |
225
- | `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Used to filter results after fetching. (provider: federal_reserve) |
226
- | `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Used to filter results after fetching. (provider: federal_reserve) |
227
- | `provider` | `no` | `string` | `federal_reserve` | - |
213
+ | `series_type` | `no` | `string` | `all` | Type of yield curve series to return. Accepts a single value or comma-separated list for multiple selections. Group options: - 'all' (default) - 'zero_coupon' (SVENY, continuously compounded) - 'par_yield'(SVENPY, coupon-equivalent) - 'forward_instantaneous' (SVENF, continuously compounded) - 'forward_1y' (SVEN1F, coupon-equivalent) - 'parameters' (BETA0-BETA3, TAU1-TAU2) Individual columns can also be specified (e.g., 'sveny10,sveny20,beta0'). Used to filter columns after fetching. Multiple comma separated items allowed. |
214
+ | `start_date` | `no` | `string | null` | `-` | Start date of the data, in YYYY-MM-DD format. Used to filter results after fetching. |
215
+ | `end_date` | `no` | `string | null` | `-` | End date of the data, in YYYY-MM-DD format. Used to filter results after fetching. |
228
216
 
229
217
  ---
230
218
 
231
219
  ### `fixedincome.government.tips_yields`
232
220
 
233
221
  ```python
234
- data.fixedincome.government.tips_yields(start_time=None, end_time=None, maturity=None, frequency=None, aggregation_method=None, transform=None, provider='fred')
222
+ data.fixedincome.government.tips_yields(start_time=None, end_time=None, maturity=None, frequency=None, aggregation_method=None, transform=None)
235
223
  ```
236
224
 
237
225
  Summary: Tips Yields
@@ -241,7 +229,6 @@ Summary: Tips Yields
241
229
  | Endpoint ID | `fixedincome.government.tips_yields` |
242
230
  | HTTP | `GET` |
243
231
  | Path | `/inner/v1/agent-data/fixedincome/government/tips_yields` |
244
- | Default provider | `fred` |
245
232
  | SDK | `supported` |
246
233
  | Host | `supported` |
247
234
  | Notes | - |
@@ -252,18 +239,17 @@ Summary: Tips Yields
252
239
  |---|---|---|---|---|
253
240
  | `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. |
254
241
  | `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. |
255
- | `maturity` | `no` | `string | null` | `-` | The maturity of the security in years - 5, 10, 20, 30 - defaults to all. Note that the maturity is the tenor of the security, not the time to maturity. (provider: fred) |
256
- | `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 (provider: fred) |
257
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
258
- | `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 (provider: fred) |
259
- | `provider` | `no` | `string` | `fred` | - |
242
+ | `maturity` | `no` | `string | null` | `-` | The maturity of the security in years - 5, 10, 20, 30 - defaults to all. Note that the maturity is the tenor of the security, not the time to maturity. |
243
+ | `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 |
244
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
245
+ | `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 |
260
246
 
261
247
  ---
262
248
 
263
249
  ### `fixedincome.government.treasury_auctions`
264
250
 
265
251
  ```python
266
- data.fixedincome.government.treasury_auctions(start_time=None, end_time=None, security_type=None, cusip=None, page_size=None, page_num=None, provider='government_us')
252
+ data.fixedincome.government.treasury_auctions(start_time=None, end_time=None, security_type=None, cusip=None, page_size=None, page_num=None)
267
253
  ```
268
254
 
269
255
  Summary: Treasury Auctions
@@ -273,7 +259,6 @@ Summary: Treasury Auctions
273
259
  | Endpoint ID | `fixedincome.government.treasury_auctions` |
274
260
  | HTTP | `GET` |
275
261
  | Path | `/inner/v1/agent-data/fixedincome/government/treasury_auctions` |
276
- | Default provider | `government_us` |
277
262
  | SDK | `supported` |
278
263
  | Host | `supported` |
279
264
  | Notes | - |
@@ -288,14 +273,13 @@ Summary: Treasury Auctions
288
273
  | `cusip` | `no` | `string | null` | `-` | Filter securities by CUSIP. |
289
274
  | `page_size` | `no` | `integer | null` | `-` | Maximum number of results to return; you must also include pagenum when using pagesize. |
290
275
  | `page_num` | `no` | `integer | null` | `-` | The first page number to display results for; used in combination with page size. |
291
- | `provider` | `no` | `string` | `government_us` | - |
292
276
 
293
277
  ---
294
278
 
295
279
  ### `fixedincome.government.treasury_prices`
296
280
 
297
281
  ```python
298
- data.fixedincome.government.treasury_prices(date=None, cusip=None, security_type=None, govt_type='federal', issue_date_min=None, issue_date_max=None, last_traded_min=None, maturity_date_min=None, maturity_date_max=None, use_cache=True, provider=...)
282
+ data.fixedincome.government.treasury_prices(date=None, cusip=None, security_type=None, govt_type='federal', issue_date_min=None, issue_date_max=None, last_traded_min=None, maturity_date_min=None, maturity_date_max=None, use_cache=True)
299
283
  ```
300
284
 
301
285
  Summary: Treasury Prices
@@ -305,7 +289,6 @@ Summary: Treasury Prices
305
289
  | Endpoint ID | `fixedincome.government.treasury_prices` |
306
290
  | HTTP | `GET` |
307
291
  | Path | `/inner/v1/agent-data/fixedincome/government/treasury_prices` |
308
- | Default provider | - |
309
292
  | SDK | `supported` |
310
293
  | Host | `supported` |
311
294
  | Notes | - |
@@ -315,23 +298,22 @@ Summary: Treasury Prices
315
298
  | Param | Required | Type | Default | Notes |
316
299
  |---|---|---|---|---|
317
300
  | `date` | `no` | `string | null` | `-` | A specific date to get data for. Defaults to the last business day. |
318
- | `cusip` | `no` | `string | null` | `-` | Filter by CUSIP. (provider: government_us) |
319
- | `security_type` | `no` | `string | null` | `-` | Filter by security type. (provider: government_us) |
320
- | `govt_type` | `no` | `string` | `federal` | enum: federal, provincial, municipal The level of government issuer. (provider: tmx) |
321
- | `issue_date_min` | `no` | `string | null` | `-` | Filter by the minimum original issue date. (provider: tmx) |
322
- | `issue_date_max` | `no` | `string | null` | `-` | Filter by the maximum original issue date. (provider: tmx) |
323
- | `last_traded_min` | `no` | `string | null` | `-` | Filter by the minimum last trade date. (provider: tmx) |
324
- | `maturity_date_min` | `no` | `string | null` | `-` | Filter by the minimum maturity date. (provider: tmx) |
325
- | `maturity_date_max` | `no` | `string | null` | `-` | Filter by the maximum maturity date. (provider: tmx) |
326
- | `use_cache` | `no` | `boolean` | `true` | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. (provider: tmx) |
327
- | `provider` | `yes` | `string` | `-` | enum: government_us, tmx |
301
+ | `cusip` | `no` | `string | null` | `-` | Filter by CUSIP. |
302
+ | `security_type` | `no` | `string | null` | `-` | Filter by security type. |
303
+ | `govt_type` | `no` | `string` | `federal` | enum: federal, provincial, municipal The level of government issuer. |
304
+ | `issue_date_min` | `no` | `string | null` | `-` | Filter by the minimum original issue date. |
305
+ | `issue_date_max` | `no` | `string | null` | `-` | Filter by the maximum original issue date. |
306
+ | `last_traded_min` | `no` | `string | null` | `-` | Filter by the minimum last trade date. |
307
+ | `maturity_date_min` | `no` | `string | null` | `-` | Filter by the minimum maturity date. |
308
+ | `maturity_date_max` | `no` | `string | null` | `-` | Filter by the maximum maturity date. |
309
+ | `use_cache` | `no` | `boolean` | `true` | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. |
328
310
 
329
311
  ---
330
312
 
331
313
  ### `fixedincome.government.treasury_rates`
332
314
 
333
315
  ```python
334
- data.fixedincome.government.treasury_rates(start_time=None, end_time=None, provider=...)
316
+ data.fixedincome.government.treasury_rates(start_time=None, end_time=None)
335
317
  ```
336
318
 
337
319
  Summary: Treasury Rates
@@ -341,7 +323,6 @@ Summary: Treasury Rates
341
323
  | Endpoint ID | `fixedincome.government.treasury_rates` |
342
324
  | HTTP | `GET` |
343
325
  | Path | `/inner/v1/agent-data/fixedincome/government/treasury_rates` |
344
- | Default provider | - |
345
326
  | SDK | `supported` |
346
327
  | Host | `supported` |
347
328
  | Notes | - |
@@ -352,14 +333,13 @@ Summary: Treasury Rates
352
333
  |---|---|---|---|---|
353
334
  | `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. |
354
335
  | `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. |
355
- | `provider` | `yes` | `string` | `-` | enum: federal_reserve, fmp |
356
336
 
357
337
  ---
358
338
 
359
339
  ### `fixedincome.government.yield_curve`
360
340
 
361
341
  ```python
362
- data.fixedincome.government.yield_curve(date=None, rating='aaa', yield_curve_type='spot_rate', use_cache=True, country='united_states', provider=...)
342
+ data.fixedincome.government.yield_curve(date=None, rating='aaa', yield_curve_type='spot_rate', use_cache=True, country='united_states')
363
343
  ```
364
344
 
365
345
  Summary: Yield Curve
@@ -369,7 +349,6 @@ Summary: Yield Curve
369
349
  | Endpoint ID | `fixedincome.government.yield_curve` |
370
350
  | HTTP | `GET` |
371
351
  | Path | `/inner/v1/agent-data/fixedincome/government/yield_curve` |
372
- | Default provider | - |
373
352
  | SDK | `supported` |
374
353
  | Host | `supported` |
375
354
  | Notes | - |
@@ -378,19 +357,18 @@ Summary: Yield Curve
378
357
 
379
358
  | Param | Required | Type | Default | Notes |
380
359
  |---|---|---|---|---|
381
- | `date` | `no` | `string | null` | `-` | A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): ecb, econdb, federal_reserve, fmp, fred. |
382
- | `rating` | `no` | `string` | `aaa` | enum: aaa, all_ratings The rating type, either 'aaa' or 'all_ratings'. (provider: ecb) |
383
- | `yield_curve_type` | `no` | `string` | `spot_rate` | The yield curve type. (provider: ecb); Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. (provider: fred) |
384
- | `use_cache` | `no` | `boolean` | `true` | If true, cache the request for four hours. (provider: ecb, econdb) |
385
- | `country` | `no` | `string` | `united_states` | The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. Multiple comma separated items allowed. (provider: econdb) |
386
- | `provider` | `yes` | `string` | `-` | enum: ecb, econdb, federal_reserve, fmp, fred |
360
+ | `date` | `no` | `string | null` | `-` | A specific date to get data for. By default is the current data. Multiple comma separated items allowed |
361
+ | `rating` | `no` | `string` | `aaa` | enum: aaa, all_ratings The rating type, either 'aaa' or 'all_ratings'. |
362
+ | `yield_curve_type` | `no` | `string` | `spot_rate` | The yield curve type.; Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. |
363
+ | `use_cache` | `no` | `boolean` | `true` | If true, cache the request for four hours. |
364
+ | `country` | `no` | `string` | `united_states` | The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. Multiple comma separated items allowed. |
387
365
 
388
366
  ---
389
367
 
390
368
  ### `fixedincome.mortgage_indices`
391
369
 
392
370
  ```python
393
- data.fixedincome.mortgage_indices(start_time=None, end_time=None, index='primary', frequency=None, aggregation_method='avg', transform=None, provider='fred')
371
+ data.fixedincome.mortgage_indices(start_time=None, end_time=None, index='primary', frequency=None, aggregation_method='avg', transform=None)
394
372
  ```
395
373
 
396
374
  Summary: Mortgage Indices
@@ -400,7 +378,6 @@ Summary: Mortgage Indices
400
378
  | Endpoint ID | `fixedincome.mortgage_indices` |
401
379
  | HTTP | `GET` |
402
380
  | Path | `/inner/v1/agent-data/fixedincome/mortgage_indices` |
403
- | Default provider | `fred` |
404
381
  | SDK | `supported` |
405
382
  | Host | `supported` |
406
383
  | Notes | - |
@@ -411,18 +388,17 @@ Summary: Mortgage Indices
411
388
  |---|---|---|---|---|
412
389
  | `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. |
413
390
  | `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. |
414
- | `index` | `no` | `string` | `primary` | The specific index, or index group, to query. Default is the 'primary' group. Multiple comma separated items allowed. (provider: fred) |
415
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily 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 (provider: fred) |
416
- | `aggregation_method` | `no` | `string` | `avg` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set, default is 'avg'. avg = Average sum = Sum eop = End of Period (provider: fred) |
417
- | `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 (provider: fred) |
418
- | `provider` | `no` | `string` | `fred` | - |
391
+ | `index` | `no` | `string` | `primary` | The specific index, or index group, to query. Default is the 'primary' group. Multiple comma separated items allowed. |
392
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily 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` | `avg` | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set, default is 'avg'. 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 |
419
395
 
420
396
  ---
421
397
 
422
398
  ### `fixedincome.rate.ameribor`
423
399
 
424
400
  ```python
425
- data.fixedincome.rate.ameribor(start_time=None, end_time=None, maturity='all', frequency=None, aggregation_method=None, transform=None, provider='fred')
401
+ data.fixedincome.rate.ameribor(start_time=None, end_time=None, maturity='all', frequency=None, aggregation_method=None, transform=None)
426
402
  ```
427
403
 
428
404
  Summary: Ameribor
@@ -432,7 +408,6 @@ Summary: Ameribor
432
408
  | Endpoint ID | `fixedincome.rate.ameribor` |
433
409
  | HTTP | `GET` |
434
410
  | Path | `/inner/v1/agent-data/fixedincome/rate/ameribor` |
435
- | Default provider | `fred` |
436
411
  | SDK | `supported` |
437
412
  | Host | `supported` |
438
413
  | Notes | - |
@@ -443,18 +418,17 @@ Summary: Ameribor
443
418
  |---|---|---|---|---|
444
419
  | `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. |
445
420
  | `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. |
446
- | `maturity` | `no` | `string` | `all` | Period of AMERIBOR rate. Multiple comma separated items allowed. (provider: fred) |
447
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 (provider: fred) |
448
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
449
- | `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 (provider: fred) |
450
- | `provider` | `no` | `string` | `fred` | - |
421
+ | `maturity` | `no` | `string` | `all` | Period of AMERIBOR rate. Multiple comma separated items allowed. |
422
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 |
423
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
424
+ | `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 |
451
425
 
452
426
  ---
453
427
 
454
428
  ### `fixedincome.rate.dpcredit`
455
429
 
456
430
  ```python
457
- data.fixedincome.rate.dpcredit(start_time=None, end_time=None, parameter='daily_excl_weekend', provider='fred')
431
+ data.fixedincome.rate.dpcredit(start_time=None, end_time=None, parameter='daily_excl_weekend')
458
432
  ```
459
433
 
460
434
  Summary: Dpcredit
@@ -464,7 +438,6 @@ Summary: Dpcredit
464
438
  | Endpoint ID | `fixedincome.rate.dpcredit` |
465
439
  | HTTP | `GET` |
466
440
  | Path | `/inner/v1/agent-data/fixedincome/rate/dpcredit` |
467
- | Default provider | `fred` |
468
441
  | SDK | `supported` |
469
442
  | Host | `supported` |
470
443
  | Notes | - |
@@ -475,15 +448,14 @@ Summary: Dpcredit
475
448
  |---|---|---|---|---|
476
449
  | `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. |
477
450
  | `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. |
478
- | `parameter` | `no` | `string` | `daily_excl_weekend` | FRED series ID of DWPCR data. (provider: fred) |
479
- | `provider` | `no` | `string` | `fred` | - |
451
+ | `parameter` | `no` | `string` | `daily_excl_weekend` | FRED series ID of DWPCR data. |
480
452
 
481
453
  ---
482
454
 
483
455
  ### `fixedincome.rate.ecb`
484
456
 
485
457
  ```python
486
- data.fixedincome.rate.ecb(start_time=None, end_time=None, interest_rate_type='lending', provider='fred')
458
+ data.fixedincome.rate.ecb(start_time=None, end_time=None, interest_rate_type='lending')
487
459
  ```
488
460
 
489
461
  Summary: Ecb
@@ -493,7 +465,6 @@ Summary: Ecb
493
465
  | Endpoint ID | `fixedincome.rate.ecb` |
494
466
  | HTTP | `GET` |
495
467
  | Path | `/inner/v1/agent-data/fixedincome/rate/ecb` |
496
- | Default provider | `fred` |
497
468
  | SDK | `supported` |
498
469
  | Host | `supported` |
499
470
  | Notes | - |
@@ -505,14 +476,13 @@ Summary: Ecb
505
476
  | `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. |
506
477
  | `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. |
507
478
  | `interest_rate_type` | `no` | `string` | `lending` | The type of interest rate. |
508
- | `provider` | `no` | `string` | `fred` | - |
509
479
 
510
480
  ---
511
481
 
512
482
  ### `fixedincome.rate.effr`
513
483
 
514
484
  ```python
515
- data.fixedincome.rate.effr(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None, effr_only=False, provider=...)
485
+ data.fixedincome.rate.effr(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None, effr_only=False)
516
486
  ```
517
487
 
518
488
  Summary: Effr
@@ -522,7 +492,6 @@ Summary: Effr
522
492
  | Endpoint ID | `fixedincome.rate.effr` |
523
493
  | HTTP | `GET` |
524
494
  | Path | `/inner/v1/agent-data/fixedincome/rate/effr` |
525
- | Default provider | - |
526
495
  | SDK | `supported` |
527
496
  | Host | `supported` |
528
497
  | Notes | - |
@@ -533,18 +502,17 @@ Summary: Effr
533
502
  |---|---|---|---|---|
534
503
  | `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. |
535
504
  | `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. |
536
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 (provider: fred) |
537
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
538
- | `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 (provider: fred) |
539
- | `effr_only` | `no` | `boolean` | `false` | Return data without quantiles, target ranges, and volume. (provider: fred) |
540
- | `provider` | `yes` | `string` | `-` | enum: federal_reserve, fred |
505
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 |
506
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
507
+ | `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 |
508
+ | `effr_only` | `no` | `boolean` | `false` | Return data without quantiles, target ranges, and volume. |
541
509
 
542
510
  ---
543
511
 
544
512
  ### `fixedincome.rate.effr_forecast`
545
513
 
546
514
  ```python
547
- data.fixedincome.rate.effr_forecast(long_run=False, provider='fred')
515
+ data.fixedincome.rate.effr_forecast(long_run=False)
548
516
  ```
549
517
 
550
518
  Summary: Effr Forecast
@@ -554,7 +522,6 @@ Summary: Effr Forecast
554
522
  | Endpoint ID | `fixedincome.rate.effr_forecast` |
555
523
  | HTTP | `GET` |
556
524
  | Path | `/inner/v1/agent-data/fixedincome/rate/effr_forecast` |
557
- | Default provider | `fred` |
558
525
  | SDK | `supported` |
559
526
  | Host | `supported` |
560
527
  | Notes | - |
@@ -563,15 +530,14 @@ Summary: Effr Forecast
563
530
 
564
531
  | Param | Required | Type | Default | Notes |
565
532
  |---|---|---|---|---|
566
- | `long_run` | `no` | `boolean` | `false` | Flag to show long run projections (provider: fred) |
567
- | `provider` | `no` | `string` | `fred` | - |
533
+ | `long_run` | `no` | `boolean` | `false` | Flag to show long run projections |
568
534
 
569
535
  ---
570
536
 
571
537
  ### `fixedincome.rate.estr`
572
538
 
573
539
  ```python
574
- data.fixedincome.rate.estr(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None, provider='fred')
540
+ data.fixedincome.rate.estr(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
575
541
  ```
576
542
 
577
543
  Summary: Estr
@@ -581,7 +547,6 @@ Summary: Estr
581
547
  | Endpoint ID | `fixedincome.rate.estr` |
582
548
  | HTTP | `GET` |
583
549
  | Path | `/inner/v1/agent-data/fixedincome/rate/estr` |
584
- | Default provider | `fred` |
585
550
  | SDK | `supported` |
586
551
  | Host | `supported` |
587
552
  | Notes | - |
@@ -592,17 +557,16 @@ Summary: Estr
592
557
  |---|---|---|---|---|
593
558
  | `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. |
594
559
  | `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. |
595
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. 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 (provider: fred) |
596
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
597
- | `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 (provider: fred) |
598
- | `provider` | `no` | `string` | `fred` | - |
560
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. 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 |
561
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
562
+ | `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 |
599
563
 
600
564
  ---
601
565
 
602
566
  ### `fixedincome.rate.iorb`
603
567
 
604
568
  ```python
605
- data.fixedincome.rate.iorb(start_time=None, end_time=None, provider='fred')
569
+ data.fixedincome.rate.iorb(start_time=None, end_time=None)
606
570
  ```
607
571
 
608
572
  Summary: Iorb
@@ -612,7 +576,6 @@ Summary: Iorb
612
576
  | Endpoint ID | `fixedincome.rate.iorb` |
613
577
  | HTTP | `GET` |
614
578
  | Path | `/inner/v1/agent-data/fixedincome/rate/iorb` |
615
- | Default provider | `fred` |
616
579
  | SDK | `supported` |
617
580
  | Host | `supported` |
618
581
  | Notes | - |
@@ -623,14 +586,13 @@ Summary: Iorb
623
586
  |---|---|---|---|---|
624
587
  | `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. |
625
588
  | `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. |
626
- | `provider` | `no` | `string` | `fred` | - |
627
589
 
628
590
  ---
629
591
 
630
592
  ### `fixedincome.rate.overnight_bank_funding`
631
593
 
632
594
  ```python
633
- data.fixedincome.rate.overnight_bank_funding(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None, provider=...)
595
+ data.fixedincome.rate.overnight_bank_funding(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
634
596
  ```
635
597
 
636
598
  Summary: Overnight Bank Funding
@@ -640,7 +602,6 @@ Summary: Overnight Bank Funding
640
602
  | Endpoint ID | `fixedincome.rate.overnight_bank_funding` |
641
603
  | HTTP | `GET` |
642
604
  | Path | `/inner/v1/agent-data/fixedincome/rate/overnight_bank_funding` |
643
- | Default provider | - |
644
605
  | SDK | `supported` |
645
606
  | Host | `supported` |
646
607
  | Notes | - |
@@ -651,17 +612,16 @@ Summary: Overnight Bank Funding
651
612
  |---|---|---|---|---|
652
613
  | `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
653
614
  | `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
654
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 (provider: fred) |
655
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
656
- | `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 (provider: fred) |
657
- | `provider` | `yes` | `string` | `-` | enum: federal_reserve, fred |
615
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 |
616
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
617
+ | `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 |
658
618
 
659
619
  ---
660
620
 
661
621
  ### `fixedincome.rate.sofr`
662
622
 
663
623
  ```python
664
- data.fixedincome.rate.sofr(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None, provider=...)
624
+ data.fixedincome.rate.sofr(start_time=None, end_time=None, frequency=None, aggregation_method=None, transform=None)
665
625
  ```
666
626
 
667
627
  Summary: Sofr
@@ -671,7 +631,6 @@ Summary: Sofr
671
631
  | Endpoint ID | `fixedincome.rate.sofr` |
672
632
  | HTTP | `GET` |
673
633
  | Path | `/inner/v1/agent-data/fixedincome/rate/sofr` |
674
- | Default provider | - |
675
634
  | SDK | `supported` |
676
635
  | Host | `supported` |
677
636
  | Notes | - |
@@ -682,17 +641,16 @@ Summary: Sofr
682
641
  |---|---|---|---|---|
683
642
  | `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. |
684
643
  | `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. |
685
- | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 (provider: fred) |
686
- | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period (provider: fred) |
687
- | `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 (provider: fred) |
688
- | `provider` | `yes` | `string` | `-` | enum: federal_reserve, fred |
644
+ | `frequency` | `no` | `string | null` | `-` | Frequency aggregation to convert daily data to lower frequency. a = Annual q = Quarterly m = Monthly w = Weekly 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 |
645
+ | `aggregation_method` | `no` | `string | null` | `-` | A key that indicates the aggregation method used for frequency aggregation. avg = Average sum = Sum eop = End of Period |
646
+ | `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 |
689
647
 
690
648
  ---
691
649
 
692
650
  ### `fixedincome.rate.sonia`
693
651
 
694
652
  ```python
695
- data.fixedincome.rate.sonia(start_time=None, end_time=None, parameter='rate', provider='fred')
653
+ data.fixedincome.rate.sonia(start_time=None, end_time=None, parameter='rate')
696
654
  ```
697
655
 
698
656
  Summary: Sonia
@@ -702,7 +660,6 @@ Summary: Sonia
702
660
  | Endpoint ID | `fixedincome.rate.sonia` |
703
661
  | HTTP | `GET` |
704
662
  | Path | `/inner/v1/agent-data/fixedincome/rate/sonia` |
705
- | Default provider | `fred` |
706
663
  | SDK | `supported` |
707
664
  | Host | `supported` |
708
665
  | Notes | - |
@@ -713,15 +670,14 @@ Summary: Sonia
713
670
  |---|---|---|---|---|
714
671
  | `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. |
715
672
  | `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. |
716
- | `parameter` | `no` | `string` | `rate` | Period of SONIA rate. (provider: fred) |
717
- | `provider` | `no` | `string` | `fred` | - |
673
+ | `parameter` | `no` | `string` | `rate` | Period of SONIA rate. |
718
674
 
719
675
  ---
720
676
 
721
677
  ### `fixedincome.spreads.tcm`
722
678
 
723
679
  ```python
724
- data.fixedincome.spreads.tcm(start_time=None, end_time=None, maturity='3m', provider='fred')
680
+ data.fixedincome.spreads.tcm(start_time=None, end_time=None, maturity='3m')
725
681
  ```
726
682
 
727
683
  Summary: Tcm
@@ -731,7 +687,6 @@ Summary: Tcm
731
687
  | Endpoint ID | `fixedincome.spreads.tcm` |
732
688
  | HTTP | `GET` |
733
689
  | Path | `/inner/v1/agent-data/fixedincome/spreads/tcm` |
734
- | Default provider | `fred` |
735
690
  | SDK | `supported` |
736
691
  | Host | `supported` |
737
692
  | Notes | - |
@@ -743,14 +698,13 @@ Summary: Tcm
743
698
  | `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. |
744
699
  | `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. |
745
700
  | `maturity` | `no` | `string | null` | `3m` | The maturity |
746
- | `provider` | `no` | `string` | `fred` | - |
747
701
 
748
702
  ---
749
703
 
750
704
  ### `fixedincome.spreads.tcm_effr`
751
705
 
752
706
  ```python
753
- data.fixedincome.spreads.tcm_effr(start_time=None, end_time=None, maturity='10y', provider='fred')
707
+ data.fixedincome.spreads.tcm_effr(start_time=None, end_time=None, maturity='10y')
754
708
  ```
755
709
 
756
710
  Summary: Tcm Effr
@@ -760,7 +714,6 @@ Summary: Tcm Effr
760
714
  | Endpoint ID | `fixedincome.spreads.tcm_effr` |
761
715
  | HTTP | `GET` |
762
716
  | Path | `/inner/v1/agent-data/fixedincome/spreads/tcm_effr` |
763
- | Default provider | `fred` |
764
717
  | SDK | `supported` |
765
718
  | Host | `supported` |
766
719
  | Notes | - |
@@ -772,14 +725,13 @@ Summary: Tcm Effr
772
725
  | `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. |
773
726
  | `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. |
774
727
  | `maturity` | `no` | `string | null` | `10y` | The maturity |
775
- | `provider` | `no` | `string` | `fred` | - |
776
728
 
777
729
  ---
778
730
 
779
731
  ### `fixedincome.spreads.treasury_effr`
780
732
 
781
733
  ```python
782
- data.fixedincome.spreads.treasury_effr(start_time=None, end_time=None, maturity='3m', provider='fred')
734
+ data.fixedincome.spreads.treasury_effr(start_time=None, end_time=None, maturity='3m')
783
735
  ```
784
736
 
785
737
  Summary: Treasury Effr
@@ -789,7 +741,6 @@ Summary: Treasury Effr
789
741
  | Endpoint ID | `fixedincome.spreads.treasury_effr` |
790
742
  | HTTP | `GET` |
791
743
  | Path | `/inner/v1/agent-data/fixedincome/spreads/treasury_effr` |
792
- | Default provider | `fred` |
793
744
  | SDK | `supported` |
794
745
  | Host | `supported` |
795
746
  | Notes | - |
@@ -801,4 +752,3 @@ Summary: Treasury Effr
801
752
  | `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. |
802
753
  | `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. |
803
754
  | `maturity` | `no` | `string | null` | `3m` | The maturity |
804
- | `provider` | `no` | `string` | `fred` | - |