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 *
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 you.
kalshi_api = kalshi_python.ApiInstance(
    email='YOUR_EMAIL_HERE',
    password='YOUR_PASSWORD_HERE',
    configuration=config,
)

# Alternatively you can manage the authentication yourself by doing:
# kalshi_api = kalshi_python.ApiInstance(
#     configuration=config,
# )
# loginResponse = kalshi_api.login(LoginRequest(email='YOUR_EMAIL_HERE', password='YOUR_PASSWORD_HERE'))
# token = loginResponse.token
# kalshi_api.set_api_token(loginResponse.token)
# # The token used above can eventually expire if you stop using it for more than 30 minutes.
# # In that case you should redo the process by doing a new login request and setting the api token again in the same way.

# Checks if the exchange is available.
exchangeStatus = kalshi_api.get_exchange_status()
print('Exchange status response: ')
pprint(exchangeStatus)

# Gets the data for a specific series.
seriesTicker = 'FED'
seriesResponse = kalshi_api.get_series(seriesTicker)
print('\nSeries: ' + seriesTicker)
pprint(seriesResponse)

# Gets the events for a specific series.
seriesTicker = 'FED'
eventsResponse = kalshi_api.get_events(series_ticker=seriesTicker)
print('\nEvents for series: ' + seriesTicker)
pprint(eventsResponse)

# Gets the data for a specific event.
eventTicker = 'FED-23DEC'
eventResponse = kalshi_api.get_event(eventTicker)
print('\nEvent: ' + seriesTicker)
pprint(eventResponse)

# Gets the data for a specific market.
marketTicker = 'FED-23DEC-T3.00'
marketResponse = kalshi_api.get_market(marketTicker)
print('\nMarket: ' + marketTicker)
pprint(marketResponse)

# Gets the orderbook for a specific market.
marketTicker = 'FED-23DEC-T3.00'
orderbookResponse = kalshi_api.get_market_orderbook(marketTicker)
print('\nOrderbook for market: ' + marketTicker)
pprint(orderbookResponse)

# Gets the market price history for a specific market.
marketTicker = 'FED-23DEC-T3.00'
historyResponse = kalshi_api.get_market_history(marketTicker)
print('\nMarket price history for market: ' + marketTicker)
pprint(historyResponse)

# Gets the balance for your kalshi account.
balanceResponse = kalshi_api.get_balance()
print('\nUser balance: ')
pprint(balanceResponse)

if exchangeStatus.trading_active:
    # 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)
else:
    print('\nThe exchange is not trading active, no orders will be sent right now.')

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-2.0.0.tar.gz (55.4 kB view details)

Uploaded Source

Built Distribution

kalshi_python-2.0.0-py3-none-any.whl (150.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kalshi_python-2.0.0.tar.gz
  • Upload date:
  • Size: 55.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for kalshi_python-2.0.0.tar.gz
Algorithm Hash digest
SHA256 c9b3bb3beaf14b7ad2a3a18dfc5642fc18529e57c7e7ff93a49912c61441618c
MD5 4aa5df314ef6e0e3bd064792ecbb57cc
BLAKE2b-256 e2002540596592882201a29546ddb6a20449538f8ff3b558e63e36e62d5e96a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kalshi_python-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 150.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for kalshi_python-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a454b4f41d118ba1987c77f3741fcb56dff7d3b73324f91bb6b9e99e2d21d27
MD5 1e05d8f4f013f31cf77885f0d6e87e14
BLAKE2b-256 10bd40228e277cca20ec07e9b59f429fd87311d8921471ced8828b6741cb1d6d

See more details on using hashes here.

Supported by

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