Skip to main content

Common schemas used by Apex Trader

Project description

at-common-schemas

Common schema definitions used by Apex Trader services, built with Pydantic.

Installation

pip install at-common-schemas

Features

  • Standardized data models for financial market data
  • Built with Pydantic for robust data validation
  • Comprehensive type hints and documentation
  • Automatic serialization of datetime and enum values

Available Schemas

Stock Data

  • Profile information
  • Real-time quotes
  • Daily candlestick data
  • Technical indicators
  • Financial statements
    • Balance Sheet
    • Income Statement
    • Cash Flow
  • Financial analysis
    • Key metrics
    • Financial ratios
    • TTM (Trailing Twelve Months) metrics
  • Earnings call transcripts

Market Data

  • Stock symbols by exchange
  • Market news
  • Company-specific news
  • Calendar events
    • Earnings announcements
    • Dividend declarations
    • Stock splits

Usage Examples

Fetching Stock Quote Data

from at_common_schemas.service.data.stock.quote import StockQuoteRequest, StockQuoteResponse

# Single stock quote request
request = StockQuoteRequest(symbol="AAPL")

# Batch quote request
batch_request = StockQuoteBatchRequest(symbols=["AAPL", "MSFT", "GOOGL"])

Working with Financial Statements

from at_common_schemas.service.data.stock.financial import StockFinancialStatementBatchRequest
from at_common_schemas.common.stock import StockFinancialPeriod

request = StockFinancialStatementBatchRequest(
    symbol="AAPL",
    period=StockFinancialPeriod.QUARTERLY,
    limit=4
)

Development

Requirements:

  • Python 3.11+
  • pydantic 2.10.6+
  • annotated-types 0.7.0+
  • typing_extensions 4.12.2+

License

This project is licensed for private use and internal purposes only. Redistribution or modification is not permitted without prior consent.

Contributing

Contributions are welcome for internal use only. Please ensure that any changes adhere to the project's coding standards and are reviewed before submission.

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

at_common_schemas-1.1.13.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

at_common_schemas-1.1.13-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file at_common_schemas-1.1.13.tar.gz.

File metadata

  • Download URL: at_common_schemas-1.1.13.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for at_common_schemas-1.1.13.tar.gz
Algorithm Hash digest
SHA256 1fde569cc25346b315998e4740ec3e6f38e2c8db5646aad2c451d87249783a15
MD5 4d1a3d341069408d6d5f9ad8e0f96f37
BLAKE2b-256 1026363a57506c918b907551776baef732908c04ba8dac3c82c098aeb087c0f7

See more details on using hashes here.

File details

Details for the file at_common_schemas-1.1.13-py3-none-any.whl.

File metadata

File hashes

Hashes for at_common_schemas-1.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 38878fd7d2d5c1e0033173be5ceee54c19d44d1595c32f685f73a03c44c93704
MD5 a6fb70a6bb4d7bae6b1465998df8d23a
BLAKE2b-256 4e1f18b1b121eb508ff29ba0f474edb58d183dd59e4818600faab427d50c1c7f

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