Skip to content

Commit 5a015ce

Browse files
committed
doc changes
1 parent f42d3ba commit 5a015ce

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

polygon/rest/snapshot.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from .base import BaseClient
2-
from typing import Optional, Any, Dict, List, Union
2+
from typing import Optional, Any, Dict, List, Union, Iterator
33
from .models import (
44
TickerSnapshot,
55
Direction,
@@ -143,12 +143,11 @@ def list_snapshot_options_chain(
143143
params: Optional[Dict[str, Any]] = None,
144144
raw: bool = False,
145145
options: Optional[RequestOptionBuilder] = None,
146-
) -> Union[List[OptionContractSnapshot], HTTPResponse]:
146+
) -> Union[Iterator[OptionContractSnapshot], HTTPResponse]:
147147
"""
148-
Get the snapshot of an option contract for a stock equity.
148+
Get the snapshot of all options contracts for an underlying ticker.
149149
150150
:param underlying_asset: The underlying ticker symbol of the option contract.
151-
:param option_contract: The option contract identifier.
152151
:return: List of Snapshots
153152
"""
154153
url = f"/v3/snapshot/options/{underlying_asset}"

0 commit comments

Comments
 (0)