laplace-python-sdk 1.4.0__tar.gz → 1.5.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.4.0/src/laplace_python_sdk.egg-info → laplace_python_sdk-1.5.0}/PKG-INFO +1 -1
  2. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/pyproject.toml +3 -3
  3. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/models.py +7 -2
  4. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/news.py +119 -76
  5. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0/src/laplace_python_sdk.egg-info}/PKG-INFO +1 -1
  6. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/LICENSE +0 -0
  7. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/MANIFEST.in +0 -0
  8. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/README.md +0 -0
  9. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/setup.cfg +0 -0
  10. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/__init__.py +0 -0
  11. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/base.py +0 -0
  12. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/brokers.py +0 -0
  13. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/capital_increase.py +0 -0
  14. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/client.py +0 -0
  15. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/collections.py +0 -0
  16. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/earnings.py +0 -0
  17. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/financials.py +0 -0
  18. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/funds.py +0 -0
  19. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/live_price.py +0 -0
  20. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/politician.py +0 -0
  21. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/screener.py +0 -0
  22. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/search.py +0 -0
  23. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/state.py +0 -0
  24. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/stocks.py +0 -0
  25. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace/websocket.py +0 -0
  26. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace_python_sdk.egg-info/SOURCES.txt +0 -0
  27. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace_python_sdk.egg-info/dependency_links.txt +0 -0
  28. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.0}/src/laplace_python_sdk.egg-info/requires.txt +0 -0
  29. {laplace_python_sdk-1.4.0 → laplace_python_sdk-1.5.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.4.0
3
+ Version: 1.5.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.4.0"
7
+ version = "1.5.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.4.0"
67
+ python_version = "1.5.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.4.0"
74
+ target-version = "1.5.0"
75
75
 
76
76
  [tool.ruff.lint]
77
77
  select = ["E", "W", "F", "I", "N", "B", "UP"]
@@ -898,8 +898,9 @@ class NewsCategory(BaseModel):
898
898
  class NewsCategoryListItem(BaseModel):
899
899
  """A canonical news category as returned by /api/v1/news/categories.
900
900
 
901
- The ``name`` is the exact value accepted by the ``categories`` filter of the
902
- News V2 and Live News Stream endpoints.
901
+ The numeric ``id`` is the exact value accepted by the ``categoryIds``
902
+ filter of the filter-news and stream-news endpoints; ``name`` is the
903
+ display name for dropdowns.
903
904
  """
904
905
 
905
906
  id: str
@@ -982,6 +983,10 @@ class NewsV2(BaseModel):
982
983
 
983
984
  model_config = {"populate_by_name": True}
984
985
  class NewsHighlight(BaseModel):
986
+ """A daily categorized news highlight as returned by /api/v1/news/highlights."""
987
+
988
+ id: str
989
+ created_at: datetime = Field(alias="createdAt")
985
990
  consumer: List[str]
986
991
  energy_and_utilities: List[str] = Field(alias="energyAndUtilities")
987
992
  finance: List[str]
@@ -47,20 +47,20 @@ class NewsStream:
47
47
  locale: Locale,
48
48
  region: Region,
49
49
  lane: Optional[NewsLane] = None,
50
- sectors: Optional[List[str]] = None,
51
- tickers: Optional[List[str]] = None,
52
- categories: Optional[List[str]] = None,
53
- industries: Optional[List[str]] = None,
50
+ symbols: Optional[List[str]] = None,
51
+ category_ids: Optional[List[str]] = None,
52
+ sector_ids: Optional[List[str]] = None,
53
+ industry_ids: Optional[List[str]] = None,
54
54
  api_sources: Optional[List[str]] = None,
55
55
  ):
56
56
  self.base_client = base_client
57
57
  self.locale = locale
58
58
  self.region = region
59
59
  self.lane = lane
60
- self.sectors = sectors
61
- self.tickers = tickers
62
- self.categories = categories
63
- self.industries = industries
60
+ self.symbols = symbols
61
+ self.category_ids = category_ids
62
+ self.sector_ids = sector_ids
63
+ self.industry_ids = industry_ids
64
64
  self.api_sources = api_sources
65
65
  self._task: Optional[asyncio.Task] = None
66
66
  self._queue: Optional[asyncio.Queue[NewsStreamResult[List[NewsV2]]]] = None
@@ -115,14 +115,14 @@ class NewsStream:
115
115
  params = {"locale": self.locale, "region": self.region.value}
116
116
  if self.lane is not None:
117
117
  params["lane"] = self.lane.value
118
- if self.sectors:
119
- params["sectors"] = ",".join(self.sectors)
120
- if self.tickers:
121
- params["tickers"] = ",".join(self.tickers)
122
- if self.categories:
123
- params["categories"] = ",".join(self.categories)
124
- if self.industries:
125
- params["industries"] = ",".join(self.industries)
118
+ if self.symbols:
119
+ params["symbols"] = ",".join(self.symbols)
120
+ if self.category_ids:
121
+ params["categoryIds"] = ",".join(self.category_ids)
122
+ if self.sector_ids:
123
+ params["sectorIds"] = ",".join(self.sector_ids)
124
+ if self.industry_ids:
125
+ params["industryIds"] = ",".join(self.industry_ids)
126
126
  if self.api_sources:
127
127
  params["apiSource"] = ",".join(self.api_sources)
128
128
 
@@ -212,9 +212,9 @@ class NewsClient:
212
212
  lane: Optional[NewsLane] = None,
213
213
  api_source: Optional[str] = None,
214
214
  symbols: Optional[str] = None,
215
- categories: Optional[str] = None,
216
- sectors: Optional[str] = None,
217
- industries: Optional[str] = None,
215
+ category_ids: Optional[str] = None,
216
+ sector_ids: Optional[str] = None,
217
+ industry_ids: Optional[str] = None,
218
218
  quality_score_min: Optional[int] = None,
219
219
  quality_score_max: Optional[int] = None,
220
220
  timestamp_from: Optional[str] = None,
@@ -226,11 +226,10 @@ class NewsClient:
226
226
  """Retrieve paginated news.
227
227
 
228
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``).
229
+ filters are AND-ed together (e.g. ``(AAPL OR MSFT) AND category 1``).
230
+ The taxonomy filters are ID-based: ``category_ids`` takes the numeric
231
+ ids returned by :meth:`get_news_categories`; ``sector_ids`` and
232
+ ``industry_ids`` take Laplace sector/industry ids.
234
233
 
235
234
  Args:
236
235
  locale: Locale code (e.g. "tr", "en")
@@ -243,9 +242,9 @@ class NewsClient:
243
242
  api_source: Optional comma-separated source ids from
244
243
  :meth:`get_news_api_source_names` (e.g. "BBCBusiness,MarketWatch")
245
244
  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
245
+ category_ids: Optional comma-separated numeric category ids (e.g. "1,3")
246
+ sector_ids: Optional comma-separated Laplace sector ids
247
+ industry_ids: Optional comma-separated Laplace industry ids
249
248
  quality_score_min: Optional minimum quality score, inclusive (0-10)
250
249
  quality_score_max: Optional maximum quality score, inclusive (0-10)
251
250
  timestamp_from: Optional start date, inclusive (YYYY-MM-DD)
@@ -276,12 +275,12 @@ class NewsClient:
276
275
  params["apiSource"] = api_source
277
276
  if symbols:
278
277
  params["symbols"] = symbols
279
- if categories:
280
- params["categories"] = categories
281
- if sectors:
282
- params["sectors"] = sectors
283
- if industries:
284
- params["industries"] = industries
278
+ if category_ids:
279
+ params["categoryIds"] = category_ids
280
+ if sector_ids:
281
+ params["sectorIds"] = sector_ids
282
+ if industry_ids:
283
+ params["industryIds"] = industry_ids
285
284
  if quality_score_min is not None:
286
285
  params["qualityScoreMin"] = quality_score_min
287
286
  if quality_score_max is not None:
@@ -306,9 +305,9 @@ class NewsClient:
306
305
  lane: Optional[NewsLane] = None,
307
306
  api_source: Optional[str] = None,
308
307
  symbols: Optional[str] = None,
309
- categories: Optional[str] = None,
310
- sectors: Optional[str] = None,
311
- industries: Optional[str] = None,
308
+ category_ids: Optional[str] = None,
309
+ sector_ids: Optional[str] = None,
310
+ industry_ids: Optional[str] = None,
312
311
  quality_score_min: Optional[int] = None,
313
312
  quality_score_max: Optional[int] = None,
314
313
  timestamp_from: Optional[str] = None,
@@ -319,11 +318,10 @@ class NewsClient:
319
318
  """Retrieve paginated news (v2).
320
319
 
321
320
  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``).
321
+ filters are AND-ed together (e.g. ``(AAPL OR MSFT) AND category 1``).
322
+ The taxonomy filters are ID-based: ``category_ids`` takes the numeric
323
+ ids returned by :meth:`get_news_categories`; ``sector_ids`` and
324
+ ``industry_ids`` take Laplace sector/industry ids.
327
325
 
328
326
  Args:
329
327
  locale: Locale code (e.g. "tr", "en")
@@ -336,9 +334,9 @@ class NewsClient:
336
334
  api_source: Optional comma-separated source ids from
337
335
  :meth:`get_news_api_source_names` (e.g. "BBCBusiness,MarketWatch")
338
336
  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
337
+ category_ids: Optional comma-separated numeric category ids (e.g. "1,3")
338
+ sector_ids: Optional comma-separated Laplace sector ids
339
+ industry_ids: Optional comma-separated Laplace industry ids
342
340
  quality_score_min: Optional minimum quality score, inclusive (0-10)
343
341
  quality_score_max: Optional maximum quality score, inclusive (0-10)
344
342
  timestamp_from: Optional start date, inclusive (YYYY-MM-DD)
@@ -368,12 +366,12 @@ class NewsClient:
368
366
  params["apiSource"] = api_source
369
367
  if symbols:
370
368
  params["symbols"] = symbols
371
- if categories:
372
- params["categories"] = categories
373
- if sectors:
374
- params["sectors"] = sectors
375
- if industries:
376
- params["industries"] = industries
369
+ if category_ids:
370
+ params["categoryIds"] = category_ids
371
+ if sector_ids:
372
+ params["sectorIds"] = sector_ids
373
+ if industry_ids:
374
+ params["industryIds"] = industry_ids
377
375
  if quality_score_min is not None:
378
376
  params["qualityScoreMin"] = quality_score_min
379
377
  if quality_score_max is not None:
@@ -393,9 +391,10 @@ class NewsClient:
393
391
  """Retrieve the full canonical news category list.
394
392
 
395
393
  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`.
394
+ tagged news, ordered by id ascending. The returned numeric ``id``
395
+ values are the exact values accepted by the ``category_ids`` filter of
396
+ :meth:`get_news`, :meth:`get_news_v2` and :meth:`get_news_stream`;
397
+ ``name`` is the display name for dropdowns.
399
398
 
400
399
  Args:
401
400
  locale: Optional language code ("tr", "en"). Defaults to "en";
@@ -411,7 +410,10 @@ class NewsClient:
411
410
  response = self._client.get("v1/news/categories", params=params)
412
411
  return [NewsCategoryListItem(**item) for item in response]
413
412
 
414
- def get_news_lanes(self) -> List[NewsLaneListItem]:
413
+ def get_news_lanes(
414
+ self,
415
+ region: Optional[Region] = None,
416
+ ) -> List[NewsLaneListItem]:
415
417
  """Retrieve the fixed news lane list.
416
418
 
417
419
  Returns every lane (``id`` + ``label``) for building a lane filter. The
@@ -419,13 +421,24 @@ class NewsClient:
419
421
  filter of :meth:`get_news`, :meth:`get_news_v2` and
420
422
  :meth:`get_news_stream` (see :class:`~laplace.models.NewsLane`).
421
423
 
424
+ Args:
425
+ region: Optional region filter; only lanes valid for this region
426
+
422
427
  Returns:
423
428
  List of NewsLaneListItem
424
429
  """
425
- response = self._client.get("v1/news/lanes")
430
+ params: Dict[str, object] = {}
431
+ if region is not None:
432
+ params["region"] = region.value
433
+
434
+ response = self._client.get("v1/news/lanes", params=params)
426
435
  return [NewsLaneListItem(**item) for item in response]
427
436
 
428
- def get_news_api_source_names(self) -> List[NewsApiSourceListItem]:
437
+ def get_news_api_source_names(
438
+ self,
439
+ region: Optional[Region] = None,
440
+ language: Optional[Locale] = None,
441
+ ) -> List[NewsApiSourceListItem]:
429
442
  """Retrieve the configured news sources.
430
443
 
431
444
  Returns every source (``id`` + ``name``), registry sources first, then
@@ -435,43 +448,72 @@ class NewsClient:
435
448
  filter of :meth:`get_news_stream`; ``name`` is the display name
436
449
  (e.g. "BBC Business").
437
450
 
451
+ Args:
452
+ region: Optional region filter; only sources valid for this region
453
+ language: Optional language filter ("tr", "en"); sources with
454
+ content available in this language
455
+
438
456
  Returns:
439
457
  List of NewsApiSourceListItem
440
458
  """
441
- response = self._client.get("v1/news/api-source-names")
459
+ params: Dict[str, object] = {}
460
+ if region is not None:
461
+ params["region"] = region.value
462
+ if language is not None:
463
+ params["language"] = language
464
+
465
+ response = self._client.get("v1/news/api-source-names", params=params)
442
466
  return [NewsApiSourceListItem(**item) for item in response]
443
467
 
444
468
  def get_highlights(
445
469
  self,
446
470
  locale: Locale,
447
- region: Region
448
- ) -> NewsHighlight:
449
- """Retrieve news highlights.
471
+ region: Region,
472
+ from_date: Optional[str] = None,
473
+ to_date: Optional[str] = None,
474
+ skip: Optional[int] = None,
475
+ top: Optional[int] = None,
476
+ ) -> PaginatedResponse[NewsHighlight]:
477
+ """Retrieve paginated news highlights, newest first.
450
478
 
451
479
  Args:
452
480
  locale: Locale code (e.g. "tr", "en")
453
- region: Region enum (e.g. Region.TR)
481
+ region: Region enum (must be Region.US; "tr" is rejected)
482
+ from_date: Optional lower bound, inclusive (YYYY-MM-DD); lists
483
+ highlights created on/after this date
484
+ to_date: Optional upper bound, inclusive of the day (YYYY-MM-DD)
485
+ skip: Optional pagination offset
486
+ top: Optional page size (1-20)
454
487
 
455
488
  Returns:
456
- NewsHighlight
489
+ PaginatedResponse[NewsHighlight]
457
490
  """
458
491
  params: Dict[str, object] = {
459
492
  "locale": locale,
460
- "region": region.value
493
+ "region": region.value,
461
494
  }
462
495
 
496
+ if from_date:
497
+ params["from"] = from_date
498
+ if to_date:
499
+ params["to"] = to_date
500
+ if skip is not None:
501
+ params["skip"] = skip
502
+ if top is not None:
503
+ params["top"] = top
504
+
463
505
  response = self._client.get("v1/news/highlights", params=params)
464
- return NewsHighlight(**response)
506
+ return PaginatedResponse[NewsHighlight](**response)
465
507
 
466
508
  async def get_news_stream(
467
509
  self,
468
510
  locale: Locale,
469
511
  region: Region,
470
512
  lane: Optional[NewsLane] = None,
471
- sectors: Optional[List[str]] = None,
472
- tickers: Optional[List[str]] = None,
473
- categories: Optional[List[str]] = None,
474
- industries: Optional[List[str]] = None,
513
+ symbols: Optional[List[str]] = None,
514
+ category_ids: Optional[List[str]] = None,
515
+ sector_ids: Optional[List[str]] = None,
516
+ industry_ids: Optional[List[str]] = None,
475
517
  api_sources: Optional[List[str]] = None,
476
518
  ) -> NewsStream:
477
519
  """Start streaming news updates.
@@ -481,10 +523,11 @@ class NewsClient:
481
523
  region: Region enum (e.g. Region.TR)
482
524
  lane: Optional lane filter. Lanes are region-scoped: US lanes are
483
525
  GLOBAL_MACRO and FAST_MOVERS; TR lanes are TR_EKONOMI and BIST.
484
- sectors: Optional list of sectors
485
- tickers: Optional list of tickers (stream uses tickers, not symbols)
486
- categories: Optional list of categories
487
- industries: Optional list of industries
526
+ symbols: Optional list of ticker symbols (same param as filter-news)
527
+ category_ids: Optional list of numeric category ids from
528
+ :meth:`get_news_categories`
529
+ sector_ids: Optional list of Laplace sector ids
530
+ industry_ids: Optional list of Laplace industry ids
488
531
  api_sources: Optional list of source ids from
489
532
  :meth:`get_news_api_source_names`; only these sources are
490
533
  streamed
@@ -497,10 +540,10 @@ class NewsClient:
497
540
  locale,
498
541
  region,
499
542
  lane=lane,
500
- sectors=sectors,
501
- tickers=tickers,
502
- categories=categories,
503
- industries=industries,
543
+ symbols=symbols,
544
+ category_ids=category_ids,
545
+ sector_ids=sector_ids,
546
+ industry_ids=industry_ids,
504
547
  api_sources=api_sources,
505
548
  )
506
549
  await stream.subscribe()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: laplace-python-sdk
3
- Version: 1.4.0
3
+ Version: 1.5.0
4
4
  Summary: Python SDK for Laplace stock data platform
5
5
  Author: Laplace SDK Team
6
6
  License: MIT