marketstack-python-client 1.0.0__py3-none-any.whl

marketstack/models/ticker.py

@@ -0,0 +1,159 @@
+from typing import Union
+from types import NoneType
+from pydantic import BaseModel
+from .exchange import ExchangeDateTime
+from .pagination import Pagniation, PaginationRequest, DateString
+from .eod import EODBar
+
+
+class TickerResponse(BaseModel):
+    name: str
+    """Company or instrument name."""
+    symbol: str
+    """Ticker symbol."""
+    cik: Union[NoneType, str] = None
+    """SEC Central Index Key."""
+    isin: Union[NoneType, str] = None
+    """International Securities Identification Number."""
+    cusip: Union[NoneType, str] = None
+    """U.S./Canada security identifier (CUSIP)."""
+    ein_employer_id: Union[NoneType, str] = None
+    """Employer Identification Number."""
+    lei: Union[NoneType, str] = None
+    """Legal Entity Identifier."""
+    series_id: Union[NoneType, str] = None
+    """Series ID."""
+    item_type: Union[NoneType, str] = None
+    """Type of item (e.g., equity)."""
+    sector: Union[NoneType, str] = None
+    """Sector of the company."""
+    industry: Union[NoneType, str] = None
+    """Industry of the company."""
+    sic_code: Union[NoneType, str] = None
+    """Standard Industrial Classification code."""
+    sic_name: Union[NoneType, str] = None
+    """SIC description."""
+    stock_exchange: Union[NoneType, "TickerExchange"] = None
+    comments: Union[NoneType, str] = None
+    """Additional comments."""
+    has_intraday: Union[NoneType, bool] = None
+    has_eod: Union[NoneType, bool] = None
+    country: Union[NoneType, str] = None
+
+
+class TickerExchange(BaseModel):
+    """Stock exchange as embedded in ticker responses. Note: date fields serialize as objects here, unlike the /exchanges endpoints which return date strings."""
+
+    name: str
+    """Name of the stock exchange."""
+    acronym: Union[NoneType, str] = None
+    """Acronym of the stock exchange."""
+    mic: str
+    """MIC identification of the exchange."""
+    country: Union[NoneType, str] = None
+    """Country of the stock exchange."""
+    country_code: Union[NoneType, str] = None
+    """Three-letter country code of the exchange."""
+    city: Union[NoneType, str] = None
+    """City where the exchange is located."""
+    website: Union[NoneType, str] = None
+    """Website URL of the exchange."""
+    operating_mic: Union[NoneType, str] = None
+    """Operating Market Identifier Code."""
+    oprt_sgmt: Union[NoneType, str] = None
+    """Indicates operating MIC vs market segment MIC."""
+    legal_entity_name: Union[NoneType, str] = None
+    """Legal entity name."""
+    exchange_lei: Union[NoneType, str] = None
+    """Exchange Legal Entity Identifier (LEI)."""
+    market_category_code: Union[NoneType, str] = None
+    """Market category code."""
+    exchange_status: Union[NoneType, str] = None
+    """Current status of the exchange."""
+    date_creation: Union[NoneType, ExchangeDateTime] = None
+    date_last_update: Union[NoneType, ExchangeDateTime] = None
+    date_last_validation: Union[NoneType, ExchangeDateTime] = None
+    date_expiry: Union[NoneType, "TickerExchange_date_expiry"] = None
+
+
+class TickerExchange_date_expiry(BaseModel):
+    """Expiry date (object or null)."""
+
+    date: str
+    timezone_type: int
+    timezone: str
+
+
+class TickerEODRequest(PaginationRequest, total=False):
+    date_from: Union[NoneType, DateString] = None
+    """Filter results from a specific start date. [Format: YYYY-MM-DD]
+    """
+    date_to: Union[NoneType, DateString] = None
+    """Filter results up to a specific end date. [Format: YYYY-MM-DD]
+    """
+
+
+class TickerEODResponse(BaseModel):
+    pagination: Pagniation
+    data: "TickerEODResponse_data"
+
+
+class TickerEODResponse_data(BaseModel):
+    name: str
+    """Company or instrument name."""
+    symbol: str
+    """Ticker symbol."""
+    has_intraday: bool
+    """Indicates if intraday data is available."""
+    has_eod: bool
+    """Indicates if end-of-day data is available."""
+    country: Union[NoneType, str] = None
+    """Country of the ticker."""
+    eod: list[EODBar]
+
+
+class TickerEODLatestRequest(PaginationRequest, total=False):
+    pass
+
+
+class TickerSplitsRequest(PaginationRequest, total=False):
+    date_from: Union[NoneType, DateString] = None
+    """Filter results from a specific start date. [Format: YYYY-MM-DD]
+    """
+    date_to: Union[NoneType, DateString] = None
+    """Filter results up to a specific end date. [Format: YYYY-MM-DD]
+    """
+
+
+class TickerSplitsResponse(BaseModel):
+    pagination: Pagniation
+    data: list["TickerSplitsResponse_data"]
+
+
+class TickerSplitsResponse_data(BaseModel):
+    date: str
+    """Date of the split."""
+    split_factor: float
+    """Split ratio applied on the date."""
+    stock_split: Union[NoneType, str] = None
+    """Additional stock split info (nullable)."""
+    symbol: str
+    """Ticker symbol the split applies to."""
+
+
+class TickerIntradayRequest(PaginationRequest, total=False):
+    interval: Union[NoneType, str] = None
+    """Interval for intraday data."""
+    after_hours: Union[NoneType, bool] = None
+    """Include after hours data."""
+    date_from: Union[NoneType, DateString] = None
+    """Filter results from a specific start date."""
+    date_to: Union[NoneType, DateString] = None
+    """Filter results up to a specific end date."""
+
+
+class TickerDividendsRequest(PaginationRequest, total=False):
+    date_from: Union[NoneType, DateString] = None
+    """Filter results from a specific start date."""
+    date_to: Union[NoneType, DateString] = None
+    """Filter results up to a specific end date."""

marketstack/models/ticker_info.py

@@ -0,0 +1,197 @@
+from pydantic import BaseModel, Field
+from typing import Union
+from types import NoneType
+from .pagination import Pagniation, PaginationRequest
+from .ticker import TickerExchange
+from .eod import EODBar
+from .intraday import IntradayBar
+from typing import TypedDict
+
+
+class TickerInfoRequest(TypedDict, total=False):
+    ticker: Union[NoneType, str] = None
+    """Specify stock ticker symbol."""
+
+class TickersListRequest(PaginationRequest, total=False):
+    search: Union[NoneType, str] = None
+    """Search for tickers."""
+    exchange: Union[NoneType, str] = None
+    """Filter by stock exchange."""
+
+class Ticker(BaseModel):
+    name: str
+    """Company or instrument name."""
+    symbol: str
+    """Ticker symbol."""
+    has_intraday: bool
+    """Indicates if intraday data is available."""
+    has_eod: bool
+    """Indicates if end-of-day data is available."""
+    country: Union[NoneType, str] = None
+    """Country of the ticker."""
+    stock_exchanges: list["TickerExchange"]
+
+class TickerInfoExecutive(BaseModel):
+    name: str
+    """Executive name."""
+    salary: str
+    """Executive salary."""
+    function: str
+    """Executive function/role."""
+    exercised: str
+    """Exercised options/shares."""
+    birth_year: str
+    """Birth year."""
+
+class TickerInfoAddress(BaseModel):
+    """Postal address."""
+    city: Union[NoneType, str] = None
+    street1: Union[NoneType, str] = None
+    street2: Union[NoneType, str] = None
+    postal_code: Union[NoneType, str] = None
+    stateOrCountry: Union[NoneType, str] = None
+    state_or_country_description: Union[NoneType, str] = None
+
+class TickerInfoExchange(BaseModel):
+    exchange_name: Union[NoneType, str] = None
+    acronym1: Union[NoneType, str] = None
+    exchange_mic: Union[NoneType, str] = None
+    alpha2_code: Union[NoneType, str] = None
+    country: Union[NoneType, str] = None
+    city: Union[NoneType, str] = None
+    website: Union[NoneType, str] = None
+
+class TickerPreviousName(BaseModel):
+    name: Union[NoneType, str] = None
+    date_from: Union[NoneType, str] = Field(None, alias="from")
+
+class TickerInfoData(BaseModel):
+    name: str
+    """Company or instrument name."""
+    ticker: str
+    """Ticker symbol."""
+    item_type: Union[NoneType, str] = None
+    """Type of item (e.g., equity)."""
+    sector: Union[NoneType, str] = None
+    """Sector of the company."""
+    industry: Union[NoneType, str] = None
+    """Industry of the company."""
+    exchange_code: Union[NoneType, str] = None
+    """Exchange code."""
+    full_time_employees: Union[NoneType, str] = None
+    """Number of full-time employees."""
+    ipo_date: Union[NoneType, str] = None
+    """IPO date."""
+    date_founded: Union[NoneType, str] = None
+    """Date founded."""
+    key_executives: list[TickerInfoExecutive] = []
+    incorporation: Union[NoneType, str] = None
+    """State or country of incorporation."""
+    incorporation_description: Union[NoneType, str] = None
+    """State or country of incorporation, described."""
+    start_fiscal: Union[NoneType, str] = None
+    """Fiscal year start (MM-DD)."""
+    end_fiscal: Union[NoneType, str] = None
+    """Fiscal year end (MM-DD)."""
+    mission: Union[NoneType, str] = None
+    """Company mission statement."""
+    vision: Union[NoneType, str] = None
+    """Company vision statement."""
+    previous_names: list[TickerPreviousName] = []
+    """Former names of the company."""
+    post_address: Union[NoneType, TickerInfoAddress] = None
+    """Postal address."""
+    stock_exchanges: list[TickerInfoExchange] = []
+    """Exchanges the ticker is listed on."""
+    reporting_currency: Union[NoneType, str] = None
+    """Reporting currency."""
+    address: Union[NoneType, TickerInfoAddress] = None
+    phone: Union[NoneType, str] = None
+    """Company phone number."""
+    website: Union[NoneType, str] = None
+    """Company website."""
+    about: Union[NoneType, str] = None
+    """Company description."""
+
+class TickerInfoResponse(BaseModel):
+    data: TickerInfoData
+
+class TickerIntradayData(BaseModel):
+    name: str
+    """Company or instrument name."""
+    symbol: str
+    """Ticker symbol."""
+    has_intraday: bool
+    """Indicates if intraday data is available."""
+    has_eod: bool
+    """Indicates if end-of-day data is available."""
+    country: Union[NoneType, str] = None
+    """Country of the ticker."""
+    intraday: list["IntradayBar"]
+
+class TickerIntradayResponse(BaseModel):
+    pagination: Pagniation
+    data: "TickerIntradayData"
+
+class TickerDividendItem(BaseModel):
+    date: str
+    """Ex-dividend date."""
+    dividend: float
+    """Dividend amount per share."""
+    payment_date: Union[NoneType, str] = None
+    """Payment date of the dividend."""
+    record_date: Union[NoneType, str] = None
+    """Record date for the dividend."""
+    declaration_date: Union[NoneType, str] = None
+    """Declaration date for the dividend."""
+    distr_freq: Union[NoneType, str] = None
+    """Distribution frequency (e.g., q for quarterly)."""
+    symbol: str
+    """Ticker symbol the dividend applies to."""
+
+class TickerDividendsResponse(BaseModel):
+    pagination: Pagniation
+    data: list["TickerDividendItem"]
+
+class TickerEodData(BaseModel):
+    name: str
+    """Company or instrument name."""
+    symbol: str
+    """Ticker symbol."""
+    has_intraday: bool
+    """Indicates if intraday data is available."""
+    has_eod: bool
+    """Indicates if end-of-day data is available."""
+    country: Union[NoneType, str] = None
+    """Country of the ticker."""
+    eod: list["EODBar"]
+
+class TickerEodResponse(BaseModel):
+    pagination: Pagniation
+    data: "TickerEodData"
+
+class TickerListItem(BaseModel):
+    name: str
+    """Company or instrument name."""
+    ticker: str
+    """Ticker symbol."""
+    has_intraday: bool
+    """Indicates if intraday data is available."""
+    has_eod: bool
+    """Indicates if end-of-day data is available."""
+    stock_exchange: "TickerExchange"
+
+class TickersListResponse(BaseModel):
+    pagination: Pagniation
+    data: list[TickerListItem]
+
+
+# Rebuild models to resolve forward references
+TickerInfoResponse.model_rebuild()
+TickerInfoData.model_rebuild()
+TickersListResponse.model_rebuild()
+TickerIntradayData.model_rebuild()
+TickerIntradayResponse.model_rebuild()
+TickerEodData.model_rebuild()
+TickerEodResponse.model_rebuild()
+TickerDividendsResponse.model_rebuild()

marketstack/models/timezone.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel
+from typing import Union
+from types import NoneType
+from .pagination import Pagniation, PaginationRequest
+from typing import TypedDict
+
+
+class TimezonesRequest(PaginationRequest, total=False):
+    pass
+
+class Timezone(BaseModel):
+    timezone: str
+    """IANA timezone name."""
+    abbr: str
+    """Standard time abbreviation."""
+    abbr_dst: str
+    """Daylight saving time abbreviation."""
+
+class TimezonesResponse(BaseModel):
+    pagination: Pagniation
+    data: list["Timezone"]

marketstack/namespaces/bond/__init__.py

@@ -0,0 +1 @@
+from .bond import Bond

marketstack/namespaces/bond/bond.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.bond import BondInfoResponse, BondRequest
+
+
+class Bond:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[BondRequest]) -> BondInfoResponse:
+        """Obtain bond information for a specific country."""
+        return BondInfoResponse.model_validate(self.http_client.get("/v2/bond", params=params))

marketstack/namespaces/bondlist/__init__.py

@@ -0,0 +1 @@
+from .bondlist import BondList

marketstack/namespaces/bondlist/bondlist.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.bond import BondListResponse, BondListRequest
+
+
+class BondList:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def list(self, **params: Unpack[BondListRequest]) -> BondListResponse:
+        """Obtain a list of supported bond countries."""
+        return BondListResponse.model_validate(self.http_client.get("/v2/bondlist", params=params))

marketstack/namespaces/cikcode/__init__.py

@@ -0,0 +1 @@
+from .cikcode import CIKCode

marketstack/namespaces/cikcode/cikcode.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.cik_code import CIKSearchResponse, CIKCodeRequest
+
+
+class CIKCode:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def search(self, **params: Unpack[CIKCodeRequest]) -> CIKSearchResponse:
+        """Search for a company by CIK code using company name."""
+        return CIKSearchResponse.model_validate(self.http_client.get("/v2/cik_code", params=params))

marketstack/namespaces/commodities/__init__.py

@@ -0,0 +1 @@
+from .commodities import Commodities

marketstack/namespaces/commodities/commodities.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.commodity import CommodityResponse, CommoditiesRequest
+
+
+class Commodities:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[CommoditiesRequest]) -> CommodityResponse:
+        """Obtain commodity prices."""
+        return CommodityResponse.model_validate(self.http_client.get("/v2/commodities", params=params))

marketstack/namespaces/commoditieshistory/__init__.py

@@ -0,0 +1 @@
+from .commoditieshistory import CommoditiesHistory

marketstack/namespaces/commoditieshistory/commoditieshistory.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.commodity import CommodityHistoricalResponse, CommoditiesHistoryRequest
+
+
+class CommoditiesHistory:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[CommoditiesHistoryRequest]) -> CommodityHistoricalResponse:
+        """Obtain commodity price history."""
+        return CommodityHistoricalResponse.model_validate(self.http_client.get("/v2/commoditieshistory", params=params))

marketstack/namespaces/company_facts/__init__.py

@@ -0,0 +1 @@
+from .company_facts import CompanyFacts

marketstack/namespaces/company_facts/company_facts.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.company import CompanyFactsByCIKResponse, CompanyFactsRequest
+
+
+class CompanyFacts:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[CompanyFactsRequest]) -> CompanyFactsByCIKResponse:
+        """Obtain company facts by CIK code."""
+        return CompanyFactsByCIKResponse.model_validate(self.http_client.get("/v2/company_facts", params=params))

marketstack/namespaces/companyname/__init__.py

@@ -0,0 +1 @@
+from .companyname import CompanyName

marketstack/namespaces/companyname/companyname.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.company import CompanyNameByCIKResponse, CompanyNameRequest
+
+
+class CompanyName:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[CompanyNameRequest]) -> CompanyNameByCIKResponse:
+        """Search company by name/CIK code."""
+        return CompanyNameByCIKResponse.model_validate(self.http_client.get("/v2/company_name", params=params))

marketstack/namespaces/companyratings/__init__.py

@@ -0,0 +1 @@
+from .companyratings import CompanyRatings

marketstack/namespaces/companyratings/companyratings.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.company import CompanyRatingsResponse, CompanyRatingsRequest
+
+
+class CompanyRatings:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[CompanyRatingsRequest]) -> CompanyRatingsResponse:
+        """Obtain company ratings."""
+        return CompanyRatingsResponse.model_validate(self.http_client.get("/v2/companyratings", params=params))

marketstack/namespaces/concept/__init__.py

@@ -0,0 +1 @@
+from .concept import Concept

marketstack/namespaces/concept/concept.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.concept import AccountsPayableResponse, ConceptRequest
+
+
+class Concept:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get_accounts_payable(self, **params: Unpack[ConceptRequest]) -> AccountsPayableResponse:
+        """Obtain accounts payable concept info."""
+        return AccountsPayableResponse.model_validate(self.http_client.get("/v2/concept/accounts_payable", params=params))

marketstack/namespaces/currencies/__init__.py

@@ -0,0 +1 @@
+from .currencies import Currencies

marketstack/namespaces/currencies/currencies.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.currency import CurrenciesResponse, CurrenciesRequest
+
+
+class Currencies:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def list(self, **params: Unpack[CurrenciesRequest]) -> CurrenciesResponse:
+        """List supported currencies."""
+        return CurrenciesResponse.model_validate(self.http_client.get("/v2/currencies", params=params))

marketstack/namespaces/dividends/__init__.py

@@ -0,0 +1 @@
+from .dividends import Dividends

marketstack/namespaces/dividends/dividends.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.dividend import DividendsResponse, DividendsRequest
+
+
+class Dividends:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def list(self, **params: Unpack[DividendsRequest]) -> DividendsResponse:
+        """List stock dividends."""
+        return DividendsResponse.model_validate(self.http_client.get("/v2/dividends", params=params))

marketstack/namespaces/eod/__init__.py

@@ -0,0 +1 @@
+from .eod import EOD

marketstack/namespaces/eod/eod.py

@@ -0,0 +1,20 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.eod import EODResponse, EODRequest, EODLatestRequest
+
+
+class EOD:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def list(self, **params: Unpack[EODRequest]) -> EODResponse:
+        """Obtain end-of-day data."""
+        return EODResponse.model_validate(self.http_client.get("/v2/eod", params=params))
+
+    def latest(self, **params: Unpack[EODLatestRequest]) -> EODResponse:
+        """Obtain latest end-of-day data."""
+        return EODResponse.model_validate(self.http_client.get("/v2/eod/latest", params=params))
+
+    def for_a_date(self, date: str, **params: Unpack[EODRequest]) -> EODResponse:
+        """Obtain end-of-day data for a specific date."""
+        return EODResponse.model_validate(self.http_client.get(f"/v2/eod/{date}", params=params))

marketstack/namespaces/etfholdings/__init__.py

@@ -0,0 +1 @@
+from .etfholdings import ETFHoldings

marketstack/namespaces/etfholdings/etfholdings.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.etf import ETFHoldingsResponse, ETFHoldingsRequest
+
+
+class ETFHoldings:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def get(self, **params: Unpack[ETFHoldingsRequest]) -> ETFHoldingsResponse:
+        """Obtain ETF Holdings."""
+        return ETFHoldingsResponse.model_validate(self.http_client.get("/v2/etfholdings", params=params))

marketstack/namespaces/etflist/__init__.py

@@ -0,0 +1 @@
+from .etflist import ETFList

marketstack/namespaces/etflist/etflist.py

@@ -0,0 +1,12 @@
+from marketstack.client.http import HTTPClient
+from typing import Unpack
+from marketstack.models.etf import ETFListResponse, ETFListRequest
+
+
+class ETFList:
+    def __init__(self, http_client: HTTPClient):
+        self.http_client = http_client
+
+    def list(self, **params: Unpack[ETFListRequest]) -> ETFListResponse:
+        """List ETFs."""
+        return ETFListResponse.model_validate(self.http_client.get("/v2/etflist", params=params))

marketstack/namespaces/exchanges/__init__.py

@@ -0,0 +1 @@
+from .exchanges import Exchanges, ExchangeInstance, ExchangeEOD, ExchangeIntraday, ExchangeTickers