laplace-python-sdk 1.2.3__tar.gz → 1.4.0__tar.gz

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.
Files changed (29) hide show
  1. {laplace_python_sdk-1.2.3/src/laplace_python_sdk.egg-info → laplace_python_sdk-1.4.0}/PKG-INFO +1 -1
  2. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/pyproject.toml +3 -3
  3. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/models.py +53 -0
  4. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/news.py +181 -7
  5. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0/src/laplace_python_sdk.egg-info}/PKG-INFO +1 -1
  6. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/LICENSE +0 -0
  7. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/MANIFEST.in +0 -0
  8. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/README.md +0 -0
  9. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/setup.cfg +0 -0
  10. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/__init__.py +0 -0
  11. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/base.py +0 -0
  12. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/brokers.py +0 -0
  13. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/capital_increase.py +0 -0
  14. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/client.py +0 -0
  15. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/collections.py +0 -0
  16. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/earnings.py +0 -0
  17. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/financials.py +0 -0
  18. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/funds.py +0 -0
  19. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/live_price.py +0 -0
  20. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/politician.py +0 -0
  21. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/screener.py +0 -0
  22. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/search.py +0 -0
  23. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/state.py +0 -0
  24. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/stocks.py +0 -0
  25. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace/websocket.py +0 -0
  26. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace_python_sdk.egg-info/SOURCES.txt +0 -0
  27. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace_python_sdk.egg-info/dependency_links.txt +0 -0
  28. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace_python_sdk.egg-info/requires.txt +0 -0
  29. {laplace_python_sdk-1.2.3 → laplace_python_sdk-1.4.0}/src/laplace_python_sdk.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: laplace-python-sdk
3
- Version: 1.2.3
3
+ Version: 1.4.0
4
4
  Summary: Python SDK for Laplace stock data platform
5
5
  Author: Laplace SDK Team
6
6
  License: MIT
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "laplace-python-sdk"
7
- version = "1.2.3"
7
+ version = "1.4.0"
8
8
  description = "Python SDK for Laplace stock data platform"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.8"
@@ -64,14 +64,14 @@ profile = "black"
64
64
  line_length = 100
65
65
 
66
66
  [tool.mypy]
67
- python_version = "1.2.3"
67
+ python_version = "1.4.0"
68
68
  strict = true
69
69
  warn_return_any = true
70
70
  warn_unused_configs = true
71
71
 
72
72
  [tool.ruff]
73
73
  line-length = 100
74
- target-version = "1.2.3"
74
+ target-version = "1.4.0"
75
75
 
76
76
  [tool.ruff.lint]
77
77
  select = ["E", "W", "F", "I", "N", "B", "UP"]
@@ -844,6 +844,20 @@ class NewsOrderBy(str, Enum):
844
844
  """News order by options."""
845
845
 
846
846
  TIMESTAMP = "timestamp"
847
+ QUALITY_SCORE = "quality_score"
848
+
849
+
850
+ class NewsLane(str, Enum):
851
+ """News lane options for the filter-news and stream-news endpoints.
852
+
853
+ Lanes are surface-scoped: ``GLOBAL_MACRO`` and ``FAST_MOVERS`` belong to the
854
+ ``us`` region, while ``TR_EKONOMI`` and ``BIST`` belong to the ``tr`` region.
855
+ """
856
+
857
+ GLOBAL_MACRO = "global_macro"
858
+ TR_EKONOMI = "tr_ekonomi"
859
+ BIST = "bist"
860
+ FAST_MOVERS = "fast_movers"
847
861
 
848
862
 
849
863
  class NewsTicker(BaseModel):
@@ -881,6 +895,45 @@ class NewsCategory(BaseModel):
881
895
 
882
896
  model_config = {"populate_by_name": True}
883
897
 
898
+ class NewsCategoryListItem(BaseModel):
899
+ """A canonical news category as returned by /api/v1/news/categories.
900
+
901
+ The ``name`` is the exact value accepted by the ``categories`` filter of the
902
+ News V2 and Live News Stream endpoints.
903
+ """
904
+
905
+ id: str
906
+ name: str
907
+
908
+ model_config = {"populate_by_name": True}
909
+
910
+
911
+ class NewsLaneListItem(BaseModel):
912
+ """A news lane as returned by /api/v1/news/lanes.
913
+
914
+ The ``id`` is the exact value accepted by the ``lane`` filter of the
915
+ filter-news and stream-news endpoints (see :class:`NewsLane`).
916
+ """
917
+
918
+ id: str
919
+ label: str
920
+
921
+ model_config = {"populate_by_name": True}
922
+
923
+
924
+ class NewsApiSourceListItem(BaseModel):
925
+ """A configured news source as returned by /api/v1/news/api-source-names.
926
+
927
+ The ``id`` is the exact value accepted by the ``apiSource`` filter of the
928
+ filter-news and stream-news endpoints (comma-separated for multiple);
929
+ ``name`` is the display name (e.g. "BBC Business").
930
+ """
931
+
932
+ id: str
933
+ name: str
934
+
935
+ model_config = {"populate_by_name": True}
936
+
884
937
  class NewsContent(BaseModel):
885
938
  title: str
886
939
  description: str
@@ -11,7 +11,11 @@ from .models import (
11
11
  Locale,
12
12
  News,
13
13
  NewsV2,
14
+ NewsApiSourceListItem,
15
+ NewsCategoryListItem,
14
16
  NewsHighlight,
17
+ NewsLane,
18
+ NewsLaneListItem,
15
19
  NewsOrderBy,
16
20
  NewsType,
17
21
  PaginatedResponse,
@@ -42,18 +46,22 @@ class NewsStream:
42
46
  base_client: BaseClient,
43
47
  locale: Locale,
44
48
  region: Region,
49
+ lane: Optional[NewsLane] = None,
45
50
  sectors: Optional[List[str]] = None,
46
51
  tickers: Optional[List[str]] = None,
47
52
  categories: Optional[List[str]] = None,
48
53
  industries: Optional[List[str]] = None,
54
+ api_sources: Optional[List[str]] = None,
49
55
  ):
50
56
  self.base_client = base_client
51
57
  self.locale = locale
52
58
  self.region = region
59
+ self.lane = lane
53
60
  self.sectors = sectors
54
61
  self.tickers = tickers
55
62
  self.categories = categories
56
63
  self.industries = industries
64
+ self.api_sources = api_sources
57
65
  self._task: Optional[asyncio.Task] = None
58
66
  self._queue: Optional[asyncio.Queue[NewsStreamResult[List[NewsV2]]]] = None
59
67
  self._is_closed = False
@@ -80,6 +88,10 @@ class NewsStream:
80
88
  except asyncio.CancelledError:
81
89
  break
82
90
 
91
+ def __aiter__(self) -> AsyncGenerator[NewsStreamResult[List[NewsV2]], None]:
92
+ """Allow ``async for result in stream`` directly over the stream."""
93
+ return self.receive()
94
+
83
95
  async def close(self) -> None:
84
96
  """Close the stream and cleanup resources."""
85
97
  if self._is_closed:
@@ -101,6 +113,8 @@ class NewsStream:
101
113
  """Build the streaming URL for the news endpoint."""
102
114
  url = f"{self.base_client.base_url}/v1/news/stream"
103
115
  params = {"locale": self.locale, "region": self.region.value}
116
+ if self.lane is not None:
117
+ params["lane"] = self.lane.value
104
118
  if self.sectors:
105
119
  params["sectors"] = ",".join(self.sectors)
106
120
  if self.tickers:
@@ -109,6 +123,8 @@ class NewsStream:
109
123
  params["categories"] = ",".join(self.categories)
110
124
  if self.industries:
111
125
  params["industries"] = ",".join(self.industries)
126
+ if self.api_sources:
127
+ params["apiSource"] = ",".join(self.api_sources)
112
128
 
113
129
  query_string = urllib.parse.urlencode(params)
114
130
  return f"{url}?{query_string}"
@@ -193,18 +209,47 @@ class NewsClient:
193
209
  news_type: Optional[NewsType] = None,
194
210
  news_order_by: Optional[NewsOrderBy] = None,
195
211
  direction: Optional[SortDirection] = None,
212
+ lane: Optional[NewsLane] = None,
213
+ api_source: Optional[str] = None,
214
+ symbols: Optional[str] = None,
215
+ categories: Optional[str] = None,
216
+ sectors: Optional[str] = None,
217
+ industries: Optional[str] = None,
218
+ quality_score_min: Optional[int] = None,
219
+ quality_score_max: Optional[int] = None,
220
+ timestamp_from: Optional[str] = None,
221
+ timestamp_to: Optional[str] = None,
196
222
  extra_filters: Optional[str] = None,
197
223
  page: int = 0,
198
224
  page_size: PaginationPageSize = PaginationPageSize.PAGE_SIZE_10,
199
225
  ) -> PaginatedResponse[News]:
200
226
  """Retrieve paginated news.
201
227
 
228
+ Within a single filter, comma-separated values are OR-ed; different
229
+ filters are AND-ed together (e.g. ``(AAPL OR MSFT) AND Technology``).
230
+ The ``categories``, ``sectors`` and ``industries`` filters only accept
231
+ values returned by their respective listing endpoints
232
+ (``/api/v1/news/categories`` ``name``, ``/api/v1/sector`` ``title``,
233
+ ``/api/v1/industry`` ``title``).
234
+
202
235
  Args:
203
236
  locale: Locale code (e.g. "tr", "en")
204
237
  region: Region enum (e.g. Region.TR)
205
238
  news_type: Optional news type filter
206
- news_order_by: Optional sorting field
239
+ news_order_by: Optional sorting field (timestamp, quality_score)
207
240
  direction: Optional sort direction
241
+ lane: Optional lane filter. Lanes are region-scoped: US lanes are
242
+ GLOBAL_MACRO and FAST_MOVERS; TR lanes are TR_EKONOMI and BIST.
243
+ api_source: Optional comma-separated source ids from
244
+ :meth:`get_news_api_source_names` (e.g. "BBCBusiness,MarketWatch")
245
+ symbols: Optional comma-separated ticker symbols (e.g. "AAPL,MSFT")
246
+ categories: Optional comma-separated category names
247
+ sectors: Optional comma-separated sector titles
248
+ industries: Optional comma-separated industry titles
249
+ quality_score_min: Optional minimum quality score, inclusive (0-10)
250
+ quality_score_max: Optional maximum quality score, inclusive (0-10)
251
+ timestamp_from: Optional start date, inclusive (YYYY-MM-DD)
252
+ timestamp_to: Optional end date, inclusive (YYYY-MM-DD)
208
253
  extra_filters: Optional extra filters (API-specific)
209
254
  page: Page number (default: 0)
210
255
  page_size: Page size enum (default: 10)
@@ -225,6 +270,26 @@ class NewsClient:
225
270
  params["orderBy"] = news_order_by.value
226
271
  if direction is not None:
227
272
  params["orderByDirection"] = direction.value
273
+ if lane is not None:
274
+ params["lane"] = lane.value
275
+ if api_source:
276
+ params["apiSource"] = api_source
277
+ if symbols:
278
+ params["symbols"] = symbols
279
+ if categories:
280
+ params["categories"] = categories
281
+ if sectors:
282
+ params["sectors"] = sectors
283
+ if industries:
284
+ params["industries"] = industries
285
+ if quality_score_min is not None:
286
+ params["qualityScoreMin"] = quality_score_min
287
+ if quality_score_max is not None:
288
+ params["qualityScoreMax"] = quality_score_max
289
+ if timestamp_from:
290
+ params["timestampFrom"] = timestamp_from
291
+ if timestamp_to:
292
+ params["timestampTo"] = timestamp_to
228
293
  if extra_filters:
229
294
  params["extraFilters"] = extra_filters
230
295
 
@@ -238,19 +303,46 @@ class NewsClient:
238
303
  news_type: Optional[NewsType] = None,
239
304
  news_order_by: Optional[NewsOrderBy] = None,
240
305
  direction: Optional[SortDirection] = None,
241
- extra_filters: Optional[str] = None,
306
+ lane: Optional[NewsLane] = None,
307
+ api_source: Optional[str] = None,
308
+ symbols: Optional[str] = None,
309
+ categories: Optional[str] = None,
310
+ sectors: Optional[str] = None,
311
+ industries: Optional[str] = None,
312
+ quality_score_min: Optional[int] = None,
313
+ quality_score_max: Optional[int] = None,
314
+ timestamp_from: Optional[str] = None,
315
+ timestamp_to: Optional[str] = None,
242
316
  page: int = 0,
243
317
  page_size: PaginationPageSize = PaginationPageSize.PAGE_SIZE_10,
244
318
  ) -> PaginatedResponse[NewsV2]:
245
319
  """Retrieve paginated news (v2).
246
320
 
321
+ Within a single filter, comma-separated values are OR-ed; different
322
+ filters are AND-ed together (e.g. ``(AAPL OR MSFT) AND Technology``).
323
+ The ``categories``, ``sectors`` and ``industries`` filters only accept
324
+ values returned by their respective listing endpoints
325
+ (``/api/v1/news/categories`` ``name``, ``/api/v1/sector`` ``title``,
326
+ ``/api/v1/industry`` ``title``).
327
+
247
328
  Args:
248
329
  locale: Locale code (e.g. "tr", "en")
249
330
  region: Region enum (e.g. Region.TR)
250
331
  news_type: Optional news type filter
251
- news_order_by: Optional sorting field
332
+ news_order_by: Optional sorting field (timestamp, quality_score)
252
333
  direction: Optional sort direction
253
- extra_filters: Optional extra filters (API-specific)
334
+ lane: Optional lane filter. Lanes are region-scoped: US lanes are
335
+ GLOBAL_MACRO and FAST_MOVERS; TR lanes are TR_EKONOMI and BIST.
336
+ api_source: Optional comma-separated source ids from
337
+ :meth:`get_news_api_source_names` (e.g. "BBCBusiness,MarketWatch")
338
+ symbols: Optional comma-separated ticker symbols (e.g. "AAPL,MSFT")
339
+ categories: Optional comma-separated category names
340
+ sectors: Optional comma-separated sector titles
341
+ industries: Optional comma-separated industry titles
342
+ quality_score_min: Optional minimum quality score, inclusive (0-10)
343
+ quality_score_max: Optional maximum quality score, inclusive (0-10)
344
+ timestamp_from: Optional start date, inclusive (YYYY-MM-DD)
345
+ timestamp_to: Optional end date, inclusive (YYYY-MM-DD)
254
346
  page: Page number (default: 0)
255
347
  page_size: Page size enum (default: 10)
256
348
 
@@ -270,12 +362,85 @@ class NewsClient:
270
362
  params["orderBy"] = news_order_by.value
271
363
  if direction is not None:
272
364
  params["orderByDirection"] = direction.value
273
- if extra_filters:
274
- params["extraFilters"] = extra_filters
365
+ if lane is not None:
366
+ params["lane"] = lane.value
367
+ if api_source:
368
+ params["apiSource"] = api_source
369
+ if symbols:
370
+ params["symbols"] = symbols
371
+ if categories:
372
+ params["categories"] = categories
373
+ if sectors:
374
+ params["sectors"] = sectors
375
+ if industries:
376
+ params["industries"] = industries
377
+ if quality_score_min is not None:
378
+ params["qualityScoreMin"] = quality_score_min
379
+ if quality_score_max is not None:
380
+ params["qualityScoreMax"] = quality_score_max
381
+ if timestamp_from:
382
+ params["timestampFrom"] = timestamp_from
383
+ if timestamp_to:
384
+ params["timestampTo"] = timestamp_to
275
385
 
276
386
  response = self._client.get("v2/news", params=params)
277
387
  return PaginatedResponse[NewsV2](**response)
278
388
 
389
+ def get_news_categories(
390
+ self,
391
+ locale: Optional[Locale] = None,
392
+ ) -> List[NewsCategoryListItem]:
393
+ """Retrieve the full canonical news category list.
394
+
395
+ Always returns every category regardless of whether it currently has
396
+ tagged news, ordered by id ascending. The returned ``name`` values are
397
+ the exact values accepted by the ``categories`` filter of
398
+ :meth:`get_news_v2` and :meth:`get_news_stream`.
399
+
400
+ Args:
401
+ locale: Optional language code ("tr", "en"). Defaults to "en";
402
+ any unsupported value falls back to "en".
403
+
404
+ Returns:
405
+ List of NewsCategoryListItem
406
+ """
407
+ params: Dict[str, object] = {}
408
+ if locale is not None:
409
+ params["locale"] = locale
410
+
411
+ response = self._client.get("v1/news/categories", params=params)
412
+ return [NewsCategoryListItem(**item) for item in response]
413
+
414
+ def get_news_lanes(self) -> List[NewsLaneListItem]:
415
+ """Retrieve the fixed news lane list.
416
+
417
+ Returns every lane (``id`` + ``label``) for building a lane filter. The
418
+ returned ``id`` values are the exact values accepted by the ``lane``
419
+ filter of :meth:`get_news`, :meth:`get_news_v2` and
420
+ :meth:`get_news_stream` (see :class:`~laplace.models.NewsLane`).
421
+
422
+ Returns:
423
+ List of NewsLaneListItem
424
+ """
425
+ response = self._client.get("v1/news/lanes")
426
+ return [NewsLaneListItem(**item) for item in response]
427
+
428
+ def get_news_api_source_names(self) -> List[NewsApiSourceListItem]:
429
+ """Retrieve the configured news sources.
430
+
431
+ Returns every source (``id`` + ``name``), registry sources first, then
432
+ any legacy sources still on old rows. The returned ``id`` values are
433
+ the exact values accepted by the ``api_source`` filter of
434
+ :meth:`get_news` and :meth:`get_news_v2` and the ``api_sources``
435
+ filter of :meth:`get_news_stream`; ``name`` is the display name
436
+ (e.g. "BBC Business").
437
+
438
+ Returns:
439
+ List of NewsApiSourceListItem
440
+ """
441
+ response = self._client.get("v1/news/api-source-names")
442
+ return [NewsApiSourceListItem(**item) for item in response]
443
+
279
444
  def get_highlights(
280
445
  self,
281
446
  locale: Locale,
@@ -302,20 +467,27 @@ class NewsClient:
302
467
  self,
303
468
  locale: Locale,
304
469
  region: Region,
470
+ lane: Optional[NewsLane] = None,
305
471
  sectors: Optional[List[str]] = None,
306
472
  tickers: Optional[List[str]] = None,
307
473
  categories: Optional[List[str]] = None,
308
474
  industries: Optional[List[str]] = None,
475
+ api_sources: Optional[List[str]] = None,
309
476
  ) -> NewsStream:
310
477
  """Start streaming news updates.
311
478
 
312
479
  Args:
313
480
  locale: Locale code (e.g., "tr", "en")
314
481
  region: Region enum (e.g. Region.TR)
482
+ lane: Optional lane filter. Lanes are region-scoped: US lanes are
483
+ GLOBAL_MACRO and FAST_MOVERS; TR lanes are TR_EKONOMI and BIST.
315
484
  sectors: Optional list of sectors
316
- tickers: Optional list of tickers
485
+ tickers: Optional list of tickers (stream uses tickers, not symbols)
317
486
  categories: Optional list of categories
318
487
  industries: Optional list of industries
488
+ api_sources: Optional list of source ids from
489
+ :meth:`get_news_api_source_names`; only these sources are
490
+ streamed
319
491
 
320
492
  Returns:
321
493
  NewsStream for consuming news items
@@ -324,10 +496,12 @@ class NewsClient:
324
496
  self._client,
325
497
  locale,
326
498
  region,
499
+ lane=lane,
327
500
  sectors=sectors,
328
501
  tickers=tickers,
329
502
  categories=categories,
330
503
  industries=industries,
504
+ api_sources=api_sources,
331
505
  )
332
506
  await stream.subscribe()
333
507
  return stream
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: laplace-python-sdk
3
- Version: 1.2.3
3
+ Version: 1.4.0
4
4
  Summary: Python SDK for Laplace stock data platform
5
5
  Author: Laplace SDK Team
6
6
  License: MIT