Skip to content

docs: fix get_market examples #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cesarenaldi merged 1 commit into from
Jun 4, 2026
+4 −4
Merged

docs: fix get_market examples #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/sdk-direction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The default clients are synchronous:
from polymarket import PublicClient

client = PublicClient()
market = client.get_market("540816")
market = client.get_market(id="540816")
```

Async clients use explicit async client classes while retaining the same mental model:
Expand All @@ -26,7 +26,7 @@ Async clients use explicit async client classes while retaining the same mental
from polymarket import AsyncPublicClient

client = AsyncPublicClient()
market = await client.get_market("540816")
market = await client.get_market(id="540816")
```

We evaluated common Python SDKs in trading, exchange, and Web3 ecosystems. The most Pythonic convention is to keep unprefixed clients synchronous and expose async variants with an `Async` prefix, rather than using mode flags or adding separate `_async` methods to every sync client.
Expand All @@ -41,7 +41,7 @@ Clients that own network transports should support explicit cleanup. Synchronous
from polymarket import PublicClient

with PublicClient() as client:
market = client.get_market("540816")
market = client.get_market(id="540816")
```

Async clients should support the corresponding async context-manager pattern:
Expand All @@ -50,7 +50,7 @@ Async clients should support the corresponding async context-manager pattern:
from polymarket import AsyncPublicClient

async with AsyncPublicClient() as client:
market = await client.get_market("540816")
market = await client.get_market(id="540816")
```

Clients should also expose explicit `close()` methods. Async clients should expose `await client.close()` so callers that do not use `async with` can still release async HTTP sessions, sockets, or other transport resources deterministically.
Expand Down
Loading