0
# Fixed Income Securities
1

2
Bond and fixed income data including government bonds, corporate bonds, yield curves, and fixed income analytics. The fixed income module provides comprehensive access to bond market data and analytics.
3

4
## Capabilities
5

6
### Fixed Income Data Access
7

8
Comprehensive bond market data including government and corporate securities, yield curves, and fixed income analytics.
9

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

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

39
def obb.fixedincome.sofr(
40
    provider: str = None,
41
    **kwargs
42
) -> ResponseObject:
43
    """
44
    Get SOFR (Secured Overnight Financing Rate) data.
45
    
46
    Parameters:
47
    - provider: Data provider to use
48
    
49
    Returns:
50
    ResponseObject with SOFR data
51
    """
52

53
def obb.fixedincome.iorb(
54
    provider: str = None,
55
    **kwargs
56
) -> ResponseObject:
57
    """
58
    Get IORB (Interest on Reserve Balances) data.
59
    
60
    Parameters:
61
    - provider: Data provider to use
62
    
63
    Returns:
64
    ResponseObject with IORB data
65
    """
66

67
def obb.fixedincome.effr(
68
    provider: str = None,
69
    **kwargs
70
) -> ResponseObject:
71
    """
72
    Get EFFR (Effective Federal Funds Rate) data.
73
    
74
    Parameters:
75
    - provider: Data provider to use
76
    
77
    Returns:
78
    ResponseObject with EFFR data
79
    """
80

81
def obb.fixedincome.overnight_bank_funding(
82
    provider: str = None,
83
    **kwargs
84
) -> ResponseObject:
85
    """
86
    Get overnight bank funding data.
87
    
88
    Parameters:
89
    - provider: Data provider to use
90
    
91
    Returns:
92
    ResponseObject with overnight bank funding data
93
    """
94

95
def obb.fixedincome.effr_forecast(
96
    provider: str = None,
97
    **kwargs
98
) -> ResponseObject:
99
    """
100
    Get EFFR forecast data.
101
    
102
    Parameters:
103
    - provider: Data provider to use
104
    
105
    Returns:
106
    ResponseObject with EFFR forecast
107
    """
108

109
def obb.fixedincome.ameribor(
110
    provider: str = None,
111
    **kwargs
112
) -> ResponseObject:
113
    """
114
    Get AMERIBOR data.
115
    
116
    Parameters:
117
    - provider: Data provider to use
118
    
119
    Returns:
120
    ResponseObject with AMERIBOR data
121
    """
122
```
123

124
## Usage Examples
125

126
### Basic Fixed Income Data
127

128
```python
129
from openbb import obb
130

131
# Get SOFR data
132
sofr_data = obb.fixedincome.sofr()
133
sofr_df = sofr_data.to_dataframe()
134

135
# Get bond indices
136
indices_data = obb.fixedincome.bond_indices()
137
indices_df = indices_data.to_dataframe()
138

139
# Get EFFR data
140
effr_data = obb.fixedincome.effr()
141
effr_df = effr_data.to_dataframe()
142
```
143

144
### Bond Analysis Workflow
145

146
```python
147
# Retrieve yield curve data
148
# Analyze credit spreads and bond performance
149
# Compare government vs corporate bond yields
150
```