All URIs are relative to https://api.elections.kalshi.com/trade-api/v2

Method	HTTP request	Description
amendOrder	POST /portfolio/orders//amend	Amend Order
batchCancelOrders	DELETE /portfolio/orders/batched	Batch Cancel Orders
batchCreateOrders	POST /portfolio/orders/batched	Batch Create Orders
cancelOrder	DELETE /portfolio/orders/	Cancel Order
createOrder	POST /portfolio/orders	Create Order
createOrderGroup	POST /portfolio/order_groups/create	Create Order Group
decreaseOrder	POST /portfolio/orders//decrease	Decrease Order
deleteOrderGroup	DELETE /portfolio/order_groups/	Delete Order Group
getBalance	GET /portfolio/balance	Get Balance
getFills	GET /portfolio/fills	Get Fills
getOrder	GET /portfolio/orders/	Get Order
getOrderGroup	GET /portfolio/order_groups/	Get Order Group
getOrderGroups	GET /portfolio/order_groups	Get Order Groups
getOrderQueuePosition	GET /portfolio/orders//queue_position	Get Order Queue Position
getOrders	GET /portfolio/orders	Get Orders
getPositions	GET /portfolio/positions	Get Positions
getQueuePositions	POST /portfolio/orders/queue_positions	Get Queue Positions
getSettlements	GET /portfolio/settlements	Get Settlements
getTotalRestingOrderValue	GET /portfolio/summary/total_resting_order_value	Get Total Resting Order Value
resetOrderGroup	PUT /portfolio/order_groups//reset	Reset Order Group

amendOrder

AmendOrderResponse amendOrder(amendOrderRequest)

Amend an existing order

Example

import {
    PortfolioApi,
    Configuration,
    AmendOrderRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderId: string; //Order ID (default to undefined)
let amendOrderRequest: AmendOrderRequest; //

const { status, data } = await apiInstance.amendOrder(
    orderId,
    amendOrderRequest
);

Parameters

Name	Type	Description	Notes
amendOrderRequest	AmendOrderRequest
orderId	[string]	Order ID	defaults to undefined

Return type

AmendOrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order amended successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batchCancelOrders

BatchCancelOrdersResponse batchCancelOrders(batchCancelOrdersRequest)

Cancel multiple orders in a single request

Example

import {
    PortfolioApi,
    Configuration,
    BatchCancelOrdersRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let batchCancelOrdersRequest: BatchCancelOrdersRequest; //

const { status, data } = await apiInstance.batchCancelOrders(
    batchCancelOrdersRequest
);

Parameters

Name	Type	Description	Notes
batchCancelOrdersRequest	BatchCancelOrdersRequest

Return type

BatchCancelOrdersResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Batch order cancellation completed	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batchCreateOrders

BatchCreateOrdersResponse batchCreateOrders(batchCreateOrdersRequest)

Create multiple orders in a single request

Example

import {
    PortfolioApi,
    Configuration,
    BatchCreateOrdersRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let batchCreateOrdersRequest: BatchCreateOrdersRequest; //

const { status, data } = await apiInstance.batchCreateOrders(
    batchCreateOrdersRequest
);

Parameters

Name	Type	Description	Notes
batchCreateOrdersRequest	BatchCreateOrdersRequest

Return type

BatchCreateOrdersResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Batch order creation completed	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancelOrder

CancelOrderResponse cancelOrder()

Cancel an order

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderId: string; //Order ID (default to undefined)

const { status, data } = await apiInstance.cancelOrder(
    orderId
);

Parameters

Name	Type	Description	Notes
orderId	[string]	Order ID	defaults to undefined

Return type

CancelOrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order cancelled successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createOrder

CreateOrderResponse createOrder(createOrderRequest)

Create a new order

Example

import {
    PortfolioApi,
    Configuration,
    CreateOrderRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let createOrderRequest: CreateOrderRequest; //

const { status, data } = await apiInstance.createOrder(
    createOrderRequest
);

Parameters

Name	Type	Description	Notes
createOrderRequest	CreateOrderRequest

Return type

CreateOrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Order created successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
429	Too Many Requests - rate limit exceeded	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createOrderGroup

CreateOrderGroupResponse createOrderGroup(createOrderGroupRequest)

Create a new order group

Example

import {
    PortfolioApi,
    Configuration,
    CreateOrderGroupRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let createOrderGroupRequest: CreateOrderGroupRequest; //

const { status, data } = await apiInstance.createOrderGroup(
    createOrderGroupRequest
);

Parameters

Name	Type	Description	Notes
createOrderGroupRequest	CreateOrderGroupRequest

Return type

CreateOrderGroupResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Order group created successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

decreaseOrder

DecreaseOrderResponse decreaseOrder(decreaseOrderRequest)

Decrease the size of an existing order

Example

import {
    PortfolioApi,
    Configuration,
    DecreaseOrderRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderId: string; //Order ID (default to undefined)
let decreaseOrderRequest: DecreaseOrderRequest; //

const { status, data } = await apiInstance.decreaseOrder(
    orderId,
    decreaseOrderRequest
);

Parameters

Name	Type	Description	Notes
decreaseOrderRequest	DecreaseOrderRequest
orderId	[string]	Order ID	defaults to undefined

Return type

DecreaseOrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order decreased successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteOrderGroup

deleteOrderGroup()

Delete an order group

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderGroupId: string; //Order group ID (default to undefined)

const { status, data } = await apiInstance.deleteOrderGroup(
    orderGroupId
);

Parameters

Name	Type	Description	Notes
orderGroupId	[string]	Order group ID	defaults to undefined

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Order group deleted successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBalance

GetBalanceResponse getBalance()

Get the user’s current balance

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

const { status, data } = await apiInstance.getBalance();

Parameters

This endpoint does not have any parameters.

Return type

GetBalanceResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Balance retrieved successfully	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFills

GetFillsResponse getFills()

Get fills for the logged-in user. A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let ticker: string; //Filter by market ticker (optional) (default to undefined)
let orderId: string; //Filter by order ID (optional) (default to undefined)
let minTs: number; //Filter items after this Unix timestamp (optional) (default to undefined)
let maxTs: number; //Filter items before this Unix timestamp (optional) (default to undefined)
let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)

const { status, data } = await apiInstance.getFills(
    ticker,
    orderId,
    minTs,
    maxTs,
    limit,
    cursor
);

Parameters

Name	Type	Description	Notes
ticker	[string]	Filter by market ticker	(optional) defaults to undefined
orderId	[string]	Filter by order ID	(optional) defaults to undefined
minTs	[number]	Filter items after this Unix timestamp	(optional) defaults to undefined
maxTs	[number]	Filter items before this Unix timestamp	(optional) defaults to undefined
limit	[number]	Number of results per page. Defaults to 100. Maximum value is 200.	(optional) defaults to 100
cursor	[string]	Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.	(optional) defaults to undefined

Return type

GetFillsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Fills retrieved successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOrder

GetOrderResponse getOrder()

Get a single order by ID

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderId: string; //Order ID (default to undefined)

const { status, data } = await apiInstance.getOrder(
    orderId
);

Parameters

Name	Type	Description	Notes
orderId	[string]	Order ID	defaults to undefined

Return type

GetOrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order retrieved successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOrderGroup

GetOrderGroupResponse getOrderGroup()

Get details of a specific order group

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderGroupId: string; //Order group ID (default to undefined)

const { status, data } = await apiInstance.getOrderGroup(
    orderGroupId
);

Parameters

Name	Type	Description	Notes
orderGroupId	[string]	Order group ID	defaults to undefined

Return type

GetOrderGroupResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order group retrieved successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOrderGroups

GetOrderGroupsResponse getOrderGroups()

Get order groups for the logged-in user

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let status: string; //Filter by status. Possible values depend on the endpoint. (optional) (default to undefined)
let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)

const { status, data } = await apiInstance.getOrderGroups(
    status,
    limit,
    cursor
);

Parameters

Name	Type	Description	Notes
status	[string]	Filter by status. Possible values depend on the endpoint.	(optional) defaults to undefined
limit	[number]	Number of results per page. Defaults to 100. Maximum value is 200.	(optional) defaults to 100
cursor	[string]	Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.	(optional) defaults to undefined

Return type

GetOrderGroupsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order groups retrieved successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOrderQueuePosition

GetOrderQueuePositionResponse getOrderQueuePosition()

Get the queue position for an order

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderId: string; //Order ID (default to undefined)

const { status, data } = await apiInstance.getOrderQueuePosition(
    orderId
);

Parameters

Name	Type	Description	Notes
orderId	[string]	Order ID	defaults to undefined

Return type

GetOrderQueuePositionResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Queue position retrieved successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOrders

GetOrdersResponse getOrders()

Get orders for the logged-in user

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let ticker: string; //Filter by market ticker (optional) (default to undefined)
let eventTicker: string; //Filter by event ticker (optional) (default to undefined)
let minTs: number; //Filter items after this Unix timestamp (optional) (default to undefined)
let maxTs: number; //Filter items before this Unix timestamp (optional) (default to undefined)
let status: string; //Filter by status. Possible values depend on the endpoint. (optional) (default to undefined)
let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)

const { status, data } = await apiInstance.getOrders(
    ticker,
    eventTicker,
    minTs,
    maxTs,
    status,
    limit,
    cursor
);

Parameters

Name	Type	Description	Notes
ticker	[string]	Filter by market ticker	(optional) defaults to undefined
eventTicker	[string]	Filter by event ticker	(optional) defaults to undefined
minTs	[number]	Filter items after this Unix timestamp	(optional) defaults to undefined
maxTs	[number]	Filter items before this Unix timestamp	(optional) defaults to undefined
status	[string]	Filter by status. Possible values depend on the endpoint.	(optional) defaults to undefined
limit	[number]	Number of results per page. Defaults to 100. Maximum value is 200.	(optional) defaults to 100
cursor	[string]	Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.	(optional) defaults to undefined

Return type

GetOrdersResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Orders retrieved successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPositions

GetPositionsResponse getPositions()

Get positions for the logged-in user

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let ticker: string; //Filter by market ticker (optional) (default to undefined)
let eventTicker: string; //Filter by event ticker (optional) (default to undefined)
let countDown: number; //Filter positions by minimum count down value (optional) (default to undefined)
let countUp: number; //Filter positions by minimum count up value (optional) (default to undefined)
let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)

const { status, data } = await apiInstance.getPositions(
    ticker,
    eventTicker,
    countDown,
    countUp,
    limit,
    cursor
);

Parameters

Name	Type	Description	Notes
ticker	[string]	Filter by market ticker	(optional) defaults to undefined
eventTicker	[string]	Filter by event ticker	(optional) defaults to undefined
countDown	[number]	Filter positions by minimum count down value	(optional) defaults to undefined
countUp	[number]	Filter positions by minimum count up value	(optional) defaults to undefined
limit	[number]	Number of results per page. Defaults to 100. Maximum value is 200.	(optional) defaults to 100
cursor	[string]	Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.	(optional) defaults to undefined

Return type

GetPositionsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Positions retrieved successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getQueuePositions

GetQueuePositionsResponse getQueuePositions(getQueuePositionsRequest)

Get queue positions for multiple orders

Example

import {
    PortfolioApi,
    Configuration,
    GetQueuePositionsRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let getQueuePositionsRequest: GetQueuePositionsRequest; //

const { status, data } = await apiInstance.getQueuePositions(
    getQueuePositionsRequest
);

Parameters

Name	Type	Description	Notes
getQueuePositionsRequest	GetQueuePositionsRequest

Return type

GetQueuePositionsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Queue positions retrieved successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSettlements

GetSettlementsResponse getSettlements()

Get settlements for the logged-in user

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)

const { status, data } = await apiInstance.getSettlements(
    limit,
    cursor
);

Parameters

Name	Type	Description	Notes
limit	[number]	Number of results per page. Defaults to 100. Maximum value is 200.	(optional) defaults to 100
cursor	[string]	Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.	(optional) defaults to undefined

Return type

GetSettlementsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Settlements retrieved successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTotalRestingOrderValue

GetTotalRestingOrderValueResponse getTotalRestingOrderValue()

Get the total value of all resting orders

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

const { status, data } = await apiInstance.getTotalRestingOrderValue();

Parameters

This endpoint does not have any parameters.

Return type

GetTotalRestingOrderValueResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Total resting order value retrieved successfully	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetOrderGroup

resetOrderGroup()

Reset an order group

Example

import {
    PortfolioApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new PortfolioApi(configuration);

let orderGroupId: string; //Order group ID (default to undefined)

const { status, data } = await apiInstance.resetOrderGroup(
    orderGroupId
);

Parameters

Name	Type	Description	Notes
orderGroupId	[string]	Order group ID	defaults to undefined

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Order group reset successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Python

TypeScript

​amendOrder

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​batchCancelOrders

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​batchCreateOrders

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​cancelOrder

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​createOrder

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​createOrderGroup

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​decreaseOrder

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​deleteOrderGroup

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getBalance

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getFills

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getOrder

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getOrderGroup

amendOrder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchCancelOrders

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchCreateOrders

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancelOrder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createOrder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createOrderGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

decreaseOrder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteOrderGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getBalance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getFills

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOrder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOrderGroup

Example

Parameters