docs: add order requirements section#302
Open
dr-gideon wants to merge 1 commit intoPolymarket:mainfrom
Open
Conversation
docs: document order requirements (minimum size, tick size, price range) Adds an "Order requirements" section after the limit order example, documenting the minimum order size (5 shares), tick size (0.01), and valid price range. Fixes Polymarket#301 — users placing small orders are getting Size lower than the minimum: 5 errors with no guidance in the docs.
|
This is a really good piece of documentation to include. It should realistically also go in the upstream REST API docs, as I think most people using the APIs have to find this out the hard way (manually). |
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.
Overview
Adds an "Order requirements" section to the README documenting minimum order size, tick size, and valid price range. Addresses user confusion reported in #301.
Description
Added a new section between "Place a limit order" and "Manage orders" that documents:
Minimum order size (5 shares)
Minimum tick size (0.01)
Valid price range (0.01–0.99)
A common pitfall note explaining why small dollar amounts at high prices get rejected
Types of changes
Other, additional
Notes
Fixes #301 - users placing small dollar orders are getting Size lower than the minimum: 5 errors with no explanation in the docs.
Status
Prefix PR title with [WIP] if necessary (changes not yet made).
Add tests to cover changes as needed.
Update documentation/changelog as needed.
Verify all tests run correctly in CI and pass.
Ready for review/merge.
Note
Low Risk
Low risk documentation-only change; no runtime code paths are modified.
Overview
Adds an "Order requirements" section to
README.mddescribing the minimum order size (5 shares), minimum tick size (0.01), valid price range (0.01–0.99), and a note on small-$ orders at high prices causingSize lower than the minimum: 5rejections.Also fixes a minor README formatting issue at the end of the file (removes a stray leading
-and restores the trailing newline).Written by Cursor Bugbot for commit 72da864. This will update automatically on new commits. Configure here.