#include <kalshi/models.hpp>

Public Attributes
std::string	api_key_id
	Unique identifier for the API key.

std::string	name
	User-provided name for the API key.

std::vector< ApiKeyScope >	scopes
	List of scopes granted to this API key.

std::optional< std::int64_t >	subaccount
	If set, the API key is restricted to this single sub-account and may only read and trade on it.

std::optional< std::string >	fcm_subtrader_id
	If set, the API key is bound to this single FCM subtrader ({fcm_user_id}_{suffix}) and is usable only as that institution's trading credential - FIX sessions and subtrader-scoped margin WebSocket sessions; every REST endpoint is denied.

Member Data Documentation

◆ api_key_id

std::string kalshi::ApiKey::api_key_id

Unique identifier for the API key.

◆ name

std::string kalshi::ApiKey::name

User-provided name for the API key.

◆ scopes

std::vector<ApiKeyScope> kalshi::ApiKey::scopes

List of scopes granted to this API key.

◆ subaccount

std::optional<std::int64_t> kalshi::ApiKey::subaccount

If set, the API key is restricted to this single sub-account and may only read and trade on it.

◆ fcm_subtrader_id

std::optional<std::string> kalshi::ApiKey::fcm_subtrader_id

If set, the API key is bound to this single FCM subtrader ({fcm_user_id}_{suffix}) and is usable only as that institution's trading credential - FIX sessions and subtrader-scoped margin WebSocket sessions; every REST endpoint is denied.

The documentation for this struct was generated from the following file: