Fix invalid order field names in help text and README#6
Open
rursache wants to merge 1 commit intoPolymarket:mainfrom
Open
Fix invalid order field names in help text and README#6rursache wants to merge 1 commit intoPolymarket:mainfrom
rursache wants to merge 1 commit intoPolymarket:mainfrom
Conversation
The API accepts `volume` and `liquidity` as order fields, not `volume_num` and `liquidity_num` (those are response fields). Using the documented examples produced a 422 validation error.
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
--order volume_num→--order volumein README example and CLI help textvolume_numandliquidity_numas order parameters with a 422 error; the valid values arevolumeandliquidityRoot cause
volume_numandliquidity_numare field names on the Market response object (used for display), but the API/marketsendpoint expectsvolumeandliquidityasorderquery parameter values. The README and CLI help text were using the response field names instead of the query parameter names.Test plan
cargo test— all tests passpolymarket markets list --active true --order volumereturns resultspolymarket markets list --active true --order volume_numreturns 422 (before fix, this was the documented usage)Note
Low Risk
Documentation/help-text only; no runtime logic changes beyond the displayed usage guidance.
Overview
Fixes
markets list --orderdocumentation to use API-valid sort fields: updates the README example and the CLI flag help text fromvolume_num/liquidity_numtovolume/liquidityto avoid 422 errors from the/marketsendpoint.Written by Cursor Bugbot for commit 1306510. This will update automatically on new commits. Configure here.