fmp-data 0.1.0__py3-none-any.whl

fmp_data/__init__.py

@@ -0,0 +1,29 @@
+# fmp_data/__init__.py
+from fmp_data.client import FMPDataClient
+from fmp_data.config import ClientConfig, LoggingConfig, RateLimitConfig
+from fmp_data.exceptions import (
+    AuthenticationError,
+    ConfigError,
+    FMPError,
+    RateLimitError,
+    ValidationError,
+)
+from fmp_data.logger import FMPLogger
+
+# Initialize the logger when the library is imported
+logger = FMPLogger()
+
+__all__ = [
+    "FMPDataClient",
+    "ClientConfig",
+    "LoggingConfig",
+    "RateLimitConfig",
+    "FMPError",
+    "RateLimitError",
+    "AuthenticationError",
+    "ValidationError",
+    "ConfigError",
+    "logger",
+]
+
+__version__ = "0.1.0"

fmp_data/alternative/__init__.py

@@ -0,0 +1,32 @@
+# fmp_data/alternative/__init__.py
+from fmp_data.alternative.client import AlternativeMarketsClient
+from fmp_data.alternative.models import (
+    Commodity,
+    CommodityHistoricalPrice,
+    CommodityIntradayPrice,
+    CommodityQuote,
+    CryptoHistoricalPrice,
+    CryptoIntradayPrice,
+    CryptoPair,
+    CryptoQuote,
+    ForexHistoricalPrice,
+    ForexIntradayPrice,
+    ForexPair,
+    ForexQuote,
+)
+
+__all__ = [
+    "AlternativeMarketsClient",
+    "CryptoPair",
+    "CryptoQuote",
+    "CryptoHistoricalPrice",
+    "CryptoIntradayPrice",
+    "ForexPair",
+    "ForexQuote",
+    "ForexHistoricalPrice",
+    "ForexIntradayPrice",
+    "Commodity",
+    "CommodityQuote",
+    "CommodityHistoricalPrice",
+    "CommodityIntradayPrice",
+]

fmp_data/alternative/client.py

@@ -0,0 +1,144 @@
+# fmp_data/alternative/client.py
+from datetime import date
+
+from fmp_data.alternative.endpoints import (
+    COMMODITIES_LIST,
+    COMMODITIES_QUOTES,
+    COMMODITY_HISTORICAL,
+    COMMODITY_INTRADAY,
+    COMMODITY_QUOTE,
+    CRYPTO_HISTORICAL,
+    CRYPTO_INTRADAY,
+    CRYPTO_LIST,
+    CRYPTO_QUOTE,
+    CRYPTO_QUOTES,
+    FOREX_HISTORICAL,
+    FOREX_INTRADAY,
+    FOREX_LIST,
+    FOREX_QUOTE,
+    FOREX_QUOTES,
+)
+from fmp_data.alternative.models import (
+    Commodity,
+    CommodityIntradayPrice,
+    CommodityPriceHistory,
+    CommodityQuote,
+    CryptoHistoricalData,
+    CryptoIntradayPrice,
+    CryptoPair,
+    CryptoQuote,
+    ForexIntradayPrice,
+    ForexPair,
+    ForexPriceHistory,
+    ForexQuote,
+)
+from fmp_data.base import EndpointGroup
+
+
+class AlternativeMarketsClient(EndpointGroup):
+    """Client for alternative markets endpoints"""
+
+    # Cryptocurrency methods
+    def get_crypto_list(self) -> list[CryptoPair]:
+        """Get list of available cryptocurrencies"""
+        return self.client.request(CRYPTO_LIST)
+
+    def get_crypto_quotes(self) -> list[CryptoQuote]:
+        """Get cryptocurrency quotes"""
+        return self.client.request(CRYPTO_QUOTES)
+
+    def get_crypto_quote(self, symbol: str) -> CryptoQuote:
+        """Get cryptocurrency quote"""
+        result = self.client.request(CRYPTO_QUOTE, symbol=symbol)
+        return result[0] if isinstance(result, list) else result
+
+    def get_crypto_historical(
+        self,
+        symbol: str,
+        start_date: date | None = None,
+        end_date: date | None = None,
+    ) -> CryptoHistoricalData:
+        """Get cryptocurrency historical prices"""
+        params = {"symbol": symbol}
+        if start_date:
+            params["from"] = start_date.strftime("%Y-%m-%d")
+        if end_date:
+            params["to"] = end_date.strftime("%Y-%m-%d")
+
+        return self.client.request(CRYPTO_HISTORICAL, **params)
+
+    def get_crypto_intraday(
+        self, symbol: str, interval: str = "5min"
+    ) -> list[CryptoIntradayPrice]:
+        """Get cryptocurrency intraday prices"""
+        return self.client.request(CRYPTO_INTRADAY, symbol=symbol, interval=interval)
+
+    # Forex methods
+    def get_forex_list(self) -> list[ForexPair]:
+        """Get list of available forex pairs"""
+        return self.client.request(FOREX_LIST)
+
+    def get_forex_quotes(self) -> list[ForexQuote]:
+        """Get forex quotes"""
+        return self.client.request(FOREX_QUOTES)
+
+    def get_forex_quote(self, symbol: str) -> ForexQuote:
+        """Get forex quote"""
+        result = self.client.request(FOREX_QUOTE, symbol=symbol)
+        return result[0] if isinstance(result, list) else result
+
+    def get_forex_historical(
+        self,
+        symbol: str,
+        start_date: date | None = None,
+        end_date: date | None = None,
+    ) -> ForexPriceHistory:
+        """Get forex historical prices"""
+        params = {"symbol": symbol}
+        if start_date:
+            params["from"] = start_date.strftime("%Y-%m-%d")
+        if end_date:
+            params["to"] = end_date.strftime("%Y-%m-%d")
+
+        return self.client.request(FOREX_HISTORICAL, **params)
+
+    def get_forex_intraday(
+        self, symbol: str, interval: str = "5min"
+    ) -> list[ForexIntradayPrice]:
+        """Get forex intraday prices"""
+        return self.client.request(FOREX_INTRADAY, symbol=symbol, interval=interval)
+
+    # Commodities methods
+    def get_commodities_list(self) -> list[Commodity]:
+        """Get list of available commodities"""
+        return self.client.request(COMMODITIES_LIST)
+
+    def get_commodities_quotes(self) -> list[CommodityQuote]:
+        """Get commodities quotes"""
+        return self.client.request(COMMODITIES_QUOTES)
+
+    def get_commodity_quote(self, symbol: str) -> CommodityQuote:
+        """Get commodity quote"""
+        result = self.client.request(COMMODITY_QUOTE, symbol=symbol)
+        return result[0] if isinstance(result, list) else result
+
+    def get_commodity_historical(
+        self,
+        symbol: str,
+        start_date: date | None = None,
+        end_date: date | None = None,
+    ) -> CommodityPriceHistory:
+        """Get commodity historical prices"""
+        params = {"symbol": symbol}
+        if start_date:
+            params["from"] = start_date.strftime("%Y-%m-%d")
+        if end_date:
+            params["to"] = end_date.strftime("%Y-%m-%d")
+
+        return self.client.request(COMMODITY_HISTORICAL, **params)
+
+    def get_commodity_intraday(
+        self, symbol: str, interval: str = "5min"
+    ) -> list[CommodityIntradayPrice]:
+        """Get commodity intraday prices"""
+        return self.client.request(COMMODITY_INTRADAY, symbol=symbol, interval=interval)

fmp_data/alternative/endpoints.py

@@ -0,0 +1,359 @@
+from fmp_data.alternative.models import (
+    Commodity,
+    CommodityIntradayPrice,
+    CommodityPriceHistory,
+    CommodityQuote,
+    CryptoHistoricalData,
+    CryptoIntradayPrice,
+    CryptoPair,
+    CryptoQuote,
+    ForexIntradayPrice,
+    ForexPair,
+    ForexPriceHistory,
+    ForexQuote,
+)
+from fmp_data.models import (
+    APIVersion,
+    Endpoint,
+    EndpointParam,
+    HTTPMethod,
+    ParamLocation,
+    ParamType,
+    URLType,
+)
+
+CRYPTO_LIST = Endpoint(
+    name="crypto_list",
+    path="symbol/available-cryptocurrencies",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get list of available cryptocurrencies",
+    mandatory_params=[],
+    optional_params=[],
+    response_model=CryptoPair,
+)
+
+CRYPTO_QUOTES = Endpoint(
+    name="crypto_quotes",
+    path="quotes/crypto",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get cryptocurrency quotes",
+    mandatory_params=[],
+    optional_params=[],
+    response_model=CryptoQuote,
+)
+
+CRYPTO_QUOTE = Endpoint(
+    name="crypto_quote",
+    path="quote/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get cryptocurrency quote",
+    mandatory_params=[
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Crypto pair symbol",
+        )
+    ],
+    optional_params=[],
+    response_model=CryptoQuote,
+)
+
+CRYPTO_HISTORICAL = Endpoint(
+    name="crypto_historical",
+    path="historical-price-full/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get cryptocurrency historical prices",
+    mandatory_params=[
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Crypto pair symbol",
+        )
+    ],
+    optional_params=[
+        EndpointParam(
+            name="from",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="Start date",
+        ),
+        EndpointParam(
+            name="to",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="End date",
+        ),
+    ],
+    response_model=CryptoHistoricalData,
+)
+
+CRYPTO_INTRADAY = Endpoint(
+    name="crypto_intraday",
+    path="historical-chart/{interval}/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get cryptocurrency intraday prices",
+    mandatory_params=[
+        EndpointParam(
+            name="interval",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Time interval",
+            valid_values=["1min", "5min", "15min", "30min", "1hour", "4hour"],
+        ),
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Crypto pair symbol",
+        ),
+    ],
+    optional_params=[],
+    response_model=CryptoIntradayPrice,
+)
+
+FOREX_LIST = Endpoint(
+    name="forex_list",
+    path="symbol/available-forex-currency-pairs",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get list of available forex pairs",
+    mandatory_params=[],
+    optional_params=[],
+    response_model=ForexPair,
+)
+
+FOREX_QUOTES = Endpoint(
+    name="forex_quotes",
+    path="quotes/forex",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get forex quotes",
+    mandatory_params=[],
+    optional_params=[],
+    response_model=ForexQuote,
+)
+
+FOREX_QUOTE = Endpoint(
+    name="forex_quote",
+    path="quote/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get forex quote",
+    mandatory_params=[
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Forex pair symbol",
+        )
+    ],
+    optional_params=[],
+    response_model=ForexQuote,
+)
+
+FOREX_HISTORICAL = Endpoint(
+    name="forex_historical",
+    path="historical-price-full/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get forex historical prices",
+    mandatory_params=[
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Forex pair symbol",
+        )
+    ],
+    optional_params=[
+        EndpointParam(
+            name="from",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="Start date",
+        ),
+        EndpointParam(
+            name="to",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="End date",
+        ),
+    ],
+    response_model=ForexPriceHistory,
+)
+
+FOREX_INTRADAY = Endpoint(
+    name="forex_intraday",
+    path="historical-chart/{interval}/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get forex intraday prices",
+    mandatory_params=[
+        EndpointParam(
+            name="interval",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Time interval",
+            valid_values=["1min", "5min", "15min", "30min", "1hour", "4hour"],
+        ),
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Forex pair symbol",
+        ),
+    ],
+    optional_params=[],
+    response_model=ForexIntradayPrice,
+)
+
+COMMODITIES_LIST = Endpoint(
+    name="commodities_list",
+    path="symbol/available-commodities",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get list of available commodities",
+    mandatory_params=[],
+    optional_params=[],
+    response_model=Commodity,
+)
+
+COMMODITIES_QUOTES = Endpoint(
+    name="commodities_quotes",
+    path="quotes/commodity",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get commodities quotes",
+    mandatory_params=[],
+    optional_params=[],
+    response_model=CommodityQuote,
+)
+
+COMMODITY_QUOTE = Endpoint(
+    name="commodity_quote",
+    path="quote/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get commodity quote",
+    mandatory_params=[
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Commodity symbol",
+        )
+    ],
+    optional_params=[],
+    response_model=CommodityQuote,
+)
+
+COMMODITY_HISTORICAL = Endpoint(
+    name="commodity_historical",
+    path="historical-price-full/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get commodity historical prices",
+    mandatory_params=[
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Commodity symbol",
+        )
+    ],
+    optional_params=[
+        EndpointParam(
+            name="from",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="Start date",
+        ),
+        EndpointParam(
+            name="to",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="End date",
+        ),
+    ],
+    response_model=CommodityPriceHistory,
+)
+
+COMMODITY_INTRADAY = Endpoint(
+    name="commodity_intraday",
+    path="historical-chart/{interval}/{symbol}",
+    version=APIVersion.V3,
+    url_type=URLType.API,
+    method=HTTPMethod.GET,
+    description="Get commodity intraday prices",
+    mandatory_params=[
+        EndpointParam(
+            name="interval",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Time interval",
+            valid_values=["1min", "5min", "15min", "30min", "1hour", "4hour"],
+        ),
+        EndpointParam(
+            name="symbol",
+            location=ParamLocation.PATH,
+            param_type=ParamType.STRING,
+            required=True,
+            description="Commodity symbol",
+        ),
+    ],
+    optional_params=[
+        EndpointParam(
+            name="from",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="Start date",
+        ),
+        EndpointParam(
+            name="to",
+            location=ParamLocation.QUERY,
+            param_type=ParamType.DATE,
+            required=False,
+            description="End date",
+        ),
+    ],
+    response_model=CommodityIntradayPrice,
+)