Get Balance
Changed onReturns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.
Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.
Request
- Base URLhttps://external-api.kalshi.com/trade-api/v2
- URLhttps://external-api.kalshi.com/trade-api/v2/portfolio/balance
- AuthAPI key in header KALSHI-ACCESS-KEY and API key in header KALSHI-ACCESS-SIGNATURE and API key in header KALSHI-ACCESS-TIMESTAMP
Query parameters
Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
Identifier for an exchange shard.
Exchange index used to scope the balance and portfolio value. If omitted, both include all exchange indexes.
Response
Balance retrieved successfully
Example response
{
"balance_dollars": "0.5600",
"balance_breakdown": [
{
"balance": "0.5600"
}
]
}Changes
- warning
for the
queryrequest parametersubaccount, the min was set to0.00
- warning
- warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status
- warning