All URIs are relative to https://api.elections.kalshi.com/trade-api/v2
MethodHTTP requestDescription
get_milestoneGET /milestones/Get Milestone
get_milestonesGET /milestonesGet Milestones

get_milestone

GetMilestoneResponse get_milestone(milestone_id)
Get Milestone Get a single milestone by ID

Example

import kalshi_python
from kalshi_python.models.get_milestone_response import GetMilestoneResponse
from kalshi_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elections.kalshi.com/trade-api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi_python.Configuration(
    host = "https://api.elections.kalshi.com/trade-api/v2"
)

# Read private key from file
with open('path/to/private_key.pem', 'r') as f:
    private_key = f.read()

# Configure API key authentication
configuration.api_key_id = "your-api-key-id"
configuration.private_key_pem = private_key

# Initialize the Kalshi client
client = kalshi_python.KalshiClient(configuration)

milestone_id = 'milestone_id_example' # str | Milestone ID

try:
    # Get Milestone
    api_response = client.get_milestone(milestone_id)
    print("The response of MilestonesApi->get_milestone:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling MilestonesApi->get_milestone: %s\n" % e)

Parameters

NameTypeDescriptionNotes
milestone_idstrMilestone ID

Return type

GetMilestoneResponse

HTTP response details

Status codeDescription
200Milestone retrieved successfully
401Unauthorized - authentication required
404Resource not found
500Internal server error
[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_milestones

GetMilestonesResponse get_milestones(status=status, limit=limit)
Get Milestones Get all milestones

Example

import kalshi_python
from kalshi_python.models.get_milestones_response import GetMilestonesResponse
from kalshi_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elections.kalshi.com/trade-api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi_python.Configuration(
    host = "https://api.elections.kalshi.com/trade-api/v2"
)

# Read private key from file
with open('path/to/private_key.pem', 'r') as f:
    private_key = f.read()

# Configure API key authentication
configuration.api_key_id = "your-api-key-id"
configuration.private_key_pem = private_key

# Initialize the Kalshi client
client = kalshi_python.KalshiClient(configuration)

status = 'status_example' # str | Filter by milestone status (optional)

limit = 100 # int | Number of items per page (minimum 1, maximum 500) (optional) (default to 100)

try:
    # Get Milestones
    api_response = client.get_milestones(status=status, limit=limit)
    print("The response of MilestonesApi->get_milestones:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling MilestonesApi->get_milestones: %s\n" % e)

Parameters

NameTypeDescriptionNotes
statusstrFilter by milestone status[optional]
limitintNumber of items per page (minimum 1, maximum 500)[optional] [default to 100]

Return type

GetMilestonesResponse

HTTP response details

Status codeDescription
200Milestones retrieved successfully
401Unauthorized - authentication required
500Internal server error
[Back to top] [Back to API list] [Back to Model list] [Back to README]