0
# Derivatives and Options
1
2
Options and derivatives data including options pricing, Greeks, volatility analysis, and derivatives market information. The derivatives module provides comprehensive options and derivatives analytics.
3
4
## Capabilities
5
6
### Options Data
7
8
Comprehensive options market data including pricing, Greeks, and volatility metrics.
9
10
```python { .api }
11
def obb.derivatives.chains(
12
symbol: str,
13
provider: str = None,
14
**kwargs
15
) -> ResponseObject:
16
"""
17
Get options chains data.
18
19
Parameters:
20
- symbol: Underlying symbol
21
- provider: Data provider to use
22
23
Returns:
24
ResponseObject with options chains data
25
"""
26
27
def obb.derivatives.snapshots(
28
provider: str = None,
29
**kwargs
30
) -> ResponseObject:
31
"""
32
Get derivatives market snapshots.
33
34
Parameters:
35
- provider: Data provider to use
36
37
Returns:
38
ResponseObject with derivatives snapshots
39
"""
40
41
def obb.derivatives.surface(
42
symbol: str,
43
provider: str = None,
44
**kwargs
45
) -> ResponseObject:
46
"""
47
Get options volatility surface data.
48
49
Parameters:
50
- symbol: Underlying symbol
51
- provider: Data provider to use
52
53
Returns:
54
ResponseObject with volatility surface data
55
"""
56
57
def obb.derivatives.unusual(
58
provider: str = None,
59
**kwargs
60
) -> ResponseObject:
61
"""
62
Get unusual options activity.
63
64
Parameters:
65
- provider: Data provider to use
66
67
Returns:
68
ResponseObject with unusual options activity
69
"""
70
71
def obb.derivatives.instruments(
72
provider: str = None,
73
**kwargs
74
) -> ResponseObject:
75
"""
76
Get derivatives instruments information.
77
78
Parameters:
79
- provider: Data provider to use
80
81
Returns:
82
ResponseObject with derivatives instruments
83
"""
84
85
def obb.derivatives.historical(
86
symbol: str,
87
provider: str = None,
88
**kwargs
89
) -> ResponseObject:
90
"""
91
Get historical derivatives data.
92
93
Parameters:
94
- symbol: Derivatives symbol
95
- provider: Data provider to use
96
97
Returns:
98
ResponseObject with historical derivatives data
99
"""
100
101
def obb.derivatives.info(
102
symbol: str,
103
provider: str = None,
104
**kwargs
105
) -> ResponseObject:
106
"""
107
Get derivatives contract information.
108
109
Parameters:
110
- symbol: Derivatives symbol
111
- provider: Data provider to use
112
113
Returns:
114
ResponseObject with contract information
115
"""
116
117
def obb.derivatives.curve(
118
symbol: str,
119
provider: str = None,
120
**kwargs
121
) -> ResponseObject:
122
"""
123
Get derivatives yield curve data.
124
125
Parameters:
126
- symbol: Underlying symbol
127
- provider: Data provider to use
128
129
Returns:
130
ResponseObject with yield curve data
131
"""
132
```
133
134
## Usage Examples
135
136
### Options Analysis
137
138
```python
139
from openbb import obb
140
141
# Get options chains
142
chains_data = obb.derivatives.chains(symbol="AAPL")
143
chains_df = chains_data.to_dataframe()
144
145
# Get unusual options activity
146
unusual_data = obb.derivatives.unusual()
147
unusual_df = unusual_data.to_dataframe()
148
149
# Get volatility surface
150
surface_data = obb.derivatives.surface(symbol="AAPL")
151
surface_df = surface_data.to_dataframe()
152
```
153
154
### Derivatives Workflow
155
156
```python
157
# Analyze options chains for specific stocks
158
# Calculate option Greeks and risk metrics
159
# Monitor options volume and unusual activity
160
```