laplace-python-sdk 1.2.1__py3-none-any.whl → 1.2.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
laplace/client.py CHANGED
@@ -10,6 +10,7 @@ from .financials import FinancialsClient
10
10
  from .funds import FundsClient
11
11
  from .live_price import LivePriceClient
12
12
  from .politician import PoliticianClient
13
+ from .screener import ScreenerClient
13
14
  from .search import SearchClient
14
15
  from .state import StateClient
15
16
  from .stocks import StocksClient
@@ -42,6 +43,7 @@ class LaplaceClient(BaseClient):
42
43
  self.search = SearchClient(self)
43
44
  self.state = StateClient(self)
44
45
  self.news = NewsClient(self)
46
+ self.screener = ScreenerClient(self)
45
47
 
46
48
  # WebSocket client will be created on demand
47
49
  self._websocket_client: Optional[LivePriceWebSocketClient] = None
laplace/models.py CHANGED
@@ -939,6 +939,70 @@ class NewsHighlight(BaseModel):
939
939
 
940
940
  model_config = {"populate_by_name": True}
941
941
 
942
+ class ScreenerRangeFilter(BaseModel):
943
+ """Min/max numeric range filter for the screener."""
944
+
945
+ min: Optional[float] = None
946
+ max: Optional[float] = None
947
+
948
+
949
+ class ScreenerFilters(BaseModel):
950
+ """Filters accepted by the screener endpoint."""
951
+
952
+ price: Optional[ScreenerRangeFilter] = None
953
+ daily_change: Optional[ScreenerRangeFilter] = Field(default=None, alias="dailyChange")
954
+ pe_ratio: Optional[ScreenerRangeFilter] = Field(default=None, alias="peRatio")
955
+ pb_ratio: Optional[ScreenerRangeFilter] = Field(default=None, alias="pbRatio")
956
+ market_cap: Optional[ScreenerRangeFilter] = Field(default=None, alias="marketCap")
957
+ weekly_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="weeklyReturn")
958
+ monthly_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="monthlyReturn")
959
+ three_month_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="threeMonthReturn")
960
+ yearly_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="yearlyReturn")
961
+ three_year_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="threeYearReturn")
962
+ five_year_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="fiveYearReturn")
963
+ ytd_return: Optional[ScreenerRangeFilter] = Field(default=None, alias="ytdReturn")
964
+
965
+ model_config = {"populate_by_name": True}
966
+
967
+
968
+ class ScreenerSortBy(str, Enum):
969
+ """Sort fields supported by the screener endpoint."""
970
+
971
+ SYMBOL = "symbol"
972
+ PRICE = "price"
973
+ DAILY_CHANGE = "dailyChange"
974
+ MARKET_CAP = "marketCap"
975
+ PE_RATIO = "peRatio"
976
+ PB_RATIO = "pbRatio"
977
+ WEEKLY_RETURN = "weeklyReturn"
978
+ MONTHLY_RETURN = "monthlyReturn"
979
+ THREE_MONTH_RETURN = "threeMonthReturn"
980
+ YEARLY_RETURN = "yearlyReturn"
981
+ THREE_YEAR_RETURN = "threeYearReturn"
982
+ FIVE_YEAR_RETURN = "fiveYearReturn"
983
+ YTD_RETURN = "ytdReturn"
984
+
985
+
986
+ class ScreenerStock(BaseModel):
987
+ """A single stock entry returned by the screener endpoint."""
988
+
989
+ symbol: str
990
+ price: Optional[float] = None
991
+ daily_change: Optional[float] = Field(default=None, alias="dailyChange")
992
+ market_cap: Optional[float] = Field(default=None, alias="marketCap")
993
+ pe_ratio: Optional[float] = Field(default=None, alias="peRatio")
994
+ pb_ratio: Optional[float] = Field(default=None, alias="pbRatio")
995
+ weekly_return: Optional[float] = Field(default=None, alias="weeklyReturn")
996
+ monthly_return: Optional[float] = Field(default=None, alias="monthlyReturn")
997
+ three_month_return: Optional[float] = Field(default=None, alias="threeMonthReturn")
998
+ yearly_return: Optional[float] = Field(default=None, alias="yearlyReturn")
999
+ three_year_return: Optional[float] = Field(default=None, alias="threeYearReturn")
1000
+ five_year_return: Optional[float] = Field(default=None, alias="fiveYearReturn")
1001
+ ytd_return: Optional[float] = Field(default=None, alias="ytdReturn")
1002
+
1003
+ model_config = {"populate_by_name": True}
1004
+
1005
+
942
1006
  class WebsocketMonthlyUsageDataResponse(BaseModel):
943
1007
  external_user_id: str = Field(alias="externalUserID")
944
1008
  first_connection_time: datetime = Field(alias="firstConnectionTime")
laplace/screener.py ADDED
@@ -0,0 +1,65 @@
1
+ """Screener client for Laplace API."""
2
+
3
+ from typing import Optional
4
+
5
+ from laplace.base import BaseClient
6
+
7
+ from .models import (
8
+ PaginatedResponse,
9
+ Region,
10
+ ScreenerFilters,
11
+ ScreenerSortBy,
12
+ ScreenerStock,
13
+ SortDirection,
14
+ )
15
+
16
+
17
+ class ScreenerClient:
18
+ """Client for the stock screener endpoint."""
19
+
20
+ def __init__(self, base_client: BaseClient):
21
+ self._client = base_client
22
+
23
+ def screen(
24
+ self,
25
+ region: Region = Region.TR,
26
+ filters: Optional[ScreenerFilters] = None,
27
+ sort_by: Optional[ScreenerSortBy] = None,
28
+ sort_order: Optional[SortDirection] = None,
29
+ page: int = 1,
30
+ page_size: int = 20,
31
+ ) -> PaginatedResponse[ScreenerStock]:
32
+ """Run the screener with optional filters, sorting, and pagination.
33
+
34
+ Args:
35
+ region: Region (only 'tr' is currently supported).
36
+ filters: Optional filter ranges (price, P/E, returns, etc.).
37
+ sort_by: Optional sort field.
38
+ sort_order: Optional sort direction.
39
+ page: Page number, 1-based (1-10000, default 1).
40
+ page_size: Results per page (1-100, default 20).
41
+
42
+ Returns:
43
+ PaginatedResponse[ScreenerStock]
44
+ """
45
+ if region != Region.TR:
46
+ raise ValueError("Screener endpoint only supports the 'tr' region")
47
+
48
+ body: dict = {"page": page, "pageSize": page_size}
49
+
50
+ if filters is not None:
51
+ filters_body = filters.model_dump(by_alias=True, exclude_none=True)
52
+ if filters_body:
53
+ body["filters"] = filters_body
54
+ if sort_by is not None:
55
+ body["sortBy"] = sort_by.value
56
+ if sort_order is not None:
57
+ body["sortOrder"] = sort_order.value
58
+
59
+ response = self._client._request(
60
+ "POST",
61
+ "v1/screener",
62
+ params={"region": region.value},
63
+ json=body,
64
+ )
65
+ return PaginatedResponse[ScreenerStock](**response)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: laplace-python-sdk
3
- Version: 1.2.1
3
+ Version: 1.2.3
4
4
  Summary: Python SDK for Laplace stock data platform
5
5
  Author: Laplace SDK Team
6
6
  License: MIT
@@ -2,21 +2,22 @@ laplace/__init__.py,sha256=PladXmpbW1dUpex4TRFfKSTcISXeTk7idXkED9MKPHk,166
2
2
  laplace/base.py,sha256=bUrBaEaC7asdxf_y09MF4cFbqp-2E7pYKqckLWGn19s,4812
3
3
  laplace/brokers.py,sha256=4wyb4B85p1s0BE9-U3gK_Bp4of1xWryIZs-PSyJKVQk,7233
4
4
  laplace/capital_increase.py,sha256=K2pbMbY6X6nzffegPvtosoumNRp2sxZrY2t9EcbVvq0,3031
5
- laplace/client.py,sha256=2OK-zQXKwbty47N73EefS84seRLJE2he0aoiskc1FQ4,2458
5
+ laplace/client.py,sha256=_gmiT6fEYHWz5XZ8YufUfpX1C8qnOzXPhH9aTyzLzfc,2540
6
6
  laplace/collections.py,sha256=jhIVxTbn9j1Dpi3OCp3S5vG29xYB6aw2BNoI4v0-b7M,10256
7
7
  laplace/earnings.py,sha256=y1fVgfJUXGl3vOSF9g6ryuoYYygXuxcsfk4VO2SVRjE,2114
8
8
  laplace/financials.py,sha256=QJPlOzd5dhhOC2bdtbGmPfnsHx9bCf9nCM34bVtzYag,3132
9
9
  laplace/funds.py,sha256=o-lmCtXX60ehaoYOuCRayU7P1n9D6oHaZR6N3OXq5kU,3200
10
10
  laplace/live_price.py,sha256=4l3YhfVjnRv7f_h-EBFLo5m0tGTGYdP5E6BcNrTXegE,16360
11
- laplace/models.py,sha256=yt4QNMx0NrEdO6x8PEjl_lzJbpUvqzbMQRtu9riD43I,26154
11
+ laplace/models.py,sha256=wVmYdi6fFMjUgB-KpugI7XJJEx0DpRJGzuHjhPNN2pc,29079
12
12
  laplace/news.py,sha256=8ZiJFLp9jOt0eFEQptK4fl9Mlmw-FF_eKnmnjhTzpqI,10826
13
13
  laplace/politician.py,sha256=Llez12RDJZWC8AOwRn4vupT7NZ6mZNk_b6JcNSMJGyA,1778
14
+ laplace/screener.py,sha256=g1c9PZIcsBvkBCbe0qzdpWAu6-zEzawD1iXYeBdly9k,1981
14
15
  laplace/search.py,sha256=JYsb8Nr5F-UMS53MGaMHL3d6VxJ7M8V3xHnFK22ORMg,1518
15
16
  laplace/state.py,sha256=P2Ky0fToDc_VauBFD7bw91dywVkY3TaIN3mhf0Ms5sg,3417
16
17
  laplace/stocks.py,sha256=ou4k_Kv9n_Nm_9hayYvLxHub1cX0qnjhgJeCM-6epo0,12552
17
18
  laplace/websocket.py,sha256=9VNCA38Y_jznSDDajwybSoRtBz1BoANqcFZMZiUBG88,15603
18
- laplace_python_sdk-1.2.1.dist-info/licenses/LICENSE,sha256=7q_XpeQPP0BLMADuenSz0wqLxttWJtoOei0sYmqly0g,1063
19
- laplace_python_sdk-1.2.1.dist-info/METADATA,sha256=zNtcNXw0UUoGhs7_RvcD0CGP5stE2GgCSIaGZBmczak,9545
20
- laplace_python_sdk-1.2.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
21
- laplace_python_sdk-1.2.1.dist-info/top_level.txt,sha256=miT6qTaH7MSLy2iNStZCy478rCt72Hij9KP1bRBTGPA,8
22
- laplace_python_sdk-1.2.1.dist-info/RECORD,,
19
+ laplace_python_sdk-1.2.3.dist-info/licenses/LICENSE,sha256=7q_XpeQPP0BLMADuenSz0wqLxttWJtoOei0sYmqly0g,1063
20
+ laplace_python_sdk-1.2.3.dist-info/METADATA,sha256=lTgJZY1nJONs3_WC8-pySFTtNQvwcy8IXwaQHYHATf4,9545
21
+ laplace_python_sdk-1.2.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
22
+ laplace_python_sdk-1.2.3.dist-info/top_level.txt,sha256=miT6qTaH7MSLy2iNStZCy478rCt72Hij9KP1bRBTGPA,8
23
+ laplace_python_sdk-1.2.3.dist-info/RECORD,,