alpaca-py-nopandas 0.1.0__py3-none-any.whl

alpaca/broker/models/documents.py

@@ -0,0 +1,159 @@
+from datetime import date as datetime_date
+from datetime import datetime
+from ipaddress import IPv4Address, IPv6Address
+from typing import Any, Optional, Union
+from uuid import UUID
+
+from pydantic import model_validator
+
+from alpaca.broker.enums import DocumentType, TradeDocumentSubType, TradeDocumentType
+from alpaca.common.models import ModelWithID
+from alpaca.common.models import ValidateBaseModel as BaseModel
+
+IPAddress = Union[IPv4Address, IPv6Address]
+
+
+class AccountDocument(BaseModel):
+    """
+    User documents provided within Account Model.
+
+    This model is different from the TradeDocument model in that this model represents documents having to do with a
+    brokerage Account.
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    Attributes:
+        id (UUID): ID of the Document
+        document_type (DocumentType): The type of document uploaded
+        document_sub_type (Optional[str]): The specific type of document, e.g. passport
+        name (Optional(str)): Name of the document if present
+        content (str): Base64 string representing the document
+        mime_type (str): The format of content encoded by the string
+    """
+
+    id: Optional[UUID]
+    document_type: Optional[DocumentType]
+    document_sub_type: Optional[str] = None
+    content: Optional[str] = None
+    mime_type: Optional[str] = None
+
+    def __init__(self, **data: Any) -> None:
+        # validate the incoming id field for uuid
+        _id = data.get("id", None)
+        if isinstance(_id, str):
+            data["id"] = UUID(_id)
+
+        super().__init__(**data)
+
+
+class TradeDocument(ModelWithID):
+    """
+    Similar to the AccountDocument model but this represents documents having to do with a TradeAccount not a regular
+    Account.
+
+    IE:  Account Monthly Statements or Trade Confirmations.
+
+    Attributes:
+        id (UUID): Unique id of the TradeDocument
+        name (str): Name of the document
+        type (TradeDocumentType): The kind of TradeDocument this is
+        sub_type (Optional[TradeDocumentSubType]): The subtype of the document. The API returns "" in the case of this
+          not being specified, however we transform this case into None for convenience.
+        date (date): Date on when this TradeDocument was generated
+    """
+
+    name: str
+    type: TradeDocumentType
+    sub_type: Optional[TradeDocumentSubType] = None
+    date: datetime_date
+
+    def __init__(self, **data: Any) -> None:
+        if "id" in data and isinstance(data["id"], str):
+            data["id"] = UUID(data["id"])
+
+        if "sub_type" in data and data["sub_type"] == "":
+            data["sub_type"] = None
+
+        super().__init__(**data)
+
+
+class W8BenDocument(BaseModel):
+    """
+    Represents the information normally contained in a W8BEN document as fields for convenience if you don't
+    want to upload a file.
+
+    Please see https://docs.alpaca.markets/docs/international-accounts
+    for more information.
+
+    TODO: None of the docs or code explain what any of these fields mean. Guessing based on name alone for
+      all of them; but we really need the docs updated.
+
+    Attributes:
+        additional_conditions (Optional[str]): Any additional conditions to specify
+        country_citizen (str): The Country that the applicant is a citizen of
+        date (date): date signed
+        date_of_birth (date): DOB of applicant
+        foreign_tax_id (Optional[str]): Applicant's tax id in their home country
+        ftin_not_required (Optional[bool]): Required if foreign_tax_id and tax_id_ssn are empty.
+        full_name (str): Full name of applicant
+        income_type (Optional[str]): income type of applicant
+        ip_address (IPAddress): ip address of applicant when signed
+        mailing_address_city_state (Optional[str]): mailing city/state of applicant
+        mailing_address_country (Optional[str]): mailing country for applicant
+        mailing_address_street (Optional[str]): mailing street address for applicant
+        paragraph_number (Optional[str]): TODO: get documentation for this field
+        percent_rate_withholding (Optional[str]): TODO: get documentation for this field
+        permanent_address_city_state (str): permanent city/state of applicant
+        permanent_address_country (str): permanent country of residence of applicant
+        permanent_address_street (str): permanent street address of applicant
+        reference_number (Optional[str]): TODO: Get documentation for this field
+        residency (Optional[str]): Country of residency of applicant
+          TODO: get real documentation for this field. current is just guess based on example
+        revision (str): Revision of the W8BEN form
+        signer_full_name (str): Full name of signing user
+        tax_id_ssn (Optional[str]): TaxID/SSN of applicant
+        timestamp (datetime): timestamp when form data was gathered
+    """
+
+    country_citizen: str
+    date: datetime_date
+    date_of_birth: datetime_date
+    full_name: str
+    ip_address: IPAddress
+    permanent_address_city_state: str
+    permanent_address_country: str
+    permanent_address_street: str
+    revision: str
+    signer_full_name: str
+    timestamp: datetime
+
+    # optional fields
+    additional_conditions: Optional[str] = None
+    foreign_tax_id: Optional[str] = None
+    ftin_not_required: Optional[bool] = None
+    income_type: Optional[str] = None
+    mailing_address_city_state: Optional[str] = None
+    mailing_address_country: Optional[str] = None
+    mailing_address_street: Optional[str] = None
+    paragraph_number: Optional[str] = None
+    percent_rate_withholding: Optional[str] = None
+    reference_number: Optional[str] = None
+    residency: Optional[str] = None
+    tax_id_ssn: Optional[str] = None
+
+    @model_validator(mode="before")
+    def root_validator(cls, values: dict) -> dict:
+        foreign_tax_set = (
+            "foreign_tax_id" in values and values["foreign_tax_id"] is not None
+        )
+        tax_id_set = "tax_id_ssn" in values and values["tax_id_ssn"] is not None
+        ftin_set = (
+            "ftin_not_required" in values and values["ftin_not_required"] is not None
+        )
+
+        if not foreign_tax_set and not tax_id_set and not ftin_set:
+            raise ValueError(
+                "ftin_not_required must be set if foreign_tax_id and tax_id_ssn are not"
+            )
+
+        return values

alpaca/broker/models/funding.py

@@ -0,0 +1,114 @@
+from datetime import datetime
+from typing import Optional
+from uuid import UUID
+
+from alpaca.broker.enums import (
+    ACHRelationshipStatus,
+    BankAccountType,
+    BankStatus,
+    IdentifierType,
+    TransferType,
+    TransferStatus,
+    TransferDirection,
+    FeePaymentMethod,
+)
+from alpaca.common.models import ModelWithID
+
+
+class ACHRelationship(ModelWithID):
+    """
+    Attributes:
+        id (UUID): ID of Relationship
+        account_id (UUID): ID of the Account this ACHRelationship is tied to
+        created_at (datetime): Date and time this relationship was created
+        updated_at (datetime): Date and time of when this relationship was last updated
+        status (ACHRelationshipStatus): Current status of the relationship
+        account_owner_name (str): Full name of the account owner
+        bank_account_type (BankAccountType): The kind of bank account this relationship points to
+        bank_account_number (str): The number of bank account that the relationship points to
+        bank_routing_number (str): Routing number for the bank account
+        nickname (str): User provided name for account
+        processor_token (Optional[str]): If you are using Plaid, then this is a Plaid processor token.
+    """
+
+    account_id: UUID
+    created_at: datetime
+    updated_at: datetime
+    status: ACHRelationshipStatus
+    account_owner_name: str
+    bank_account_type: BankAccountType
+    bank_account_number: str
+    bank_routing_number: str
+    nickname: Optional[str] = None
+    processor_token: Optional[str] = None
+
+
+class Bank(ModelWithID):
+    """
+    Attributes:
+        id (UUID): ID of Bank.
+        account_id (UUID): ID of the Account this Bank is tied to.
+        created_at (datetime): Date and time this Bank was created.
+        updated_at (datetime): Date and time of when this Bank was last updated.
+        name (str): Name of the bank.
+        status (BankStatus): The status of the bank connection.
+        country (str): Country where bank account is located.
+        state_province (str): State/Province where bank is located.
+        postal_code (str): Postal code where bank is located.
+        city (str): City where bank is located.
+        street_address (str): Street address where bank is located.
+        account_number (str): The bank account number.
+        bank_code (str): The bank account code.
+        bank_code_type (IdentifierType): The bank identifier.
+    """
+
+    account_id: UUID
+    created_at: datetime
+    updated_at: datetime
+    name: str
+    status: BankStatus
+    country: str
+    state_province: str
+    postal_code: str
+    city: str
+    street_address: str
+    account_number: str
+    bank_code: str
+    bank_code_type: IdentifierType
+
+
+class Transfer(ModelWithID):
+    """
+    Attributes:
+        id (UUID): ID of Transfer.
+        account_id (UUID): ID of the Account this Transfer is tied to.
+        created_at (datetime): Date and time when this Transfer was created.
+        updated_at (datetime): Date and time of when this Transfer was last updated.
+        expires_at (datetime): Date and time of when this Transfer will expire.
+        relationship_id (UUID): ID of the funding relationship used to make the transfer.
+        amount (str): The amount the recipient will receive after any applicable fees are deducted.
+        type (TransferType): The type of transfer.
+        status (TransferStatus): The status of the transfer.
+        direction (TransferDirection): The direction of the transfer.
+        reason (Optional[str]): Reasoning associated with the current status.
+        requested_amount (Optional[str]): Amount entered upon creation of a transfer entity.
+        fee (Optional[str]): Dollar amount of any applicable fees.
+        fee_payment_method (Optional[FeePaymentMethod]): Denotes how any applicable fees will be paid.
+        additional_information (Optional[str]): Additional information provided with wire transfers.
+    """
+
+    account_id: UUID
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+    expires_at: Optional[datetime] = None
+    relationship_id: Optional[UUID] = None
+    bank_id: Optional[UUID] = None
+    amount: str
+    type: TransferType
+    status: TransferStatus
+    direction: TransferDirection
+    reason: Optional[str] = None
+    requested_amount: Optional[str] = None
+    fee: Optional[str] = None
+    fee_payment_method: Optional[FeePaymentMethod] = None
+    additional_information: Optional[str] = None

alpaca/broker/models/journals.py

@@ -0,0 +1,71 @@
+from datetime import date
+from typing import Optional
+from uuid import UUID
+
+from alpaca.broker.enums import JournalEntryType, JournalStatus
+from alpaca.common.models import ModelWithID
+from alpaca.common.enums import SupportedCurrencies
+
+
+class Journal(ModelWithID):
+    """
+    Represents a transfer of cash or securities from one account to another.
+
+    There are two types of journals Cash Journals and Security Journals.
+
+    **Travel Rule**
+    In an effort to fight the criminal financial transactions, FinCEN enacted the
+    Travel Rule that applies to fund transfers of more than $3,000.
+    When you use Journal API to bundle a bulk of transfers for the end-users, you will need to tell about
+    the breakdown and each transmitter information using the optional fields of the POST request.
+
+    Learn more about journals here: https://alpaca.markets/docs/api-references/broker-api/journals/
+
+    Attributes:
+        id (UUID): The journal ID
+        to_account (UUID): The account ID that received the journal.
+        from_account (UUID): The account ID that initiates the journal.
+        entry_type (JournalEntryType): Whether the journal is a cash or security journal.
+        status (JournalStatus): The lifecycle status of the journal.
+        symbol (Optional[str]): For security journals, the symbol identifier of the security being journaled.
+        qty (Optional[float]): For security journals, the quantity of the security being journaled.
+        price (Optional[float]): For security journals, the price at which the security is being journaled at.
+        net_amount (Optional[float]): For cash journals, the total cash amount journaled
+        description (Optional[str]): Journal description. It can include fixtures for sandbox API.
+        settle_date (Optional[date]):
+        system_date (Optional[date]):
+        transmitter_name (Optional[str]): For cash journals, travel rule related name info.
+        transmitter_account_number (Optional[str]): For cash journals, travel rule account number info.
+        transmitter_address (Optional[str]): For cash journals, travel rule related address info.
+        transmitter_financial_institution (Optional[str]): For cash journals, travel rule related institution info.
+        transmitter_timestamp (Optional[str]): For cash journals, travel rule related timestamp info.
+    """
+
+    to_account: UUID
+    from_account: UUID
+    entry_type: JournalEntryType
+    status: JournalStatus
+    net_amount: Optional[float] = None
+    symbol: Optional[str] = None
+    qty: Optional[float] = None
+    price: Optional[float] = None
+    description: Optional[str] = None
+    settle_date: Optional[date] = None
+    system_date: Optional[date] = None
+    transmitter_name: Optional[str] = None
+    transmitter_account_number: Optional[str] = None
+    transmitter_address: Optional[str] = None
+    transmitter_financial_institution: Optional[str] = None
+    transmitter_timestamp: Optional[str] = None
+    currency: Optional[SupportedCurrencies] = None
+
+
+class BatchJournalResponse(Journal):
+    """
+    Represents a journal response from a batch journal request.
+
+    Attributes:
+        error_message (Optional[str]): An message that contains error details for failed journals.
+    """
+
+    error_message: Optional[str] = None

alpaca/broker/models/rebalancing.py

@@ -0,0 +1,80 @@
+from datetime import datetime
+from typing import List, Optional
+from uuid import UUID
+
+from alpaca.broker.enums import PortfolioStatus, RunInitiatedFrom, RunStatus, RunType
+from alpaca.broker.models import Order
+from alpaca.broker.requests import RebalancingConditions, Weight
+from alpaca.common.models import ValidateBaseModel as BaseModel
+
+
+class Portfolio(BaseModel):
+    """
+    Portfolio response model.
+
+    https://docs.alpaca.markets/reference/get-v1-rebalancing-portfolios
+    """
+
+    id: UUID
+    name: str
+    description: str
+    status: PortfolioStatus
+    cooldown_days: int
+    created_at: datetime
+    updated_at: datetime
+    weights: List[Weight]
+    rebalance_conditions: Optional[List[RebalancingConditions]] = None
+
+
+class Subscription(BaseModel):
+    """
+    Subscription response model.
+
+    https://docs.alpaca.markets/reference/get-v1-rebalancing-subscriptions-1
+    """
+
+    id: UUID
+    account_id: UUID
+    portfolio_id: UUID
+    created_at: datetime
+    last_rebalanced_at: Optional[datetime] = None
+
+
+class SkippedOrder(BaseModel):
+    """
+    Skipped order response model.
+
+    https://docs.alpaca.markets/reference/get-v1-rebalancing-runs-run_id-1
+    """
+
+    symbol: str
+    side: Optional[str] = None
+    notional: Optional[str] = None
+    currency: Optional[str] = None
+    reason: str
+    reason_details: str
+
+
+class RebalancingRun(BaseModel):
+    """
+    Rebalancing run response model.
+
+    https://docs.alpaca.markets/reference/get-v1-rebalancing-runs
+    """
+
+    id: UUID
+    account_id: UUID
+    type: RunType
+    amount: Optional[str] = None
+    portfolio_id: UUID
+    weights: List[Weight]
+    initiated_from: Optional[RunInitiatedFrom] = None
+    created_at: datetime
+    updated_at: datetime
+    completed_at: Optional[datetime] = None
+    canceled_at: Optional[datetime] = None
+    status: RunStatus
+    reason: Optional[str] = None
+    orders: Optional[List[Order]] = None
+    failed_orders: Optional[List[Order]] = None
+    skipped_orders: Optional[List[SkippedOrder]] = None

alpaca/broker/models/trading.py

@@ -0,0 +1,13 @@
+from typing import Optional
+from alpaca.trading.models import Order as BaseOrder
+
+
+class Order(BaseOrder):
+    """
+    See base alpaca.trading.models.Order model for full list of base attributes.
+
+    Attributes:
+        commission (float): The dollar value commission you want to charge the end user.
+    """
+
+    commission: Optional[float] = None