Skip to content

docs: add overview of common API endpoints #35

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

Open
patridunk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add overview of common API endpoints #35

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
15 changes: 15 additions & 0 deletions docs/ENDPOINTS_OVERVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Kalshi API endpoints overview

This document summarizes some common API endpoints used by the examples in this repository. It complements the official API documentation.

| Endpoint | Purpose | Method |
|---------------------------------|--------------------------------------------|--------|
| `/markets` | List markets with optional filters | GET |
| `/markets/{ticker}` | Get details of a specific market | GET |
| `/orders` | Place a new order | POST |
| `/orders/{order_id}` | Retrieve or cancel an existing order | GET/DELETE |
| `/positions` | List current positions | GET |

See the official Kalshi API docs for query parameters and response schemas. Use these endpoints with the SDK or via direct HTTP if needed.

When adding new example scripts, please reference or update this overview.