Resource groups

Each property on a client returns a typed resource group whose methods map one-to-one onto CIAPI endpoints. The synchronous classes are documented below; every method has an async twin on the matching Async*Resource class (for example AsyncSessionResource.log_on).

stonepy.resources.session.SessionResource

SessionResource(ctx: CallContext)

Bases: _ChangePasswordMixin, _DeleteSessionMixin, _LogOnMixin, _ValidateSessionMixin, BaseResource

Synchronous session resource group; access it via StoneXClient.session. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.order.OrderResource

OrderResource(ctx: CallContext)

Bases: _CancelOrderMixin, _GetActiveStopLimitOrderMixin, _GetAllTradesWallMixin, _GetChangedOrdersMixin, _GetMarketsTradesWallMixin, _GetOpenPositionMixin, _GetOrderMixin, _GetOrderHistoryMixin, _GetOrdersMixin, _GetOrdersByReferenceMixin, _ListActiveOrdersMixin, _ListActiveStopLimitOrdersMixin, _ListOpenPositionsMixin, _ListStopLimitOrderHistoryMixin, _ListTradeHistoryMixin, _OrderMixin, _PlaceOrderMixin, _SaveOrderMixin, _SimulateCancelOrderMixin, _SimulateOrderMixin, _SimulateTradeMixin, _SimulateUpdateOrderMixin, _SimulateUpdateTradeMixin, _TradeMixin, _UpdateOrderMixin, _UpdateTradeMixin, BaseResource

Synchronous order resource group; access it via StoneXClient.order. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.order_including_closed.OrderIncludingClosedResource

OrderIncludingClosedResource(ctx: CallContext)

Bases: _GetOrderIncludingClosedMixin, BaseResource

Synchronous order_including_closed resource group; access it via StoneXClient.order_including_closed. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.market.MarketResource

MarketResource(ctx: CallContext)

Bases: _FullSearchWithTagsMixin, _GetFullSearchWithTagsMixin, _GetLatestPriceBarsMixin, _GetLatestPriceTicksMixin, _GetMarketInformationMixin, _GetMarketInformationExtendedMixin, _GetMarketSpreadMixin, _GetPriceBarsAfterDateMixin, _GetPriceBarsBeforeDateMixin, _GetPriceBarsBetweenDatesMixin, _GetPriceTicksAfterDateMixin, _GetPriceTicksBeforeDateMixin, _GetPriceTicksBetweenDatesMixin, _ListLatestTradedMarketsMixin, _ListMarketInformationMixin, _ListMarketInformationSearchMixin, _ListMarketSearchMixin, _ListMarketSearchPaginatedMixin, _SaveMarketInformationMixin, _SaveProductInformationMixin, _SearchWithTagsMixin, _TagLookupMixin, BaseResource

Synchronous market resource group; access it via StoneXClient.market. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.spread.SpreadResource

SpreadResource(ctx: CallContext)

Bases: _ListSpreadMarketsMixin, BaseResource

Synchronous spread resource group; access it via StoneXClient.spread. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.cfd.CfdResource

CfdResource(ctx: CallContext)

Bases: _ListCfdMarketsMixin, BaseResource

Synchronous cfd resource group; access it via StoneXClient.cfd. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.margin.MarginResource

MarginResource(ctx: CallContext)

Bases: _GetClientAccountMarginMixin, _ListManagedClientAccountsMarginMixin, BaseResource

Synchronous margin resource group; access it via StoneXClient.margin. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.fixedmargin.FixedmarginResource

FixedmarginResource(ctx: CallContext)

Bases: _GetFreeCashToTradeMixin, _TradeFmMixin, _UpdateTradeFmMixin, BaseResource

Synchronous fixedmargin resource group; access it via StoneXClient.fixedmargin. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.price_alert.PriceAlertResource

PriceAlertResource(ctx: CallContext)

Bases: _DeletePaMixin, _GetPaMixin, _SavePaMixin, _SavePriceAlertMixin, BaseResource

Synchronous price_alert resource group; access it via StoneXClient.price_alert. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.watchlist.WatchlistResource

WatchlistResource(ctx: CallContext)

Bases: _DeleteWatchlistMixin, _GetWatchlistsMixin, _GetWatchlistsListMixin, _SaveWatchlistMixin, BaseResource

Synchronous watchlist resource group; access it via StoneXClient.watchlist. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.news.NewsResource

NewsResource(ctx: CallContext)

Bases: _GetMarketReportHeadlinesMixin, _GetMarketReportsMixin, _GetNewsMixin, _GetNewsDetailMixin, _GetNewsHeadlinesMixin, _GetStoryMixin, _ListNewsHeadlinesMixin, _ListNewsHeadlinesWithSourceMixin, _SearchMarketReportsMixin, _SearchNewsMixin, BaseResource

Synchronous news resource group; access it via StoneXClient.news. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.message.MessageResource

MessageResource(ctx: CallContext)

Bases: _ClientCommunicationMessageUpdateMixin, _GetClientApplicationMessageTranslationMixin, _GetClientApplicationMessageTranslationWithInterestingItemsMixin, _GetClientCommunicationMessagesMixin, _GetMessagePopupMixin, _GetSecureMessagesMixin, _GetSystemLookupMixin, _SaveClientCommunicationMessageResponseMixin, BaseResource

Synchronous message resource group; access it via StoneXClient.message. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.preference.PreferenceResource

PreferenceResource(ctx: CallContext)

Bases: _DeleteUserPreferenceMixin, _GetUserPreferenceMixin, _SaveUserPreferenceMixin, BaseResource

Synchronous preference resource group; access it via StoneXClient.preference. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.clientpreference.ClientpreferenceResource

ClientpreferenceResource(ctx: CallContext)

Bases: _DeleteMixin, _GetMixin, _GetKeyListMixin, _GetListMixin, _GetOverriddenSettingsMixin, _SaveMixin, _SaveOverriddenSettingsMixin, BaseResource

Synchronous clientpreference resource group; access it via StoneXClient.clientpreference. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.client_preference.ClientPreferenceResource

ClientPreferenceResource(ctx: CallContext)

Bases: _DeleteClientPreferenceMixin, _GetClientPreferenceMixin, _GetClientPreferenceOverriddenSettingsMixin, _GetClientPreferencesKeyListMixin, _GetClientPreferencesListMixin, _SaveClientPreferenceMixin, _SaveClientPreferenceOverriddenSettingsMixin, BaseResource

Synchronous client_preference resource group; access it via StoneXClient.client_preference. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.clientapplication.ClientapplicationResource

ClientapplicationResource(ctx: CallContext)

Bases: _GetVersionInformationMixin, BaseResource

Synchronous clientapplication resource group; access it via StoneXClient.clientapplication. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.user_account.UserAccountResource

UserAccountResource(ctx: CallContext)

Bases: _GetChartingEnabledMixin, _GetClientAndTradingAccountMixin, _GetMultipleUsersDetailsByClientAccountIdsMixin, _GetMultipleUsersDetailsByFacebookIdsMixin, _GetMultipleUsersDetailsByScreenNamesMixin, _GetSocialActionsMixin, _GetUsernameMixin, _GetWallItemsForUsersMixin, _GetWallSubItemsMixin, _ListFollowedMixin, _ListFollowersMixin, _ListTopholdersForMarketsMixin, _SaveAccountInformationMixin, _SearchMixin, BaseResource

Synchronous user_account resource group; access it via StoneXClient.user_account. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.pm.PmResource

PmResource(ctx: CallContext)

Bases: _GetHistoricalOrdersMixin, _GetOpenOrdersMixin, _GetPendingOrdersMixin, _GetSignalPerformanceMixin, _GetSignalPreferencesMixin, _ListActiveSignalsMixin, _SaveSignalPreferencesMixin, BaseResource

Synchronous pm resource group; access it via StoneXClient.pm. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx

stonepy.resources.tradingadvisor.TradingadvisorResource

TradingadvisorResource(ctx: CallContext)

Bases: _DeleteAllocationProfileMixin, _ListAllocationProfilesMixin, _ListManagedClientsMixin, _SaveAllocationProfileMixin, BaseResource

Synchronous tradingadvisor resource group; access it via StoneXClient.tradingadvisor. Each method maps to one StoneX CIAPI v2 endpoint.

Source code in src/stonepy/_core/resource.py

def __init__(self, ctx: CallContext) -> None:
    self._ctx = ctx