Skip to content

docs: add order requirements section#302

Open
dr-gideon wants to merge 1 commit intoPolymarket:mainfrom
dr-gideon:patch-1
Open

docs: add order requirements section#302
dr-gideon wants to merge 1 commit intoPolymarket:mainfrom
dr-gideon:patch-1

Conversation

@dr-gideon
Copy link
Copy Markdown

@dr-gideon dr-gideon commented Mar 19, 2026

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.md describing 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 causing Size lower than the minimum: 5 rejections.

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.

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.
@dr-gideon dr-gideon requested a review from a team as a code owner March 19, 2026 22:17
@dr-gideon dr-gideon changed the title add order requirements section docs: add order requirements section Mar 19, 2026
@RecRanger
Copy link
Copy Markdown

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

message="PolyApiException[status_code=400, error_message={'error': 'order 0xxxx is invalid. Size (1.08) lower than the minimum: 5'}]"

2 participants