Skip to content

docs: add project purpose section #25

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
ManyChavez wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add project purpose section #25

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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# kalshi-starter-code-python
Example python code for accessing api-authenticated endpoints on [Kalshi](https://kalshi.com). This is not an SDK.

## Project Purpose

This repository provides minimal starter examples for interacting with the Kalshi API using Python.
It is intended for learning and experimentation rather than production trading.

## Installation
Install requirements.txt in a virtual environment of your choice and execute main.py from within the repo.

Expand Down