Skip to main content

Official Python SDK for The Polaris Report API

Project description

polaris-news

Official Python SDK for The Polaris Report API.

Installation

pip install polaris-news

Quick Start

from polaris_news import PolarisClient

client = PolarisClient(api_key="your-api-key")
feed = client.feed(category="technology", limit=10)
for brief in feed.briefs:
    print(brief.headline)

Methods

Method Description
feed(category?, limit?, page?, per_page?, min_confidence?) Get the news feed
brief(brief_id, include_full_text?) Get a single brief by ID
search(query, category?, page?, per_page?, sort?, min_confidence?, from_date?, to_date?, entity?, sentiment?) Search briefs
generate(topic, category?) Generate a brief on a topic
entities(q?, type?, limit?) List entities
entity_briefs(name, role?, limit?, offset?) Get briefs for an entity
trending_entities(limit?) Get trending entities
similar(brief_id, limit?) Get similar briefs
clusters(period?, limit?) Get brief clusters
data(entity?, type?, limit?) Get structured data points
agent_feed(category?, tags?, limit?, min_confidence?) Get agent-optimized feed
compare_sources(brief_id) Compare sources for a brief
trending(period?, limit?) Get trending briefs
stream(categories?) Stream briefs via SSE (generator)

Error Handling

from polaris_news import PolarisClient, AuthenticationError, RateLimitError, NotFoundError

client = PolarisClient(api_key="your-api-key")

try:
    brief = client.brief("abc123")
except AuthenticationError:
    print("Invalid API key")
except NotFoundError:
    print("Brief not found")
except RateLimitError as e:
    print(f"Rate limited. Retry after: {e.retry_after}s")

Streaming

client = PolarisClient(api_key="your-api-key")

for brief in client.stream(categories="technology,science"):
    print(f"[{brief.category}] {brief.headline}")

Documentation

Full API documentation: https://thepolarisreport.com/docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polaris_news-0.1.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

polaris_news-0.1.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file polaris_news-0.1.0.tar.gz.

File metadata

  • Download URL: polaris_news-0.1.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for polaris_news-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8427bbb1a583ddf4638175f7597b1c60960a29952ffb5f2a89045be0d1a07826
MD5 6b79a1679e01d285e851b98ae0980e8c
BLAKE2b-256 653b4fb00db5fa6628bb5f657e1176d0f56f8a5e17783400cc392f3a9c842bda

See more details on using hashes here.

File details

Details for the file polaris_news-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: polaris_news-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for polaris_news-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fda4d5e0bb9a0841509a6b14b5c1ada9d63b5a533c6fa760347aa6f469131fad
MD5 2ae8db30b3dd6c4d174dc8a14850bc72
BLAKE2b-256 9c2d9720dbeca957c41144aa3937ac108352d3ca418e70e7360957da421758f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page