"limit" parameter does not work with list_snapshot_options_chain

[KarmicTrades]

Describe the bug
list_snapshot_options_chain always seems to return all results, and not the limit. On the polygon.io test page, the limit parameter works, but not via this client.

To Reproduce
The code is simple, and should only return one result, but returns 312 for this example, no matter what you set "limit" to:

tickers = []

for o in client.list_snapshot_options_chain(
    underlying_asset = "SPY",
    params = {
    "expiration_date": "2025-04-07",
    "limit": 1
    }
):
    tickers.append(o)

print(len(tickers))

Expected behavior
A number of results equal to what I set "limit" parameter to.

[justinpolygon]

Hey @KarmicTrades , thanks for reporting this. You're right that the limit parameter isn't working the way you might expect in this case. The reason is that the list_snapshot_options_chain function, like many of the list_* methods in our Python client, automatically paginates behind the scenes. If the API response includes a next_url, the client will continue fetching and appending results until all pages have been retrieved.

This design helps users who want the full result set without managing pagination manually. But we realize that in cases like yours, where you're trying to enforce a strict result limit, it can lead to confusion.

You can see this behavior in action if you enable debug mode on the client:

client = RESTClient(trace=True)

With debug mode enabled, the client will print detailed information for each request, including the URL and headers:

Request URL: https://api.polygon.io/v3/snapshot/options/SPY?expiration_date=2025-04-07&limit=1
Request Headers: {'Authorization': 'Bearer REDACTED', 'Accept-Encoding': 'gzip', 'User-Agent': 'Polygon.io PythonClient/1.x.x'}
Response Headers: {...}

This output can be helpful for understanding how the client is handling pagination. We’ve talked internally about adding a flag to disable automatic pagination on a per-call basis. That would allow you to control exactly how many results are returned and avoid pulling additional pages. We don’t have that in place today, but it’s on our radar. In the meantime, I’ll add a note to the README to make this behavior clearer.

I know this probably isn’t the answer you were hoping for, but I hope it helps clarify the behavior and the reasoning behind it. Let us know what you're trying to achieve and we might be able to suggest a more specific workaround.