Skip to main content

Python SDK for the Spoken Alpha API — structured earnings-call data for AI agents.

Project description

spoken-alpha · Python SDK

PyPI Python

Structured earnings-call data for AI agents.

Full API reference: https://api.spokenalpha.com/v1/docs

Note: The PyPI package is spoken-alpha (hyphen). The npm scope uses an underscore (@spoken_alpha/sdk) — see sdks/README.md for the reason.

Install

pip install spoken-alpha

Quick start

from spoken_alpha import Client

with Client(api_key="sa-...") as client:
    ir = client.companies.get_ir_page("AAPL")
    print(ir.ir_page.confidence)

    for call in client.companies.list_earnings_calls("AAPL").iterate_all():
        print(call.call_date, call.fiscal_quarter)

    summary = client.calls.get_summary("call_AAPL_2026Q2_earnings")
    print(summary.summary)

The API key can also be set via the SPOKEN_ALPHA_API_KEY environment variable — Client() picks it up automatically.

Async

from spoken_alpha import AsyncClient

async with AsyncClient() as client:
    results = await client.language_patterns.search("supply chain normalization")
    for r in results.results:
        print(r.ticker, r.snippet)

Error handling

from spoken_alpha import Client, SpokenAlphaNotFoundError, SpokenAlphaRateLimitError

with Client() as client:
    try:
        ir = client.companies.get_ir_page("ZZZZ")
    except SpokenAlphaNotFoundError:
        print("ticker not found")
    except SpokenAlphaRateLimitError as e:
        print(f"rate limited; resets at {e.reset_at}")

All exceptions inherit from SpokenAlphaAPIError. Subclasses:

Class HTTP
SpokenAlphaAuthError 401
SpokenAlphaForbiddenError 403
SpokenAlphaNotFoundError 404
SpokenAlphaValidationError 422
SpokenAlphaRateLimitError 429
SpokenAlphaScaffoldedError 503 (planned endpoint)
SpokenAlphaServerError 5xx
SpokenAlphaTimeoutError timeout
SpokenAlphaNetworkError network

Configuration

Client(
    api_key="sa-...",          # default: SPOKEN_ALPHA_API_KEY env var
    base_url="https://...",    # default: https://api.spokenalpha.com/v1
    timeout=30.0,              # seconds, default 30
    max_retries=2,             # auto-retry on 5xx, default 2
)

License

MIT

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

spoken_alpha-0.1.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

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

spoken_alpha-0.1.0-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for spoken_alpha-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ba7b3df39ecbeaa90baf642bceb19431b5bf085469ce825e08fb7017d56f9c6b
MD5 db0fadd704e4e70b28f9bc7cca18738a
BLAKE2b-256 82de7c4b9f12b027ca62c55260f30d2acd43d0a67c50f08acc6ebf44efccd783

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for spoken_alpha-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57fdb3b393300615844de2bfe7f659d25d52bb1e4aaf19e31750fab6cde4a9f9
MD5 0f836649050e3fd97f6f74e08a57c013
BLAKE2b-256 e309d4963cf4fb9326f36e027ecc0459afccfdc37e06954a8e59dac2a4f5d9c5

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