You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
LiveDataResource.get_typed is the legacy URL form — name implies type-safety, not legacy #336
The method is named get_typed, which suggests a more-strongly-typed variant of get. In reality the only difference is the URL: get_typed hits the legacy /live_data/{type}/milestone/{milestone_id} path, while get hits the canonical /live_data/milestone/{milestone_id}. Both return the same LiveData model with the same annotations. The docstring acknowledges this with "Legacy ..." and "Prefer :meth:get.", but a reader scanning autocomplete will likely reach for the newer-sounding get_typed over get when the opposite is correct.
Evidence
kalshi/resources/live_data.py:43-68
defget_typed(
self,
milestone_type: str,
milestone_id: str,
...
) ->LiveData:
"""Legacy ``/live_data/{type}/milestone/{milestone_id}`` shape. ... Prefer :meth:`get`. The spec marks this endpoint as the legacy form retained for backward compatibility. """
docs/resources/live-data.md:54 — section heading already labels it Legacy get_typed.
Suggested fix
Rename get_typed → get_legacy (or get_by_type) on both LiveDataResource and AsyncLiveDataResource. Keep get_typed as a one-version DeprecationWarning alias that forwards to the new name. Update the docs/resources/live-data.md section heading and surface the new name in any export lists.
Activity
docs: fix resource-doc drift (#318, #319, #320, #336) (#358)