@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
|
@@ -17,7 +17,7 @@ are callable through the DataSDK wrapper.
|
|
|
17
17
|
### `famafrench.breakpoints`
|
|
18
18
|
|
|
19
19
|
```python
|
|
20
|
-
data.famafrench.breakpoints(breakpoint_type='me', start_date=None, end_date=None
|
|
20
|
+
data.famafrench.breakpoints(breakpoint_type='me', start_date=None, end_date=None)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Summary: Breakpoints
|
|
@@ -27,7 +27,6 @@ Summary: Breakpoints
|
|
|
27
27
|
| Endpoint ID | `famafrench.breakpoints` |
|
|
28
28
|
| HTTP | `GET` |
|
|
29
29
|
| Path | `/inner/v1/agent-data/famafrench/breakpoints` |
|
|
30
|
-
| Default provider | `famafrench` |
|
|
31
30
|
| SDK | `supported` |
|
|
32
31
|
| Host | `supported` |
|
|
33
32
|
| Notes | - |
|
|
@@ -36,17 +35,16 @@ Summary: Breakpoints
|
|
|
36
35
|
|
|
37
36
|
| Param | Required | Type | Default | Notes |
|
|
38
37
|
|---|---|---|---|---|
|
|
39
|
-
| `breakpoint_type` | `no` | `string` | `me` | Type of breakpoint to fetch. The breakpoints for month t use all NYSE stocks that have a CRSP share code of 10 or 11 and have good shares and price data. We exclude closed end funds and REITs. Breakpoints are computed either monthly or annually, see the description of each breakpoint type below. Data contains every fifth percentile, from 5% to 100%. ME -- Market Equity. Market equity (size) is price times shares outstanding. Price and shares outstanding are from CRSP. ME breakpoints are computed for each month. It is price times shares outstanding (divided by 1,000,000) at month end. BE/ME ----- BE/ME breakpoints are computed at the end of each June. The BE used in June of year t is the book equity for the last fiscal year end in t-1. ME is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) BE for the last fiscal year end in t-1. Operating Profitability ----------------------- Operating Profitability breakpoints are computed at the end of each June. OP for June of year t is annual revenues minus - cost of goods sold - interest expense - selling, general, and administrative expenses divided by book equity for the last fiscal year end in t-1. Please be aware that some of the value-weight averages of operating profitability for deciles 1 and 10 are extreme. These are driven by extraordinary values of OP for individual firms. We have spot checked the accounting data that produce the extraordinary values and all the numbers we examined accurately reflect the data in the firm's accounting statements. The breakpoints for year t use all NYSE stocks for which we have (positive) book equity data for t-1, non-missing revenues data for t-1, and non-missing data for at least one of the following: - cost of goods sold - selling, general and administrative expenses - interest expense for t-1. Investment ---------- Investment breakpoints are computed at the end of each June. Inv used in June of year t is the change in total assets from the fiscal year ending in year t-2 to the fiscal year ending in t-1, divided by t-2 total assets. The breakpoints for year t use all NYSE stocks for which we have total assets data for t-2 and t-1. E/P --- E/P (in percent) breakpoints are computed at the end of each June. The E used in June of year t is the earnings for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) earnings for the last fiscal year end in t-1. CF/P ---- CF/P (in percent) breakpoints is computed at the end of each June. The CF used in June of year t is the cash flow for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) cash flow for the last fiscal year end in t-1. D/P --- D/P (in percent) breakpoints are computed at the end of each June. The dividend yield in June of year t is the total dividends paid from July of t-1 to June of t per dollar of equity in June of t. The breakpoints for year t use NYSE stocks for which we have at least seven months (to compute the dividend yield) from July of t-1 to June of t. (Only six monthly returns are required in June 1926.) We do not include stocks that pay no dividends from July of t-1 to June of t. Prior 2-12 ---------- Prior return breakpoints are computed for each month. The prior return at the end of month t is the cumulative return from month t-11 to month t-1. The breakpoints for month t use NYSE stocks. To be included, a stock must have a price for the end of month t-12 and a good return for t-1. In addition, any missing returns from t-11 to t-2 must be -99.0, CRSP's code for a missing price.
|
|
40
|
-
| `start_date` | `no` | `string | null` | `-` | Start date for the data.
|
|
41
|
-
| `end_date` | `no` | `string | null` | `-` | End date for the data.
|
|
42
|
-
| `provider` | `no` | `string` | `famafrench` | - |
|
|
38
|
+
| `breakpoint_type` | `no` | `string` | `me` | Type of breakpoint to fetch. The breakpoints for month t use all NYSE stocks that have a CRSP share code of 10 or 11 and have good shares and price data. We exclude closed end funds and REITs. Breakpoints are computed either monthly or annually, see the description of each breakpoint type below. Data contains every fifth percentile, from 5% to 100%. ME -- Market Equity. Market equity (size) is price times shares outstanding. Price and shares outstanding are from CRSP. ME breakpoints are computed for each month. It is price times shares outstanding (divided by 1,000,000) at month end. BE/ME ----- BE/ME breakpoints are computed at the end of each June. The BE used in June of year t is the book equity for the last fiscal year end in t-1. ME is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) BE for the last fiscal year end in t-1. Operating Profitability ----------------------- Operating Profitability breakpoints are computed at the end of each June. OP for June of year t is annual revenues minus - cost of goods sold - interest expense - selling, general, and administrative expenses divided by book equity for the last fiscal year end in t-1. Please be aware that some of the value-weight averages of operating profitability for deciles 1 and 10 are extreme. These are driven by extraordinary values of OP for individual firms. We have spot checked the accounting data that produce the extraordinary values and all the numbers we examined accurately reflect the data in the firm's accounting statements. The breakpoints for year t use all NYSE stocks for which we have (positive) book equity data for t-1, non-missing revenues data for t-1, and non-missing data for at least one of the following: - cost of goods sold - selling, general and administrative expenses - interest expense for t-1. Investment ---------- Investment breakpoints are computed at the end of each June. Inv used in June of year t is the change in total assets from the fiscal year ending in year t-2 to the fiscal year ending in t-1, divided by t-2 total assets. The breakpoints for year t use all NYSE stocks for which we have total assets data for t-2 and t-1. E/P --- E/P (in percent) breakpoints are computed at the end of each June. The E used in June of year t is the earnings for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) earnings for the last fiscal year end in t-1. CF/P ---- CF/P (in percent) breakpoints is computed at the end of each June. The CF used in June of year t is the cash flow for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) cash flow for the last fiscal year end in t-1. D/P --- D/P (in percent) breakpoints are computed at the end of each June. The dividend yield in June of year t is the total dividends paid from July of t-1 to June of t per dollar of equity in June of t. The breakpoints for year t use NYSE stocks for which we have at least seven months (to compute the dividend yield) from July of t-1 to June of t. (Only six monthly returns are required in June 1926.) We do not include stocks that pay no dividends from July of t-1 to June of t. Prior 2-12 ---------- Prior return breakpoints are computed for each month. The prior return at the end of month t is the cumulative return from month t-11 to month t-1. The breakpoints for month t use NYSE stocks. To be included, a stock must have a price for the end of month t-12 and a good return for t-1. In addition, any missing returns from t-11 to t-2 must be -99.0, CRSP's code for a missing price. |
|
|
39
|
+
| `start_date` | `no` | `string | null` | `-` | Start date for the data. |
|
|
40
|
+
| `end_date` | `no` | `string | null` | `-` | End date for the data. |
|
|
43
41
|
|
|
44
42
|
---
|
|
45
43
|
|
|
46
44
|
### `famafrench.country_portfolio_returns`
|
|
47
45
|
|
|
48
46
|
```python
|
|
49
|
-
data.famafrench.country_portfolio_returns(country='united_kingdom', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None
|
|
47
|
+
data.famafrench.country_portfolio_returns(country='united_kingdom', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None)
|
|
50
48
|
```
|
|
51
49
|
|
|
52
50
|
Summary: Country Portfolio Returns
|
|
@@ -56,7 +54,6 @@ Summary: Country Portfolio Returns
|
|
|
56
54
|
| Endpoint ID | `famafrench.country_portfolio_returns` |
|
|
57
55
|
| HTTP | `GET` |
|
|
58
56
|
| Path | `/inner/v1/agent-data/famafrench/country_portfolio_returns` |
|
|
59
|
-
| Default provider | `famafrench` |
|
|
60
57
|
| SDK | `supported` |
|
|
61
58
|
| Host | `supported` |
|
|
62
59
|
| Notes | - |
|
|
@@ -65,21 +62,20 @@ Summary: Country Portfolio Returns
|
|
|
65
62
|
|
|
66
63
|
| Param | Required | Type | Default | Notes |
|
|
67
64
|
|---|---|---|---|---|
|
|
68
|
-
| `country` | `no` | `string` | `united_kingdom` | enum: austria, australia, belgium, canada, denmark, finland, france, germany, hong_kong, ireland, italy, japan, malaysia, netherlands, new_zealand, norway, singapore, spain, sweden, switzerland, united_kingdom Country to fetch the portfolio returns for.
|
|
69
|
-
| `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'.
|
|
70
|
-
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'.
|
|
71
|
-
| `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends.
|
|
72
|
-
| `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data.
|
|
73
|
-
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date.
|
|
74
|
-
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date.
|
|
75
|
-
| `provider` | `no` | `string` | `famafrench` | - |
|
|
65
|
+
| `country` | `no` | `string` | `united_kingdom` | enum: austria, australia, belgium, canada, denmark, finland, france, germany, hong_kong, ireland, italy, japan, malaysia, netherlands, new_zealand, norway, singapore, spain, sweden, switzerland, united_kingdom Country to fetch the portfolio returns for. |
|
|
66
|
+
| `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'. |
|
|
67
|
+
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'. |
|
|
68
|
+
| `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends. |
|
|
69
|
+
| `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data. |
|
|
70
|
+
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
|
|
71
|
+
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
|
|
76
72
|
|
|
77
73
|
---
|
|
78
74
|
|
|
79
75
|
### `famafrench.factors`
|
|
80
76
|
|
|
81
77
|
```python
|
|
82
|
-
data.famafrench.factors(region='america', factor='3_factors', frequency='monthly', start_date=None, end_date=None
|
|
78
|
+
data.famafrench.factors(region='america', factor='3_factors', frequency='monthly', start_date=None, end_date=None)
|
|
83
79
|
```
|
|
84
80
|
|
|
85
81
|
Summary: Factors
|
|
@@ -89,7 +85,6 @@ Summary: Factors
|
|
|
89
85
|
| Endpoint ID | `famafrench.factors` |
|
|
90
86
|
| HTTP | `GET` |
|
|
91
87
|
| Path | `/inner/v1/agent-data/famafrench/factors` |
|
|
92
|
-
| Default provider | `famafrench` |
|
|
93
88
|
| SDK | `supported` |
|
|
94
89
|
| Host | `supported` |
|
|
95
90
|
| Notes | - |
|
|
@@ -98,19 +93,18 @@ Summary: Factors
|
|
|
98
93
|
|
|
99
94
|
| Param | Required | Type | Default | Notes |
|
|
100
95
|
|---|---|---|---|---|
|
|
101
|
-
| `region` | `no` | `string` | `america` | Region of focus. Default is America.
|
|
102
|
-
| `factor` | `no` | `string` | `3_factors` | Factor to fetch. Default is the 3-Factor Model.Short/long-term reversals are available only for America.
|
|
103
|
-
| `frequency` | `no` | `string` | `monthly` | Frequency of the factor data.Not all are available for all regions, and intervals depend on the factor selected. Weekly is only available for the US 3-Factor Model.
|
|
104
|
-
| `start_date` | `no` | `string | null` | `-` | Start date of the data. Defaults to the complete data range.
|
|
105
|
-
| `end_date` | `no` | `string | null` | `-` | End date of the data. Defaults to the complete data range.
|
|
106
|
-
| `provider` | `no` | `string` | `famafrench` | - |
|
|
96
|
+
| `region` | `no` | `string` | `america` | Region of focus. Default is America. |
|
|
97
|
+
| `factor` | `no` | `string` | `3_factors` | Factor to fetch. Default is the 3-Factor Model.Short/long-term reversals are available only for America. |
|
|
98
|
+
| `frequency` | `no` | `string` | `monthly` | Frequency of the factor data.Not all are available for all regions, and intervals depend on the factor selected. Weekly is only available for the US 3-Factor Model. |
|
|
99
|
+
| `start_date` | `no` | `string | null` | `-` | Start date of the data. Defaults to the complete data range. |
|
|
100
|
+
| `end_date` | `no` | `string | null` | `-` | End date of the data. Defaults to the complete data range. |
|
|
107
101
|
|
|
108
102
|
---
|
|
109
103
|
|
|
110
104
|
### `famafrench.international_index_returns`
|
|
111
105
|
|
|
112
106
|
```python
|
|
113
|
-
data.famafrench.international_index_returns(index='all', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None
|
|
107
|
+
data.famafrench.international_index_returns(index='all', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None)
|
|
114
108
|
```
|
|
115
109
|
|
|
116
110
|
Summary: International Index Returns
|
|
@@ -120,7 +114,6 @@ Summary: International Index Returns
|
|
|
120
114
|
| Endpoint ID | `famafrench.international_index_returns` |
|
|
121
115
|
| HTTP | `GET` |
|
|
122
116
|
| Path | `/inner/v1/agent-data/famafrench/international_index_returns` |
|
|
123
|
-
| Default provider | `famafrench` |
|
|
124
117
|
| SDK | `supported` |
|
|
125
118
|
| Host | `supported` |
|
|
126
119
|
| Notes | - |
|
|
@@ -129,21 +122,20 @@ Summary: International Index Returns
|
|
|
129
122
|
|
|
130
123
|
| Param | Required | Type | Default | Notes |
|
|
131
124
|
|---|---|---|---|---|
|
|
132
|
-
| `index` | `no` | `string` | `all` | International index to fetch the portfolio returns for. Defaults to 'all'.
|
|
133
|
-
| `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'.
|
|
134
|
-
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'.
|
|
135
|
-
| `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends.
|
|
136
|
-
| `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data.
|
|
137
|
-
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date.
|
|
138
|
-
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date.
|
|
139
|
-
| `provider` | `no` | `string` | `famafrench` | - |
|
|
125
|
+
| `index` | `no` | `string` | `all` | International index to fetch the portfolio returns for. Defaults to 'all'. |
|
|
126
|
+
| `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'. |
|
|
127
|
+
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'. |
|
|
128
|
+
| `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends. |
|
|
129
|
+
| `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data. |
|
|
130
|
+
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
|
|
131
|
+
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
|
|
140
132
|
|
|
141
133
|
---
|
|
142
134
|
|
|
143
135
|
### `famafrench.regional_portfolio_returns`
|
|
144
136
|
|
|
145
137
|
```python
|
|
146
|
-
data.famafrench.regional_portfolio_returns(portfolio='developed_ex_us_6_portfolios_me_op', measure='value', frequency='monthly', start_date=None, end_date=None
|
|
138
|
+
data.famafrench.regional_portfolio_returns(portfolio='developed_ex_us_6_portfolios_me_op', measure='value', frequency='monthly', start_date=None, end_date=None)
|
|
147
139
|
```
|
|
148
140
|
|
|
149
141
|
Summary: Regional Portfolio Returns
|
|
@@ -153,7 +145,6 @@ Summary: Regional Portfolio Returns
|
|
|
153
145
|
| Endpoint ID | `famafrench.regional_portfolio_returns` |
|
|
154
146
|
| HTTP | `GET` |
|
|
155
147
|
| Path | `/inner/v1/agent-data/famafrench/regional_portfolio_returns` |
|
|
156
|
-
| Default provider | `famafrench` |
|
|
157
148
|
| SDK | `supported` |
|
|
158
149
|
| Host | `supported` |
|
|
159
150
|
| Notes | - |
|
|
@@ -162,19 +153,18 @@ Summary: Regional Portfolio Returns
|
|
|
162
153
|
|
|
163
154
|
| Param | Required | Type | Default | Notes |
|
|
164
155
|
|---|---|---|---|---|
|
|
165
|
-
| `portfolio` | `no` | `string` | `developed_ex_us_6_portfolios_me_op` | enum: asia_pacific_ex_japan_25_portfolios_me_be-me, asia_pacific_ex_japan_25_portfolios_me_be-me_daily, asia_pacific_ex_japan_25_portfolios_me_inv, asia_pacific_ex_japan_25_portfolios_me_inv_daily, asia_pacific_ex_japan_25_portfolios_me_op, asia_pacific_ex_japan_25_portfolios_me_op_daily, asia_pacific_ex_japan_25_portfolios_me_prior_12_2, asia_pacific_ex_japan_25_portfolios_me_prior_250_20_daily, asia_pacific_ex_japan_32_portfolios_me_be-me_inv_2x4x4, asia_pacific_ex_japan_32_portfolios_me_be-me_op_2x4x4, asia_pacific_ex_japan_32_portfolios_me_inv_op_2x4x4, asia_pacific_ex_japan_6_portfolios_me_be-me, asia_pacific_ex_japan_6_portfolios_me_be-me_daily, asia_pacific_ex_japan_6_portfolios_me_inv, asia_pacific_ex_japan_6_portfolios_me_inv_daily, asia_pacific_ex_japan_6_portfolios_me_op, asia_pacific_ex_japan_6_portfolios_me_op_daily, asia_pacific_ex_japan_6_portfolios_me_prior_12_2, asia_pacific_ex_japan_6_portfolios_me_prior_250_20_daily, developed_25_portfolios_me_be-me, developed_25_portfolios_me_be-me_daily, developed_25_portfolios_me_inv, developed_25_portfolios_me_inv_daily, developed_25_portfolios_me_op, developed_25_portfolios_me_op_daily, developed_25_portfolios_me_prior_12_2, developed_25_portfolios_me_prior_250_20_daily, developed_32_portfolios_me_be-me_inv_2x4x4, developed_32_portfolios_me_be-me_op_2x4x4, developed_32_portfolios_me_inv_op_2x4x4, developed_6_portfolios_me_be-me, developed_6_portfolios_me_be-me_daily, developed_6_portfolios_me_inv, developed_6_portfolios_me_inv_daily, developed_6_portfolios_me_op, developed_6_portfolios_me_op_daily, developed_6_portfolios_me_prior_12_2, developed_6_portfolios_me_prior_250_20_daily, developed_ex_us_25_portfolios_me_be-me, developed_ex_us_25_portfolios_me_be-me_daily, developed_ex_us_25_portfolios_me_inv, developed_ex_us_25_portfolios_me_inv_daily, developed_ex_us_25_portfolios_me_op, developed_ex_us_25_portfolios_me_op_daily, developed_ex_us_25_portfolios_me_prior_12_2, developed_ex_us_25_portfolios_me_prior_250_20_daily, developed_ex_us_32_portfolios_me_be-me_inv_2x4x4, developed_ex_us_32_portfolios_me_be-me_op_2x4x4, developed_ex_us_32_portfolios_me_inv_op_2x4x4, developed_ex_us_6_portfolios_me_be-me, developed_ex_us_6_portfolios_me_be-me_daily, developed_ex_us_6_portfolios_me_inv, developed_ex_us_6_portfolios_me_inv_daily, developed_ex_us_6_portfolios_me_op, developed_ex_us_6_portfolios_me_op_daily, developed_ex_us_6_portfolios_me_prior_12_2, developed_ex_us_6_portfolios_me_prior_250_20_daily, emerging_markets_4_portfolios_be-me_inv, emerging_markets_4_portfolios_be-me_op, emerging_markets_4_portfolios_op_inv, emerging_markets_6_portfolios_me_be-me, emerging_markets_6_portfolios_me_inv, emerging_markets_6_portfolios_me_op, emerging_markets_6_portfolios_me_prior_12_2, europe_25_portfolios_me_be-me, europe_25_portfolios_me_be-me_daily, europe_25_portfolios_me_inv, europe_25_portfolios_me_inv_daily, europe_25_portfolios_me_op, europe_25_portfolios_me_op_daily, europe_25_portfolios_me_prior_12_2, europe_25_portfolios_me_prior_250_20_daily, europe_32_portfolios_me_be-me_inv_2x4x4, europe_32_portfolios_me_be-me_op_2x4x4, europe_32_portfolios_me_inv_op_2x4x4, europe_6_portfolios_me_be-me, europe_6_portfolios_me_be-me_daily, europe_6_portfolios_me_inv, europe_6_portfolios_me_inv_daily, europe_6_portfolios_me_op, europe_6_portfolios_me_op_daily, europe_6_portfolios_me_prior_12_2, europe_6_portfolios_me_prior_250_20_daily, japan_25_portfolios_me_be-me, japan_25_portfolios_me_be-me_daily, japan_25_portfolios_me_inv, japan_25_portfolios_me_inv_daily, japan_25_portfolios_me_op, japan_25_portfolios_me_op_daily, japan_25_portfolios_me_prior_12_2, japan_25_portfolios_me_prior_250_20_daily, japan_32_portfolios_me_be-me_inv_2x4x4, japan_32_portfolios_me_be-me_op_2x4x4, japan_32_portfolios_me_inv_op_2x4x4, japan_6_portfolios_me_be-me, japan_6_portfolios_me_be-me_daily, japan_6_portfolios_me_inv, japan_6_portfolios_me_inv_daily, japan_6_portfolios_me_op, japan_6_portfolios_me_op_daily, japan_6_portfolios_me_prior_12_2, japan_6_portfolios_me_prior_250_20_daily, north_america_25_portfolios_me_be-me, north_america_25_portfolios_me_be-me_daily, north_america_25_portfolios_me_inv, north_america_25_portfolios_me_inv_daily, north_america_25_portfolios_me_op, north_america_25_portfolios_me_op_daily, north_america_25_portfolios_me_prior_12_2, north_america_25_portfolios_me_prior_250_20_daily, north_america_32_portfolios_me_be-me_inv_2x4x4, north_america_32_portfolios_me_be-me_op_2x4x4, north_america_32_portfolios_me_inv_op_2x4x4, north_america_6_portfolios_me_be-me, north_america_6_portfolios_me_be-me_daily, north_america_6_portfolios_me_inv, north_america_6_portfolios_me_inv_daily, north_america_6_portfolios_me_op, north_america_6_portfolios_me_op_daily, north_america_6_portfolios_me_prior_12_2, north_america_6_portfolios_me_prior_250_20_daily The specific portfolio file to fetch.
|
|
166
|
-
| `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio.
|
|
167
|
-
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when the portfolio ends with 'daily'.
|
|
168
|
-
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date.
|
|
169
|
-
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date.
|
|
170
|
-
| `provider` | `no` | `string` | `famafrench` | - |
|
|
156
|
+
| `portfolio` | `no` | `string` | `developed_ex_us_6_portfolios_me_op` | enum: asia_pacific_ex_japan_25_portfolios_me_be-me, asia_pacific_ex_japan_25_portfolios_me_be-me_daily, asia_pacific_ex_japan_25_portfolios_me_inv, asia_pacific_ex_japan_25_portfolios_me_inv_daily, asia_pacific_ex_japan_25_portfolios_me_op, asia_pacific_ex_japan_25_portfolios_me_op_daily, asia_pacific_ex_japan_25_portfolios_me_prior_12_2, asia_pacific_ex_japan_25_portfolios_me_prior_250_20_daily, asia_pacific_ex_japan_32_portfolios_me_be-me_inv_2x4x4, asia_pacific_ex_japan_32_portfolios_me_be-me_op_2x4x4, asia_pacific_ex_japan_32_portfolios_me_inv_op_2x4x4, asia_pacific_ex_japan_6_portfolios_me_be-me, asia_pacific_ex_japan_6_portfolios_me_be-me_daily, asia_pacific_ex_japan_6_portfolios_me_inv, asia_pacific_ex_japan_6_portfolios_me_inv_daily, asia_pacific_ex_japan_6_portfolios_me_op, asia_pacific_ex_japan_6_portfolios_me_op_daily, asia_pacific_ex_japan_6_portfolios_me_prior_12_2, asia_pacific_ex_japan_6_portfolios_me_prior_250_20_daily, developed_25_portfolios_me_be-me, developed_25_portfolios_me_be-me_daily, developed_25_portfolios_me_inv, developed_25_portfolios_me_inv_daily, developed_25_portfolios_me_op, developed_25_portfolios_me_op_daily, developed_25_portfolios_me_prior_12_2, developed_25_portfolios_me_prior_250_20_daily, developed_32_portfolios_me_be-me_inv_2x4x4, developed_32_portfolios_me_be-me_op_2x4x4, developed_32_portfolios_me_inv_op_2x4x4, developed_6_portfolios_me_be-me, developed_6_portfolios_me_be-me_daily, developed_6_portfolios_me_inv, developed_6_portfolios_me_inv_daily, developed_6_portfolios_me_op, developed_6_portfolios_me_op_daily, developed_6_portfolios_me_prior_12_2, developed_6_portfolios_me_prior_250_20_daily, developed_ex_us_25_portfolios_me_be-me, developed_ex_us_25_portfolios_me_be-me_daily, developed_ex_us_25_portfolios_me_inv, developed_ex_us_25_portfolios_me_inv_daily, developed_ex_us_25_portfolios_me_op, developed_ex_us_25_portfolios_me_op_daily, developed_ex_us_25_portfolios_me_prior_12_2, developed_ex_us_25_portfolios_me_prior_250_20_daily, developed_ex_us_32_portfolios_me_be-me_inv_2x4x4, developed_ex_us_32_portfolios_me_be-me_op_2x4x4, developed_ex_us_32_portfolios_me_inv_op_2x4x4, developed_ex_us_6_portfolios_me_be-me, developed_ex_us_6_portfolios_me_be-me_daily, developed_ex_us_6_portfolios_me_inv, developed_ex_us_6_portfolios_me_inv_daily, developed_ex_us_6_portfolios_me_op, developed_ex_us_6_portfolios_me_op_daily, developed_ex_us_6_portfolios_me_prior_12_2, developed_ex_us_6_portfolios_me_prior_250_20_daily, emerging_markets_4_portfolios_be-me_inv, emerging_markets_4_portfolios_be-me_op, emerging_markets_4_portfolios_op_inv, emerging_markets_6_portfolios_me_be-me, emerging_markets_6_portfolios_me_inv, emerging_markets_6_portfolios_me_op, emerging_markets_6_portfolios_me_prior_12_2, europe_25_portfolios_me_be-me, europe_25_portfolios_me_be-me_daily, europe_25_portfolios_me_inv, europe_25_portfolios_me_inv_daily, europe_25_portfolios_me_op, europe_25_portfolios_me_op_daily, europe_25_portfolios_me_prior_12_2, europe_25_portfolios_me_prior_250_20_daily, europe_32_portfolios_me_be-me_inv_2x4x4, europe_32_portfolios_me_be-me_op_2x4x4, europe_32_portfolios_me_inv_op_2x4x4, europe_6_portfolios_me_be-me, europe_6_portfolios_me_be-me_daily, europe_6_portfolios_me_inv, europe_6_portfolios_me_inv_daily, europe_6_portfolios_me_op, europe_6_portfolios_me_op_daily, europe_6_portfolios_me_prior_12_2, europe_6_portfolios_me_prior_250_20_daily, japan_25_portfolios_me_be-me, japan_25_portfolios_me_be-me_daily, japan_25_portfolios_me_inv, japan_25_portfolios_me_inv_daily, japan_25_portfolios_me_op, japan_25_portfolios_me_op_daily, japan_25_portfolios_me_prior_12_2, japan_25_portfolios_me_prior_250_20_daily, japan_32_portfolios_me_be-me_inv_2x4x4, japan_32_portfolios_me_be-me_op_2x4x4, japan_32_portfolios_me_inv_op_2x4x4, japan_6_portfolios_me_be-me, japan_6_portfolios_me_be-me_daily, japan_6_portfolios_me_inv, japan_6_portfolios_me_inv_daily, japan_6_portfolios_me_op, japan_6_portfolios_me_op_daily, japan_6_portfolios_me_prior_12_2, japan_6_portfolios_me_prior_250_20_daily, north_america_25_portfolios_me_be-me, north_america_25_portfolios_me_be-me_daily, north_america_25_portfolios_me_inv, north_america_25_portfolios_me_inv_daily, north_america_25_portfolios_me_op, north_america_25_portfolios_me_op_daily, north_america_25_portfolios_me_prior_12_2, north_america_25_portfolios_me_prior_250_20_daily, north_america_32_portfolios_me_be-me_inv_2x4x4, north_america_32_portfolios_me_be-me_op_2x4x4, north_america_32_portfolios_me_inv_op_2x4x4, north_america_6_portfolios_me_be-me, north_america_6_portfolios_me_be-me_daily, north_america_6_portfolios_me_inv, north_america_6_portfolios_me_inv_daily, north_america_6_portfolios_me_op, north_america_6_portfolios_me_op_daily, north_america_6_portfolios_me_prior_12_2, north_america_6_portfolios_me_prior_250_20_daily The specific portfolio file to fetch. |
|
|
157
|
+
| `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio. |
|
|
158
|
+
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when the portfolio ends with 'daily'. |
|
|
159
|
+
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
|
|
160
|
+
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
|
|
171
161
|
|
|
172
162
|
---
|
|
173
163
|
|
|
174
164
|
### `famafrench.us_portfolio_returns`
|
|
175
165
|
|
|
176
166
|
```python
|
|
177
|
-
data.famafrench.us_portfolio_returns(portfolio='portfolios_formed_on_me', measure='value', frequency='monthly', start_date=None, end_date=None
|
|
167
|
+
data.famafrench.us_portfolio_returns(portfolio='portfolios_formed_on_me', measure='value', frequency='monthly', start_date=None, end_date=None)
|
|
178
168
|
```
|
|
179
169
|
|
|
180
170
|
Summary: Us Portfolio Returns
|
|
@@ -184,7 +174,6 @@ Summary: Us Portfolio Returns
|
|
|
184
174
|
| Endpoint ID | `famafrench.us_portfolio_returns` |
|
|
185
175
|
| HTTP | `GET` |
|
|
186
176
|
| Path | `/inner/v1/agent-data/famafrench/us_portfolio_returns` |
|
|
187
|
-
| Default provider | `famafrench` |
|
|
188
177
|
| SDK | `supported` |
|
|
189
178
|
| Host | `supported` |
|
|
190
179
|
| Notes | - |
|
|
@@ -193,9 +182,8 @@ Summary: Us Portfolio Returns
|
|
|
193
182
|
|
|
194
183
|
| Param | Required | Type | Default | Notes |
|
|
195
184
|
|---|---|---|---|---|
|
|
196
|
-
| `portfolio` | `no` | `string` | `portfolios_formed_on_me` | enum: portfolios_formed_on_me, portfolios_formed_on_me_wout_div, portfolios_formed_on_me_daily, portfolios_formed_on_be-me, portfolios_formed_on_be-me_wout_div, portfolios_formed_on_be-me_daily, portfolios_formed_on_op, portfolios_formed_on_op_wout_div, portfolios_formed_on_op_daily, portfolios_formed_on_inv, portfolios_formed_on_inv_wout_div, portfolios_formed_on_inv_daily, 6_portfolios_2x3, 6_portfolios_2x3_wout_div, 6_portfolios_2x3_weekly, 6_portfolios_2x3_daily, 25_portfolios_5x5, 25_portfolios_5x5_wout_div, 25_portfolios_5x5_daily, 100_portfolios_10x10, 100_portfolios_10x10_wout_div, 100_portfolios_10x10_daily, 6_portfolios_me_op_2x3, 6_portfolios_me_op_2x3_wout_div, 6_portfolios_me_op_2x3_daily, 25_portfolios_me_op_5x5, 25_portfolios_me_op_5x5_wout_div, 25_portfolios_me_op_5x5_daily, 100_portfolios_me_op_10x10, 100_portfolios_10x10_me_op_wout_div, 100_portfolios_me_op_10x10_daily, 6_portfolios_me_inv_2x3, 6_portfolios_me_inv_2x3_wout_div, 6_portfolios_me_inv_2x3_daily, 25_portfolios_me_inv_5x5, 25_portfolios_me_inv_5x5_wout_div, 25_portfolios_me_inv_5x5_daily, 100_portfolios_me_inv_10x10, 100_portfolios_10x10_me_inv_wout_div, 100_portfolios_me_inv_10x10_daily, 25_portfolios_beme_op_5x5, 25_portfolios_beme_op_5x5_wout_div, 25_portfolios_beme_op_5x5_daily, 25_portfolios_beme_inv_5x5, 25_portfolios_beme_inv_5x5_wout_div, 25_portfolios_beme_inv_5x5_daily, 25_portfolios_op_inv_5x5, 25_portfolios_op_inv_5x5_wout_div, 25_portfolios_op_inv_5x5_daily, 32_portfolios_me_beme_op_2x4x4, 32_portfolios_me_beme_op_2x4x4_wout_div, 32_portfolios_me_beme_inv_2x4x4, 32_portfolios_me_beme_inv_2x4x4_wout_div, 32_portfolios_me_op_inv_2x4x4, 32_portfolios_me_op_inv_2x4x4_wout_div, portfolios_formed_on_e-p, portfolios_formed_on_e-p_wout_div, portfolios_formed_on_cf-p, portfolios_formed_on_cf-p_wout_div, portfolios_formed_on_d-p, portfolios_formed_on_d-p_wout_div, 6_portfolios_me_ep_2x3, 6_portfolios_me_ep_2x3_wout_div, 6_portfolios_me_cfp_2x3, 6_portfolios_me_cfp_2x3_wout_div, 6_portfolios_me_dp_2x3, 6_portfolios_me_dp_2x3_wout_div, 6_portfolios_me_prior_12_2, 6_portfolios_me_prior_12_2_daily, 25_portfolios_me_prior_12_2, 25_portfolios_me_prior_12_2_daily, 10_portfolios_prior_12_2, 10_portfolios_prior_12_2_daily, 6_portfolios_me_prior_1_0, 6_portfolios_me_prior_1_0_daily, 25_portfolios_me_prior_1_0, 25_portfolios_me_prior_1_0_daily, 10_portfolios_prior_1_0, 10_portfolios_prior_1_0_daily, 6_portfolios_me_prior_60_13, 6_portfolios_me_prior_60_13_daily, 25_portfolios_me_prior_60_13, 25_portfolios_me_prior_60_13_daily, 10_portfolios_prior_60_13, 10_portfolios_prior_60_13_daily, portfolios_formed_on_ac, 25_portfolios_me_ac_5x5, portfolios_formed_on_beta, 25_portfolios_me_beta_5x5, portfolios_formed_on_ni, 25_portfolios_me_ni_5x5, portfolios_formed_on_var, 25_portfolios_me_var_5x5, portfolios_formed_on_resvar, 25_portfolios_me_resvar_5x5, 5_industry_portfolios, 5_industry_portfolios_wout_div, 5_industry_portfolios_daily, 10_industry_portfolios, 10_industry_portfolios_wout_div, 10_industry_portfolios_daily, 12_industry_portfolios, 12_industry_portfolios_wout_div, 12_industry_portfolios_daily, 17_industry_portfolios, 17_industry_portfolios_wout_div, 17_industry_portfolios_daily, 30_industry_portfolios, 30_industry_portfolios_wout_div, 30_industry_portfolios_daily, 38_industry_portfolios, 38_industry_portfolios_wout_div, 38_industry_portfolios_daily, 48_industry_portfolios, 48_industry_portfolios_wout_div, 48_industry_portfolios_daily, 49_industry_portfolios, 49_industry_portfolios_wout_div, 49_industry_portfolios_daily The specific portfolio file to fetch.
|
|
197
|
-
| `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio.
|
|
198
|
-
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored if the portfolio ends with 'daily' or 'weekly'.
|
|
199
|
-
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date.
|
|
200
|
-
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date.
|
|
201
|
-
| `provider` | `no` | `string` | `famafrench` | - |
|
|
185
|
+
| `portfolio` | `no` | `string` | `portfolios_formed_on_me` | enum: portfolios_formed_on_me, portfolios_formed_on_me_wout_div, portfolios_formed_on_me_daily, portfolios_formed_on_be-me, portfolios_formed_on_be-me_wout_div, portfolios_formed_on_be-me_daily, portfolios_formed_on_op, portfolios_formed_on_op_wout_div, portfolios_formed_on_op_daily, portfolios_formed_on_inv, portfolios_formed_on_inv_wout_div, portfolios_formed_on_inv_daily, 6_portfolios_2x3, 6_portfolios_2x3_wout_div, 6_portfolios_2x3_weekly, 6_portfolios_2x3_daily, 25_portfolios_5x5, 25_portfolios_5x5_wout_div, 25_portfolios_5x5_daily, 100_portfolios_10x10, 100_portfolios_10x10_wout_div, 100_portfolios_10x10_daily, 6_portfolios_me_op_2x3, 6_portfolios_me_op_2x3_wout_div, 6_portfolios_me_op_2x3_daily, 25_portfolios_me_op_5x5, 25_portfolios_me_op_5x5_wout_div, 25_portfolios_me_op_5x5_daily, 100_portfolios_me_op_10x10, 100_portfolios_10x10_me_op_wout_div, 100_portfolios_me_op_10x10_daily, 6_portfolios_me_inv_2x3, 6_portfolios_me_inv_2x3_wout_div, 6_portfolios_me_inv_2x3_daily, 25_portfolios_me_inv_5x5, 25_portfolios_me_inv_5x5_wout_div, 25_portfolios_me_inv_5x5_daily, 100_portfolios_me_inv_10x10, 100_portfolios_10x10_me_inv_wout_div, 100_portfolios_me_inv_10x10_daily, 25_portfolios_beme_op_5x5, 25_portfolios_beme_op_5x5_wout_div, 25_portfolios_beme_op_5x5_daily, 25_portfolios_beme_inv_5x5, 25_portfolios_beme_inv_5x5_wout_div, 25_portfolios_beme_inv_5x5_daily, 25_portfolios_op_inv_5x5, 25_portfolios_op_inv_5x5_wout_div, 25_portfolios_op_inv_5x5_daily, 32_portfolios_me_beme_op_2x4x4, 32_portfolios_me_beme_op_2x4x4_wout_div, 32_portfolios_me_beme_inv_2x4x4, 32_portfolios_me_beme_inv_2x4x4_wout_div, 32_portfolios_me_op_inv_2x4x4, 32_portfolios_me_op_inv_2x4x4_wout_div, portfolios_formed_on_e-p, portfolios_formed_on_e-p_wout_div, portfolios_formed_on_cf-p, portfolios_formed_on_cf-p_wout_div, portfolios_formed_on_d-p, portfolios_formed_on_d-p_wout_div, 6_portfolios_me_ep_2x3, 6_portfolios_me_ep_2x3_wout_div, 6_portfolios_me_cfp_2x3, 6_portfolios_me_cfp_2x3_wout_div, 6_portfolios_me_dp_2x3, 6_portfolios_me_dp_2x3_wout_div, 6_portfolios_me_prior_12_2, 6_portfolios_me_prior_12_2_daily, 25_portfolios_me_prior_12_2, 25_portfolios_me_prior_12_2_daily, 10_portfolios_prior_12_2, 10_portfolios_prior_12_2_daily, 6_portfolios_me_prior_1_0, 6_portfolios_me_prior_1_0_daily, 25_portfolios_me_prior_1_0, 25_portfolios_me_prior_1_0_daily, 10_portfolios_prior_1_0, 10_portfolios_prior_1_0_daily, 6_portfolios_me_prior_60_13, 6_portfolios_me_prior_60_13_daily, 25_portfolios_me_prior_60_13, 25_portfolios_me_prior_60_13_daily, 10_portfolios_prior_60_13, 10_portfolios_prior_60_13_daily, portfolios_formed_on_ac, 25_portfolios_me_ac_5x5, portfolios_formed_on_beta, 25_portfolios_me_beta_5x5, portfolios_formed_on_ni, 25_portfolios_me_ni_5x5, portfolios_formed_on_var, 25_portfolios_me_var_5x5, portfolios_formed_on_resvar, 25_portfolios_me_resvar_5x5, 5_industry_portfolios, 5_industry_portfolios_wout_div, 5_industry_portfolios_daily, 10_industry_portfolios, 10_industry_portfolios_wout_div, 10_industry_portfolios_daily, 12_industry_portfolios, 12_industry_portfolios_wout_div, 12_industry_portfolios_daily, 17_industry_portfolios, 17_industry_portfolios_wout_div, 17_industry_portfolios_daily, 30_industry_portfolios, 30_industry_portfolios_wout_div, 30_industry_portfolios_daily, 38_industry_portfolios, 38_industry_portfolios_wout_div, 38_industry_portfolios_daily, 48_industry_portfolios, 48_industry_portfolios_wout_div, 48_industry_portfolios_daily, 49_industry_portfolios, 49_industry_portfolios_wout_div, 49_industry_portfolios_daily The specific portfolio file to fetch. |
|
|
186
|
+
| `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio. |
|
|
187
|
+
| `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored if the portfolio ends with 'daily' or 'weekly'. |
|
|
188
|
+
| `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
|
|
189
|
+
| `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
|