fix: handle position display fields#88
Open
rupurt wants to merge 1 commit into
Open
Conversation
This was referenced Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds support for ProjectX Gateway position payloads that include
contractDisplayNameand other additive fields.Root Cause
search_open_positions()passed raw Gateway position payloads directly toPosition(**pos). Gateway responses can includecontractDisplayName, which was not modeled by the SDK and caused construction to fail when present.Changes
contractDisplayNameto thePositionmodel.contractDisplayNameto thePositionResponseTypedDict.Positionfields so unknown future Gateway fields do not crash the SDK.contractDisplayNamewhile ignoring an unknown Gateway field.Scope
This PR is intentionally independent from the trade endpoint and trade response normalization PRs. It contains one commit on top of
mainand only touches position response handling.Validation
uv run pytest tests/client/test_trading.py tests/client/test_trading_legacy.py tests/types/test_models.py tests/types/test_api_responses.py -quv run ruff check src/project_x_py/client/trading.py src/project_x_py/models.py src/project_x_py/types/api_responses.py tests/client/test_trading_legacy.py tests/types/test_models.py tests/types/test_api_responses.pyuv run ruff format --check src/project_x_py/client/trading.py src/project_x_py/models.py src/project_x_py/types/api_responses.py tests/client/test_trading_legacy.py tests/types/test_models.py tests/types/test_api_responses.pyuv run mypy src/project_x_py/client/trading.py src/project_x_py/models.py src/project_x_py/types/api_responses.py