Skip to content

Document list_markets response shape in README #2

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
polyorderbooks merged 2 commits into from
Aug 5, 2026
Merged

Document list_markets response shape in README #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9e185c
Document list_markets response shape in README quickstart.
polyorderbooks Aug 5, 2026
1145045
Show markets["data"] as a separate JSON example with three fields.
polyorderbooks Aug 5, 2026
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,23 @@ for outcome, points in books["data"].items():
client.close()
```

`markets["data"]` is a list of market objects. Each item includes more fields (`public_id`, `volume`, `event_slug`, …); the essentials look like:

```json
[
{
"slug": "will-bitcoin-hit-150k-in-2026",
"question": "Will Bitcoin hit $150k in 2026?",
"status": "active"
},
{
"slug": "fed-rate-cut-september-2026",
"question": "Will the Fed cut rates in September 2026?",
"status": "active"
}
]
```

Context manager usage:

```python
Expand Down
Loading