ApiTopholderDTO

stonepy.models.ApiTopholderDTO.ApiTopholderDTO

Bases: ResponseModel

List entry for ApiListTopholdersDTO . Contains the CI Connect details for an individual top holder user. Note: only users registered with CI Connect are returned.

screen_name class-attribute instance-attribute

screen_name: str | None = Field(
    default=None, alias="ScreenName"
)

The registered CI Connect display username of the top holder.

avatar class-attribute instance-attribute

avatar: str | None = Field(default=None, alias='Avatar')

The URL path to the image file used as the graphic avatar for this CI Connect top holder.

quantity class-attribute instance-attribute

quantity: Decimal | None = Field(
    default=None, alias="Quantity"
)

The position size in the market for this top holder.

direction class-attribute instance-attribute

direction: str | None = Field(
    default=None, alias="Direction"
)

The trade direction for this top holder: Buy or Sell .