Skip to main content

Kalshi Trade API

Project description

kalshi_python

This library is the official python SDK for algorithmic trading on Kalshi.

This SDK is powered by Kalshi's trading api.

By using this SDK, you agree to Kalshi's Developer Agreement (https://kalshi.com/developer-agreement).

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install kalshi-python

Then import the package:

import kalshi_python 

Quick start

Please follow the installation procedure and then run the following:

import uuid
import kalshi_python
from kalshi_python.models import CreateOrderRequest
from pprint import pprint

config = kalshi_python.Configuration()
# Comment the line below to use production
config.host = 'https://demo-api.kalshi.co/trade-api/v2'

# Create an API configuration passing your credentials.
# Use this if you want the kalshi_python sdk to manage the authentication for your.
kalshi_api = kalshi_python.ApiInstance(
    email='YOUR_EMAIL_HERE',
    password='YOUR_PASSWORD_HERE',
    configuration=config,
)

# Optionally you can use the
exchangeStatus = kalshi_api.get_exchange_status()
print('Exchange status response: ')
pprint(exchangeStatus)

# Replace the series ticker with the market ticker you want.
marketTicker = 'FED-23DEC-T3.00'
marketResponse = kalshi_api.get_market(marketTicker)
print('\nMarket: ' + marketTicker)
pprint(marketResponse)

balanceResponse = kalshi_api.get_balance()
print('\nUser balance: ')
pprint(balanceResponse)

# Submit an order for 10 yes contracts at 50cents on 'FED-23DEC-T3.00'
orderUuid = str(uuid.uuid4())
orderResponse = kalshi_api.create_order(CreateOrderRequest(
    ticker=marketTicker,
    action='buy',
    type='limit',
    yes_price=50,
    count=10,
    client_order_id=orderUuid,
    side='yes',
))
print('\nOrder submitted: ')
pprint(orderResponse)

Additional resources

The documentation for the underlying web api used by the sdk can be found here.

Author

support@kalshi.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kalshi_python-1.2.0.tar.gz (51.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kalshi_python-1.2.0-py3-none-any.whl (141.0 kB view details)

Uploaded Python 3

File details

Details for the file kalshi_python-1.2.0.tar.gz.

File metadata

  • Download URL: kalshi_python-1.2.0.tar.gz
  • Upload date:
  • Size: 51.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for kalshi_python-1.2.0.tar.gz
Algorithm Hash digest
SHA256 334f3ccdfac94fe6bbcc1291e238f5f3daab28a1124d42478208e42fe36bc185
MD5 4ae95aa5ff49eb950c132cc67365d1d2
BLAKE2b-256 8fb7f0d28a39e68161b912c4edd9b6e7ed7130450c667e2327c3dfa136ce26e8

See more details on using hashes here.

File details

Details for the file kalshi_python-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: kalshi_python-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 141.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for kalshi_python-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 386cf9d90bf4b2d2f9abae7e2cbdce37ea891575778e4abba756cd70d65d8ee4
MD5 7c17eb1252e28e70ae6153fcef25cfe4
BLAKE2b-256 54a20f6397aac36298bc86d71e5dbe59343d580a79f33474ec27d1c61145be3f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page