primary-api-models 0.1.0__tar.gz → 0.2.0__tar.gz

primary_api_models-0.2.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: primary-api-models
+Version: 0.2.0
+Summary: Primary API models
+Author-email: Chi Tudi <chitudi54@gmail.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Primary API Models
+Models for Primary API (REST / WS) messages
+
+API Documentation: https://apihub.primary.com.ar/
+
+Special use case with `pyRofex` (https://github.com/matbarofex/pyRofex)
+
+
+## Installation
+
+`pip install primary-api-models`
+
+
+## Usage
+
+- Segments
+```python
+import pyRofex
+from primary_api_models import SegmentsResponse
+
+pyRofex.initialize(...)
+
+# Get all segments
+response = pyRofex.get_segments()
+data = SegmentsResponse.model_validate_json(response)
+print(data.segments)
+```
+
+
+- All Instruments
+```python
+import pyRofex
+from primary_api_models import AllInstrumentsResponse
+
+pyRofex.initialize(...)
+
+# Get available instrument list
+response = pyRofex.get_all_instruments()
+data = AllInstrumentsResponse.model_validate_json(response)
+print(data.instruments)
+```
+
+
+- Instruments by Segments/Cficode
+```python
+import pyRofex
+from primary_api_models import InstrumentsByResponse
+
+pyRofex.initialize(...)
+
+# Get instrument list by given cfi code or segment:
+response = pyRofex.get_instruments('by_cfi', ...)
+response = pyRofex.get_instruments('by_segments', ...)
+data = InstrumentsByResponse.model_validate_json(response)
+print(data.instruments)
+```
+
+
+- Detailed Instruments List
+```python
+import pyRofex
+from primary_api_models import DetailedInstrumentsResponse
+
+pyRofex.initialize(...)
+
+# Get detailed instrument list
+response = pyRofex.get_detailed_instruments()
+data = DetailedInstrumentsResponse.model_validate_json(response)
+print(data.instruments)
+```
+
+
+- Instrument Details
+```python
+import pyRofex
+from primary_api_models import InstrumentDetailsResponse
+
+pyRofex.initialize(...)
+
+# Get instrument details
+response = pyRofex.get_instrument_details(ticker="MERV - XMEV - AAPL - 24hs")
+data = InstrumentDetailsResponse.model_validate_json(response)
+print(data.instrument)
+```
+
+
+- Order Status
+```python
+import pyRofex
+from primary_api_models import OrderStatusResponse
+
+pyRofex.initialize(...)
+
+# Get all order reports for the configured account
+response = pyRofex.get_all_orders_status()
+data = OrderStatusResponse.model_validate_json(response)
+print(data.orders)
+
+# Get order status
+response = pyRofex.get_order_status(...)
+data = OrderStatusResponse.model_validate_json(response)
+print(data.order)
+```
+
+
+- Market Data
+```python
+import pyRofex
+from primary_api_models import StatusResponse
+from primary_api_models import MarketDataResponse, MarketData
+
+pyRofex.initialize(...)
+
+# Makes a request to the Rest API and get bids, offers and last price
+# Use the MarketDataEntry enum to specify the data
+entries = [pyRofex.MarketDataEntry.BIDS,
+           pyRofex.MarketDataEntry.OFFERS,
+           pyRofex.MarketDataEntry.LAST]
+
+response = pyRofex.get_market_data(ticker="MERV - XMEV - AAPL - 24hs", entries=entries)
+data = MarketDataResponse.model_validate_json(response)
+
+if data.status == StatusResponse.OK:
+    md = data.marketData
+    bids = md.BI
+    asks = md.OF
+    last_trade = md.LA
+    print(last_trade)
+```
+
+
+- Account Report
+```python
+import pyRofex
+from primary_api_models import AccountReportResponse
+
+pyRofex.initialize(...)
+
+# Get account report
+response = pyRofex.get_account_report(...)
+data = AccountReportResponse.model_validate_json(response)
+print(data.accountData)
+```
+
+
+- Account Positions
+```python
+import pyRofex
+from primary_api_models import PositionsResponse
+
+pyRofex.initialize(...)
+
+# Get all positions for an account
+response = pyRofex.get_account_report(...)
+data = PositionsResponse.model_validate_json(response)
+print(data.positions)
+```
+
+
+- Detailed Positions
+```python
+import pyRofex
+from primary_api_models import DetailedPositionsResponse
+
+pyRofex.initialize(...)
+
+# Get detailed positions for an account
+response = pyRofex.get_detailed_position(...)
+data = DetailedPositionsResponse.model_validate_json(response)
+print(data.detailedPosition)
+```
+
+
+## Model list
+```jsonc
+[
+    // Enums
+    "StatusResponse",
+    "MessageType",
+    "MarketId",
+    "Side",
+    "OrderType",
+    "OrderStatus",
+    "TimeInForce",
+    "Currency",
+    "CurrencyIndex",
+    "SettlementIndex",
+    "MarketDataEntry",
+    "CFICode",
+    "MarketSegment",
+    "ContractType",
+    // Models
+    "AccountReportResponse",
+    "AccountData",
+    "CommonResponse",
+    "PriceSize",
+    "PriceSizeDate",
+    "InstrumentId",
+    "Instrument",
+    "DetailedInstrumentsResponse",
+    "DetailedPositionsResponse",
+    "DetailedPositionData",
+    "DetailedPosition",
+    "EnhancedOrderReport",
+    "InstrumentDetailsResponse",
+    "InstrumentDetails",
+    "AllInstrumentsResponse",
+    "InstrumentsByResponse",
+    "MarketDataResponse",
+    "MarketDataMessage",
+    "MarketData",
+    "OrderReportMessage",
+    "OrderReport",
+    "OrderStatusResponse",
+    "OrderConfirmationResponse",
+    "PositionsResponse",
+    "Position",
+    "SegmentsResponse"
+]
+```

primary_api_models-0.2.0/README.md

@@ -0,0 +1,220 @@
+# Primary API Models
+Models for Primary API (REST / WS) messages
+
+API Documentation: https://apihub.primary.com.ar/
+
+Special use case with `pyRofex` (https://github.com/matbarofex/pyRofex)
+
+
+## Installation
+
+`pip install primary-api-models`
+
+
+## Usage
+
+- Segments
+```python
+import pyRofex
+from primary_api_models import SegmentsResponse
+
+pyRofex.initialize(...)
+
+# Get all segments
+response = pyRofex.get_segments()
+data = SegmentsResponse.model_validate_json(response)
+print(data.segments)
+```
+
+
+- All Instruments
+```python
+import pyRofex
+from primary_api_models import AllInstrumentsResponse
+
+pyRofex.initialize(...)
+
+# Get available instrument list
+response = pyRofex.get_all_instruments()
+data = AllInstrumentsResponse.model_validate_json(response)
+print(data.instruments)
+```
+
+
+- Instruments by Segments/Cficode
+```python
+import pyRofex
+from primary_api_models import InstrumentsByResponse
+
+pyRofex.initialize(...)
+
+# Get instrument list by given cfi code or segment:
+response = pyRofex.get_instruments('by_cfi', ...)
+response = pyRofex.get_instruments('by_segments', ...)
+data = InstrumentsByResponse.model_validate_json(response)
+print(data.instruments)
+```
+
+
+- Detailed Instruments List
+```python
+import pyRofex
+from primary_api_models import DetailedInstrumentsResponse
+
+pyRofex.initialize(...)
+
+# Get detailed instrument list
+response = pyRofex.get_detailed_instruments()
+data = DetailedInstrumentsResponse.model_validate_json(response)
+print(data.instruments)
+```
+
+
+- Instrument Details
+```python
+import pyRofex
+from primary_api_models import InstrumentDetailsResponse
+
+pyRofex.initialize(...)
+
+# Get instrument details
+response = pyRofex.get_instrument_details(ticker="MERV - XMEV - AAPL - 24hs")
+data = InstrumentDetailsResponse.model_validate_json(response)
+print(data.instrument)
+```
+
+
+- Order Status
+```python
+import pyRofex
+from primary_api_models import OrderStatusResponse
+
+pyRofex.initialize(...)
+
+# Get all order reports for the configured account
+response = pyRofex.get_all_orders_status()
+data = OrderStatusResponse.model_validate_json(response)
+print(data.orders)
+
+# Get order status
+response = pyRofex.get_order_status(...)
+data = OrderStatusResponse.model_validate_json(response)
+print(data.order)
+```
+
+
+- Market Data
+```python
+import pyRofex
+from primary_api_models import StatusResponse
+from primary_api_models import MarketDataResponse, MarketData
+
+pyRofex.initialize(...)
+
+# Makes a request to the Rest API and get bids, offers and last price
+# Use the MarketDataEntry enum to specify the data
+entries = [pyRofex.MarketDataEntry.BIDS,
+           pyRofex.MarketDataEntry.OFFERS,
+           pyRofex.MarketDataEntry.LAST]
+
+response = pyRofex.get_market_data(ticker="MERV - XMEV - AAPL - 24hs", entries=entries)
+data = MarketDataResponse.model_validate_json(response)
+
+if data.status == StatusResponse.OK:
+    md = data.marketData
+    bids = md.BI
+    asks = md.OF
+    last_trade = md.LA
+    print(last_trade)
+```
+
+
+- Account Report
+```python
+import pyRofex
+from primary_api_models import AccountReportResponse
+
+pyRofex.initialize(...)
+
+# Get account report
+response = pyRofex.get_account_report(...)
+data = AccountReportResponse.model_validate_json(response)
+print(data.accountData)
+```
+
+
+- Account Positions
+```python
+import pyRofex
+from primary_api_models import PositionsResponse
+
+pyRofex.initialize(...)
+
+# Get all positions for an account
+response = pyRofex.get_account_report(...)
+data = PositionsResponse.model_validate_json(response)
+print(data.positions)
+```
+
+
+- Detailed Positions
+```python
+import pyRofex
+from primary_api_models import DetailedPositionsResponse
+
+pyRofex.initialize(...)
+
+# Get detailed positions for an account
+response = pyRofex.get_detailed_position(...)
+data = DetailedPositionsResponse.model_validate_json(response)
+print(data.detailedPosition)
+```
+
+
+## Model list
+```jsonc
+[
+    // Enums
+    "StatusResponse",
+    "MessageType",
+    "MarketId",
+    "Side",
+    "OrderType",
+    "OrderStatus",
+    "TimeInForce",
+    "Currency",
+    "CurrencyIndex",
+    "SettlementIndex",
+    "MarketDataEntry",
+    "CFICode",
+    "MarketSegment",
+    "ContractType",
+    // Models
+    "AccountReportResponse",
+    "AccountData",
+    "CommonResponse",
+    "PriceSize",
+    "PriceSizeDate",
+    "InstrumentId",
+    "Instrument",
+    "DetailedInstrumentsResponse",
+    "DetailedPositionsResponse",
+    "DetailedPositionData",
+    "DetailedPosition",
+    "EnhancedOrderReport",
+    "InstrumentDetailsResponse",
+    "InstrumentDetails",
+    "AllInstrumentsResponse",
+    "InstrumentsByResponse",
+    "MarketDataResponse",
+    "MarketDataMessage",
+    "MarketData",
+    "OrderReportMessage",
+    "OrderReport",
+    "OrderStatusResponse",
+    "OrderConfirmationResponse",
+    "PositionsResponse",
+    "Position",
+    "SegmentsResponse"
+]
+```

{primary_api_models-0.1.0 → primary_api_models-0.2.0}/primary_api_models/__init__.py

@@ -1,30 +1,21 @@
 # Export all modules from the current directory
-from primary_api_models.account_data import AccountDataResponse, AccountData
-from primary_api_models.commons import PriceSize, PriceSizeDate, InstrumentId, Instrument
+from primary_api_models.enums import StatusResponse, MessageType, MarketId, Side, OrderType, OrderStatus, TimeInForce, Currency, CurrencyIndex, SettlementIndex, MarketDataEntry, CFICode, MarketSegment, ContractType
+from primary_api_models.account_report import AccountReportResponse, AccountData
+from primary_api_models.commons import CommonResponse, PriceSize, PriceSizeDate, InstrumentId, Instrument
 from primary_api_models.detailed_instruments import DetailedInstrumentsResponse
 from primary_api_models.detailed_position import DetailedPositionsResponse, DetailedPositionData, DetailedPosition
 from primary_api_models.enhanced_models import EnhancedOrderReport
-from primary_api_models.enums import StatusResponse, MessageType, MarketId, Side, OrderType, OrderStatus, TimeInForce, Currency, CurrencyIndex, SettlementIndex, MarketDataEntry, CFICode, MarketSegment, ContractType
 from primary_api_models.instrument_details import InstrumentDetailsResponse, InstrumentDetails
-from primary_api_models.listed_instruments import ListedInstrumentsResponse, ListedInstrument
-from primary_api_models.market_data import MarketDataMessage, MarketData
+from primary_api_models.instruments import AllInstrumentsResponse, InstrumentsByResponse
+from primary_api_models.market_data import MarketDataResponse, MarketDataMessage, MarketData
 from primary_api_models.order_report import OrderReportMessage, OrderReport
-from primary_api_models.order_status import OrderStatusResponse
+from primary_api_models.order_status import OrderConfirmationResponse, OrderStatusResponse
 from primary_api_models.positions import PositionsResponse, Position
+from primary_api_models.segments import SegmentsResponse
 
 
 __all__ = [
-    "AccountDataResponse",
-    "AccountData",
-    "PriceSize",
-    "PriceSizeDate",
-    "InstrumentId",
-    "Instrument",
-    "DetailedInstrumentsResponse",
-    "DetailedPositionsResponse",
-    "DetailedPositionData",
-    "DetailedPosition",
-    "EnhancedOrderReport",
+    # Enums
     "StatusResponse",
     "MessageType",
     "MarketId",
@@ -39,15 +30,31 @@ __all__ = [
     "CFICode",
     "MarketSegment",
     "ContractType",
+    # Models
+    "AccountReportResponse",
+    "AccountData",
+    "CommonResponse",
+    "PriceSize",
+    "PriceSizeDate",
+    "InstrumentId",
+    "Instrument",
+    "DetailedInstrumentsResponse",
+    "DetailedPositionsResponse",
+    "DetailedPositionData",
+    "DetailedPosition",
+    "EnhancedOrderReport",
     "InstrumentDetailsResponse",
     "InstrumentDetails",
-    "ListedInstrumentsResponse",
-    "ListedInstrument",
+    "AllInstrumentsResponse",
+    "InstrumentsByResponse",
+    "MarketDataResponse",
     "MarketDataMessage",
     "MarketData",
     "OrderReportMessage",
     "OrderReport",
     "OrderStatusResponse",
+    "OrderConfirmationResponse",
     "PositionsResponse",
-    "Position"
+    "Position",
+    "SegmentsResponse"
 ]

primary_api_models-0.1.0/primary_api_models/account_data.py → primary_api_models-0.2.0/primary_api_models/account_report.py

@@ -1,7 +1,8 @@
 from typing import Dict, Optional
 from pydantic import BaseModel
 from decimal import Decimal
-from primary_api_models.enums import CurrencyIndex, SettlementIndex, StatusResponse
+from primary_api_models.commons import CommonResponse
+from primary_api_models.enums import CurrencyIndex, SettlementIndex
 
 
 class CurrencyAmount(BaseModel):
@@ -55,8 +56,5 @@ class AccountData(BaseModel):
     personName: Optional[dict] = None # No se conoce bien la estructura
 
 
-class AccountDataResponse(BaseModel):
-    status: StatusResponse
-    description: Optional[str] = None
-    message: Optional[str] = None
+class AccountReportResponse(CommonResponse):
     accountData: Optional[AccountData] = None

{primary_api_models-0.1.0 → primary_api_models-0.2.0}/primary_api_models/commons.py

@@ -1,12 +1,12 @@
 from pydantic import BaseModel
 from typing import Optional
 from decimal import Decimal
-from primary_api_models.enums import MessageType, MarketId, MarketSegment, StatusResponse, SettlementIndex
+from primary_api_models.enums import CFICode, MessageType, MarketId, MarketSegment, StatusResponse, SettlementIndex
 
 
 class MessageBase(BaseModel):
     type: MessageType
-    timestamp: int
+    timestamp: Optional[int] = None
 
 
 class CommonResponse(BaseModel):
@@ -34,6 +34,11 @@ class InstrumentId(BaseModel):
     symbol: str
 
 
+class ListedInstrument(BaseModel):
+    instrumentId: InstrumentId
+    cficode: CFICode
+    
+    
 class PriceSize(BaseModel):
     price: Decimal
     size: Decimal
@@ -46,4 +51,9 @@ class PriceSizeDate(BaseModel):
 
 
 class Trade(PriceSizeDate):
-    ...
+    ...
+
+
+class OrderConfirmation(BaseModel):
+    clientId: Optional[str] = None
+    proprietary: Optional[str] = None

primary_api_models-0.2.0/primary_api_models/detailed_instruments.py

@@ -0,0 +1,9 @@
+from typing import Optional, List
+from pydantic import BaseModel
+from primary_api_models.commons import CommonResponse
+from primary_api_models.enums import StatusResponse
+from primary_api_models.instrument_details import InstrumentDetails
+
+
+class DetailedInstrumentsResponse(CommonResponse):
+    instruments: Optional[List[InstrumentDetails]] = None

{primary_api_models-0.1.0 → primary_api_models-0.2.0}/primary_api_models/detailed_position.py

@@ -1,9 +1,11 @@
 from typing import List, Dict, Optional
 from pydantic import BaseModel
 from decimal import Decimal
+from primary_api_models.commons import CommonResponse
 from primary_api_models.enums import ContractType
 from primary_api_models.enums import SettlementIndex
-from primary_api_models.enums import CurrencyIndex, StatusResponse
+from primary_api_models.enums import CurrencyIndex
+
 
 class DetailedPosition(BaseModel):
     symbolReference: str
@@ -32,6 +34,7 @@ class DetailedPosition(BaseModel):
     settlType: Optional[SettlementIndex] = None
     settlementDate: Optional[int] = None
 
+
 class InstrumentGroup(BaseModel):
     detailedPositions: List[DetailedPosition]
     instrumentInitialSize: Decimal
@@ -39,6 +42,7 @@ class InstrumentGroup(BaseModel):
     instrumentCurrentSize: Decimal
     instrumentMarketValue: Optional[Decimal] = None
 
+
 class DetailedPositionData(BaseModel):
     account: str
     lastCalculation: int
@@ -46,8 +50,6 @@ class DetailedPositionData(BaseModel):
     totalDailyDiffPlain: Optional[Decimal] = None
     report: Optional[Dict[ContractType, Dict[str, InstrumentGroup]]] = None
 
-class DetailedPositionsResponse(BaseModel):
-    status: StatusResponse
-    description: Optional[str] = None
-    message: Optional[str] = None
+
+class DetailedPositionsResponse(CommonResponse):
     detailedPosition: Optional[DetailedPositionData] = None