0
# Regulatory and Research Data
1

2
Regulatory filings, academic research factors, and econometric analysis tools. This module provides access to regulatory data, academic research, and econometric modeling capabilities.
3

4
## Capabilities
5

6
### Regulatory Data
7

8
SEC filings and regulatory compliance data.
9

10
```python { .api }
11
def obb.regulators.rss_litigation(
12
    provider: str = None,
13
    **kwargs
14
) -> ResponseObject:
15
    """
16
    Get RSS litigation data.
17
    
18
    Parameters:
19
    - provider: Data provider to use
20
    
21
    Returns:
22
    ResponseObject with litigation data
23
    """
24

25
def obb.regulators.cik_map(
26
    provider: str = None,
27
    **kwargs
28
) -> ResponseObject:
29
    """
30
    Get CIK mapping data.
31
    
32
    Parameters:
33
    - provider: Data provider to use
34
    
35
    Returns:
36
    ResponseObject with CIK mappings
37
    """
38

39
def obb.regulators.symbol_map(
40
    provider: str = None,
41
    **kwargs
42
) -> ResponseObject:
43
    """
44
    Get symbol mapping data.
45
    
46
    Parameters:
47
    - provider: Data provider to use
48
    
49
    Returns:
50
    ResponseObject with symbol mappings
51
    """
52

53
def obb.regulators.sic_search(
54
    query: str,
55
    provider: str = None,
56
    **kwargs
57
) -> ResponseObject:
58
    """
59
    Search SIC codes.
60
    
61
    Parameters:
62
    - query: Search term
63
    - provider: Data provider to use
64
    
65
    Returns:
66
    ResponseObject with SIC search results
67
    """
68

69
def obb.regulators.htm_file(
70
    provider: str = None,
71
    **kwargs
72
) -> ResponseObject:
73
    """
74
    Get HTM file data.
75
    
76
    Parameters:
77
    - provider: Data provider to use
78
    
79
    Returns:
80
    ResponseObject with HTM file data
81
    """
82

83
def obb.regulators.schema_files(
84
    provider: str = None,
85
    **kwargs
86
) -> ResponseObject:
87
    """
88
    Get schema files.
89
    
90
    Parameters:
91
    - provider: Data provider to use
92
    
93
    Returns:
94
    ResponseObject with schema files
95
    """
96

97
def obb.regulators.institutions_search(
98
    query: str,
99
    provider: str = None,
100
    **kwargs
101
) -> ResponseObject:
102
    """
103
    Search institutions.
104
    
105
    Parameters:
106
    - query: Search term
107
    - provider: Data provider to use
108
    
109
    Returns:
110
    ResponseObject with institution search results
111
    """
112

113
def obb.regulators.filing_headers(
114
    provider: str = None,
115
    **kwargs
116
) -> ResponseObject:
117
    """
118
    Get filing headers.
119
    
120
    Parameters:
121
    - provider: Data provider to use
122
    
123
    Returns:
124
    ResponseObject with filing headers
125
    """
126
```
127

128
### Academic Research Factors
129

130
Fama-French research factors and academic finance data.
131

132
```python { .api }
133
def obb.famafrench.international_index_returns(
134
    provider: str = None,
135
    **kwargs
136
) -> ResponseObject:
137
    """
138
    Get international index returns.
139
    
140
    Parameters:
141
    - provider: Data provider to use
142
    
143
    Returns:
144
    ResponseObject with international index returns
145
    """
146

147
def obb.famafrench.regional_portfolio_returns(
148
    provider: str = None,
149
    **kwargs
150
) -> ResponseObject:
151
    """
152
    Get regional portfolio returns.
153
    
154
    Parameters:
155
    - provider: Data provider to use
156
    
157
    Returns:
158
    ResponseObject with regional portfolio returns
159
    """
160

161
def obb.famafrench.country_portfolio_returns(
162
    provider: str = None,
163
    **kwargs
164
) -> ResponseObject:
165
    """
166
    Get country portfolio returns.
167
    
168
    Parameters:
169
    - provider: Data provider to use
170
    
171
    Returns:
172
    ResponseObject with country portfolio returns
173
    """
174

175
def obb.famafrench.us_portfolio_returns(
176
    provider: str = None,
177
    **kwargs
178
) -> ResponseObject:
179
    """
180
    Get US portfolio returns.
181
    
182
    Parameters:
183
    - provider: Data provider to use
184
    
185
    Returns:
186
    ResponseObject with US portfolio returns
187
    """
188

189
def obb.famafrench.factors(
190
    provider: str = None,
191
    **kwargs
192
) -> ResponseObject:
193
    """
194
    Get Fama-French factors.
195
    
196
    Parameters:
197
    - provider: Data provider to use
198
    
199
    Returns:
200
    ResponseObject with Fama-French factors
201
    """
202

203
def obb.famafrench.breakpoints(
204
    provider: str = None,
205
    **kwargs
206
) -> ResponseObject:
207
    """
208
    Get Fama-French breakpoints.
209
    
210
    Parameters:
211
    - provider: Data provider to use
212
    
213
    Returns:
214
    ResponseObject with breakpoints data
215
    """
216
```
217

218
### Econometric Analysis
219

220
Econometric modeling and statistical analysis tools.
221

222
```python { .api }
223
def obb.econometrics.panel_random_effects(
224
    data: str,
225
    provider: str = None,
226
    **kwargs
227
) -> ResponseObject:
228
    """
229
    Perform panel random effects analysis.
230
    
231
    Parameters:
232
    - data: Input data
233
    - provider: Data provider to use
234
    
235
    Returns:
236
    ResponseObject with random effects results
237
    """
238

239
def obb.econometrics.panel_first_difference(
240
    data: str,
241
    provider: str = None,
242
    **kwargs
243
) -> ResponseObject:
244
    """
245
    Perform panel first difference analysis.
246
    
247
    Parameters:
248
    - data: Input data
249
    - provider: Data provider to use
250
    
251
    Returns:
252
    ResponseObject with first difference results
253
    """
254

255
def obb.econometrics.panel_pooled(
256
    data: str,
257
    provider: str = None,
258
    **kwargs
259
) -> ResponseObject:
260
    """
261
    Perform panel pooled analysis.
262
    
263
    Parameters:
264
    - data: Input data
265
    - provider: Data provider to use
266
    
267
    Returns:
268
    ResponseObject with pooled analysis results
269
    """
270

271
def obb.econometrics.correlation_matrix(
272
    data: str,
273
    provider: str = None,
274
    **kwargs
275
) -> ResponseObject:
276
    """
277
    Calculate correlation matrix.
278
    
279
    Parameters:
280
    - data: Input data
281
    - provider: Data provider to use
282
    
283
    Returns:
284
    ResponseObject with correlation matrix
285
    """
286

287
def obb.econometrics.cointegration(
288
    data: str,
289
    provider: str = None,
290
    **kwargs
291
) -> ResponseObject:
292
    """
293
    Perform cointegration analysis.
294
    
295
    Parameters:
296
    - data: Input data
297
    - provider: Data provider to use
298
    
299
    Returns:
300
    ResponseObject with cointegration results
301
    """
302

303
def obb.econometrics.variance_inflation_factor(
304
    data: str,
305
    provider: str = None,
306
    **kwargs
307
) -> ResponseObject:
308
    """
309
    Calculate variance inflation factor.
310
    
311
    Parameters:
312
    - data: Input data
313
    - provider: Data provider to use
314
    
315
    Returns:
316
    ResponseObject with VIF results
317
    """
318

319
def obb.econometrics.panel_fixed(
320
    data: str,
321
    provider: str = None,
322
    **kwargs
323
) -> ResponseObject:
324
    """
325
    Perform panel fixed effects analysis.
326
    
327
    Parameters:
328
    - data: Input data
329
    - provider: Data provider to use
330
    
331
    Returns:
332
    ResponseObject with fixed effects results
333
    """
334

335
def obb.econometrics.causality(
336
    data: str,
337
    provider: str = None,
338
    **kwargs
339
) -> ResponseObject:
340
    """
341
    Perform causality analysis.
342
    
343
    Parameters:
344
    - data: Input data
345
    - provider: Data provider to use
346
    
347
    Returns:
348
    ResponseObject with causality test results
349
    """
350
```
351

352
## Usage Examples
353

354
### Regulatory Data Analysis
355

356
```python
357
from openbb import obb
358

359
# Search institutions
360
institutions = obb.regulators.institutions_search(query="Bank")
361
inst_df = institutions.to_dataframe()
362

363
# Get CIK mapping
364
cik_data = obb.regulators.cik_map()
365
cik_df = cik_data.to_dataframe()
366
```
367

368
### Academic Research Factors
369

370
```python
371
# Access Fama-French factors
372
# Get Fama-French factors
373
factors_data = obb.famafrench.factors()
374
factors_df = factors_data.to_dataframe()
375

376
# Get US portfolio returns
377
us_returns = obb.famafrench.us_portfolio_returns()
378
us_df = us_returns.to_dataframe()
379
```
380

381
### Econometric Modeling
382

383
```python
384
# Access econometric analysis tools
385
# Calculate correlation matrix
386
corr_data = obb.econometrics.correlation_matrix(data="panel_data")
387
corr_df = corr_data.to_dataframe()
388

389
# Perform cointegration analysis
390
coint_data = obb.econometrics.cointegration(data="time_series")
391
coint_df = coint_data.to_dataframe()
392
```
393

394
### Research Workflow
395

396
```python
397
# Retrieve regulatory filings for compliance analysis
398
# Use academic factors for portfolio attribution
399
# Perform econometric analysis on financial time series
400
```