"""Search result models matching Avanza API response structure."""
from pydantic import BaseModel, ConfigDict, Field
# Standard model config for all models
MODEL_CONFIG = ConfigDict(
populate_by_name=True,
str_strip_whitespace=True,
validate_assignment=True,
extra="allow", # Don't fail on extra fields from API
)
class SearchPrice(BaseModel):
"""Price information for a search result."""
model_config = MODEL_CONFIG
last: str | None = None
currency: str | None = None
todayChangePercent: str | None = None
todayChangeValue: str | None = None
todayChangeDirection: int = 0
threeMonthsAgoChangePercent: str | None = None
threeMonthsAgoChangeDirection: int = 0
spread: str | None = None
class StockSector(BaseModel):
"""Stock sector classification."""
model_config = MODEL_CONFIG
id: int
level: int
name: str
englishName: str
highlightedName: str | None = None
class FundTag(BaseModel):
"""Fund classification tag."""
model_config = MODEL_CONFIG
title: str
category: str
tagCategory: str
highlightedTitle: str | None = None
class SearchHit(BaseModel):
"""Individual search result from the Avanza API."""
model_config = MODEL_CONFIG
type: str
title: str
highlightedTitle: str
description: str
highlightedDescription: str
path: str | None = None
flagCode: str | None = None
orderBookId: str | None = None # May be None for certain instrument types
urlSlugName: str
tradeable: bool
sellable: bool
buyable: bool
price: SearchPrice | None = None # May be None for certain instrument types
stockSectors: list[StockSector] = Field(default_factory=list)
fundTags: list[FundTag] = Field(default_factory=list)
marketPlaceName: str
subType: str | None = None
highlightedSubType: str = ""
class TypeFacet(BaseModel):
"""Facet count for an instrument type."""
model_config = MODEL_CONFIG
type: str
count: int
class SearchFacets(BaseModel):
"""Search result facets with type counts."""
model_config = MODEL_CONFIG
types: list[TypeFacet]
class SearchFilter(BaseModel):
"""Applied search filters."""
model_config = MODEL_CONFIG
types: list[str] = Field(default_factory=list)
class SearchPagination(BaseModel):
"""Pagination information."""
model_config = MODEL_CONFIG
size: int
# Using field alias since 'from' is a Python keyword
from_: int = Field(alias="from")
class SearchResponse(BaseModel):
"""Complete search API response from Avanza."""
model_config = MODEL_CONFIG
totalNumberOfHits: int
hits: list[SearchHit]
searchQuery: str
searchFilter: SearchFilter
facets: SearchFacets
pagination: SearchPagination
