All URIs are relative to https://api.elections.kalshi.com/trade-api/v2
MethodHTTP requestDescription
get_structured_targetGET /structured_targets/Get Structured Target
get_structured_targetsGET /structured_targetsGet Structured Targets

get_structured_target

GetStructuredTargetResponse get_structured_target(structured_target_id)
Get Structured Target Get a single structured target by ID

Example

import kalshi_python
from kalshi_python.models.get_structured_target_response import GetStructuredTargetResponse
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)

structured_target_id = 'structured_target_id_example' # str | Structured target ID

try:
    # Get Structured Target
    api_response = client.get_structured_target(structured_target_id)
    print("The response of StructuredTargetsApi->get_structured_target:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling StructuredTargetsApi->get_structured_target: %s\n" % e)

Parameters

NameTypeDescriptionNotes
structured_target_idstrStructured target ID

Return type

GetStructuredTargetResponse

HTTP response details

Status codeDescription
200Structured target 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_structured_targets

GetStructuredTargetsResponse get_structured_targets(status=status, page_size=page_size)
Get Structured Targets Get all structured targets

Example

import kalshi_python
from kalshi_python.models.get_structured_targets_response import GetStructuredTargetsResponse
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 structured target status (optional)

page_size = 100 # int | Number of items per page (minimum 100, default 100) (optional) (default to 100)

try:
    # Get Structured Targets
    api_response = client.get_structured_targets(status=status, page_size=page_size)
    print("The response of StructuredTargetsApi->get_structured_targets:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling StructuredTargetsApi->get_structured_targets: %s\n" % e)

Parameters

NameTypeDescriptionNotes
statusstrFilter by structured target status[optional]
page_sizeintNumber of items per page (minimum 100, default 100)[optional] [default to 100]

Return type

GetStructuredTargetsResponse

HTTP response details

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