api.md

Shared Types

from studio_sdk.types import (
    BaseStrategy,
    LocateOrder,
    Order,
    Position,
    RegtMarginSimulation,
    Strategy,
    Trade,
)

Entities

Types:

from studio_sdk.types import Entity, PnlSummary, PortfolioMargin, RegtMargin, EntityListResponse

Methods:

• client.entities.retrieve(entity_id) -> Entity
• client.entities.list() -> EntityListResponse

PnlSummaries

Methods:

• client.entities.pnl_summaries.retrieve(entity_id) -> PnlSummary

RegtMargins

Methods:

• client.entities.regt_margins.retrieve(entity_id) -> RegtMargin

PortfolioMargins

Methods:

• client.entities.portfolio_margins.retrieve(entity_id) -> PortfolioMargin

RegtMarginSimulations

Types:

from studio_sdk.types.entities import SimulationID, RegtMarginSimulationCreateResponse

Methods:

• client.entities.regt_margin_simulations.create(entity_id, **params) -> RegtMarginSimulationCreateResponse
• client.entities.regt_margin_simulations.retrieve(simulation_id, *, entity_id) -> RegtMarginSimulation

Accounts

Types:

from studio_sdk.types import Account, AccountListResponse

Methods:

• client.accounts.retrieve(account_id) -> Account
• client.accounts.list() -> AccountListResponse

BulkOrders

Types:

from studio_sdk.types.accounts import BulkOrderCreateResponse

Methods:

• client.accounts.bulk_orders.create(account_id, **params) -> BulkOrderCreateResponse

Orders

Types:

from studio_sdk.types.accounts import (
    OrderCreateResponse,
    OrderRetrieveResponse,
    OrderListResponse,
    OrderDeleteResponse,
)

Methods:

• client.accounts.orders.create(account_id, **params) -> OrderCreateResponse
• client.accounts.orders.retrieve(order_id, *, account_id) -> OrderRetrieveResponse
• client.accounts.orders.list(account_id, **params) -> OrderListResponse
• client.accounts.orders.delete(account_id, **params) -> OrderDeleteResponse
• client.accounts.orders.cancel(order_id, *, account_id) -> None
• client.accounts.orders.patch(order_id, *, account_id, **params) -> None

Trades

Types:

from studio_sdk.types.accounts import TradeListResponse

Methods:

• client.accounts.trades.retrieve(trade_id, *, account_id) -> Trade
• client.accounts.trades.list(account_id, **params) -> TradeListResponse

Positions

Types:

from studio_sdk.types.accounts import PositionListResponse

Methods:

• client.accounts.positions.retrieve(symbol, *, account_id) -> Position
• client.accounts.positions.list(account_id, **params) -> PositionListResponse

LocateOrders

Types:

from studio_sdk.types.accounts import LocateOrderListResponse

Methods:

• client.accounts.locate_orders.create(account_id, **params) -> LocateOrder
• client.accounts.locate_orders.retrieve(locate_order_id, *, account_id) -> LocateOrder
• client.accounts.locate_orders.update(locate_order_id, *, account_id, **params) -> None
• client.accounts.locate_orders.list(account_id) -> LocateOrderListResponse

EasyBorrows

Types:

from studio_sdk.types.accounts import EasyBorrowListResponse

Methods:

• client.accounts.easy_borrows.list(account_id) -> EasyBorrowListResponse

PnlSummary

Types:

from studio_sdk.types.accounts import PnlSummaryRetrieveResponse

Methods:

• client.accounts.pnl_summary.retrieve(account_id) -> PnlSummaryRetrieveResponse

PnlDetails

Types:

from studio_sdk.types.accounts import PnlDetailListResponse

Methods:

• client.accounts.pnl_details.list(account_id) -> PnlDetailListResponse

PnlSums

Types:

from studio_sdk.types.accounts import PnlSumListResponse

Methods:

• client.accounts.pnl_sums.list(account_id, **params) -> PnlSumListResponse

Holdings

Types:

from studio_sdk.types.accounts import HoldingListResponse

Methods:

• client.accounts.holdings.list(account_id, **params) -> HoldingListResponse

Inventories

Types:

from studio_sdk.types.accounts import InventoryRetrieveResponse

Methods:

• client.accounts.inventories.retrieve(symbol, *, account_id) -> InventoryRetrieveResponse

Instruments

Types:

from studio_sdk.types import Instrument, InstrumentListResponse

Methods:

• client.instruments.retrieve(symbol, **params) -> Instrument
• client.instruments.list() -> InstrumentListResponse