This documentation describes Kalshi's rest API for market makers
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python >= 3.6
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import kalshiInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import kalshiPlease follow the installation procedure and then run the following:
import time
import kalshi
from pprint import pprint
from kalshi.api import account_api
from kalshi.model.change_subscription_request import ChangeSubscriptionRequest
from kalshi.model.get_notification_preferences_response import GetNotificationPreferencesResponse
from kalshi.model.user_get_account_history_response import UserGetAccountHistoryResponse
from kalshi.model.user_get_notifications_response import UserGetNotificationsResponse
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
host = "https://trading-api.kalshi.com/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Enter a context with an instance of the API client
with kalshi.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = account_api.AccountApi(api_client)
user_id = "user_id_example" # str | Should be filled with your user_id provided on log_in
change_subscription_request = ChangeSubscriptionRequest(
subscription_level="subscription_level_example",
) # ChangeSubscriptionRequest | Change subscription data (optional)
try:
# ChangeSubscription
api_instance.change_subscription(user_id, change_subscription_request=change_subscription_request)
except kalshi.ApiException as e:
print("Exception when calling AccountApi->change_subscription: %s\n" % e)All URIs are relative to https://trading-api.kalshi.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountApi | change_subscription | PUT /users/{user_id}/subscribe | ChangeSubscription |
| AccountApi | get_notification_preferences | GET /users/{user_id}/notifications/preferences | GetNotificationPreferences |
| AccountApi | notification_mark_read | PUT /users/{user_id}/notifications/{notification_id}/read | NotificationMarkRead |
| AccountApi | user_get_account_history | GET /users/{user_id}/account/history | UserGetAccountHistory |
| AccountApi | user_get_notifications | GET /users/{user_id}/notifications | UserGetNotifications |
| AuthApi | login | POST /log_in | Login |
| AuthApi | logout | POST /log_out | Logout |
| AuthApi | reset_password | POST /passwords/reset | ResetPassword |
| AuthApi | reset_password_confirm | PUT /passwords/reset/{code}/confirm | ResetPasswordConfirm |
| DefaultApi | get_trades | GET /trades | GetTrades |
| ExchangeApi | get_exchange_status | GET /exchange/status | |
| MarketApi | get_market | GET /markets/{market_id} | GetMarket |
| MarketApi | get_market_by_ticker | GET /markets_by_ticker/{ticker_name} | GetMarketByTicker |
| MarketApi | get_market_by_ticker_cached | GET /cached/markets_by_ticker/{ticker_name} | GetMarketByTickerCached |
| MarketApi | get_market_cached | GET /cached/markets/{market_id} | GetMarketCached |
| MarketApi | get_market_history | GET /markets/{market_id}/stats_history | GetMarketHistory |
| MarketApi | get_market_history_cached | GET /cached/markets/{market_id}/stats_history | GetMarketHistoryCached |
| MarketApi | get_market_order_book_cached | GET /markets/{market_id}/order_book | GetMarketOrderBookCached |
| MarketApi | get_markets | GET /markets | GetMarkets |
| MarketApi | get_markets_cached | GET /cached/markets | GetMarketsCached |
| PortfolioApi | user_get_portfolio_history | GET /users/{user_id}/portfolio/history | UserGetPortfolioHistory |
| RangedMarketApi | get_ranged_market | GET /ranged_markets/{ranged_market_id} | GetRangedMarket |
| RangedMarketsApi | get_ranged_market_by_ticker | GET /ranged_markets_by_ticker/{ticker} | GetRangedMarketByTicker |
| UserApi | user_add_watchlist | PUT /users/{user_id}/watchlist/{market_id} | UserAddWatchlist |
| UserApi | user_change_password | PUT /users/{user_id}/password | UserChangePassword |
| UserApi | user_get_balance | GET /users/{user_id}/balance | UserGetBalance |
| UserApi | user_get_market_position | GET /users/{user_id}/positions/{market_id} | UserGetMarketPosition |
| UserApi | user_get_market_positions | GET /users/{user_id}/positions | UserGetMarketPositions |
| UserApi | user_get_profile | GET /users/{user_id} | UserGetProfile |
| UserApi | user_get_watchlist | GET /users/{user_id}/watchlist | UserGetWatchlist |
| UserApi | user_order_cancel | DELETE /users/{user_id}/orders/{order_id} | UserOrderCancel |
| UserApi | user_order_create | POST /users/{user_id}/orders | UserOrderCreate |
| UserApi | user_order_decrease | POST /users/{user_id}/orders/{order_id}/decrease | UserOrderDecrease |
| UserApi | user_orders_get | GET /users/{user_id}/orders | UserOrdersGet |
| UserApi | user_remove_watchlist | DELETE /users/{user_id}/watchlist/{market_id} | UserRemoveWatchlist |
| UserApi | user_trades_get | GET /users/{user_id}/trades | UserTradesGet |
- AccountHistoryEntry
- AccountHistoryEntryData
- BankAccountDetails
- ChangeSubscriptionRequest
- ConfirmPasswordResetRequest
- CreateUserRequest
- CreateUserResponse
- Deposit
- DepositHistory
- GetMarketHistoryResponse
- GetMarketOrderBookResponse
- GetNotificationPreferencesResponse
- GetRangedMarketByTickerResponse
- GetRangedMarketResponse
- GetRangedMarketsResponse
- GetUserDepositsResponse
- GetUserWithdrawalsResponse
- LoginRequest
- LoginResponse
- Market
- MarketPosition
- MarketStatsPoint
- Notification
- NotificationList
- Order
- OrderBook
- OrderHistory
- OrderList
- PortfolioMeasurement
- PriceLevel
- PublicTrade
- PublicTradeList
- RangedMarket
- ResetPasswordRequest
- SettlementHistory
- SettlementSource
- SubscriptionPreference
- TradeHistory
- TradesGetResponse
- User
- UserChangePasswordRequest
- UserDepositRequest
- UserDepositResponse
- UserGetAccountHistoryResponse
- UserGetBalanceResponse
- UserGetMarketPositionResponse
- UserGetMarketPositionsResponse
- UserGetMarketResponse
- UserGetMarketsResponse
- UserGetNotificationsResponse
- UserGetPortfolioHistoryRequest
- UserGetPortfolioHistoryResponse
- UserGetPortfolioValueResponse
- UserGetProfileResponse
- UserGetWatchlistResponse
- UserListLedgerxBankAccountsResponse
- UserOrderCreateRequest
- UserOrderCreateResponse
- UserOrderDecreaseRequest
- UserOrderDecreaseResponse
- UserOrdersGetResponse
- UserTrade
- UserTradeList
- UserTradesGetResponse
- UserUpdateProfileRequest
- UserWithdrawalRequest
- UserWithdrawalResponse
- Watchlist
- Withdrawal
- WithdrawalHistory
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
If the OpenAPI document is large, imports in kalshi.apis and kalshi.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from kalshi.api.default_api import DefaultApifrom kalshi.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import kalshi
from kalshi.apis import *
from kalshi.models import *