Crate alpaca_websocket 

Alpaca WebSocket Client

WebSocket client for Alpaca trading platform real-time data. This crate provides real-time market data and trading updates via WebSocket connections.

Re-exports

pub use client::AlpacaWebSocketClient;

pub use client::DataFeed;

pub use config::ConnectionState;

pub use config::StreamType;

pub use config::WebSocketConfig;

pub use error::WebSocketError;

pub use messages::*;

pub use streams::*;

Modules

auth

Authentication types and utilities.

client

WebSocket client for Alpaca streaming data.

config

WebSocket configuration types.

error

WebSocket-specific error types.

messages

WebSocket message types for Alpaca streaming.

streams

Stream types for WebSocket data.

types

Core API types and data structures. Core types for the Alpaca API.

utils

Utility functions and helpers. Utility functions and helpers for the Alpaca API.

Structs

Account

Account information from Alpaca API.

AccountActivity

Account activity

AccountDocument

Account document/statement.

AccountStatusEvent

Account status event from SSE stream.

AchRelationship

ACH relationship.

Agreement

Agreement for broker account.

ApiErrorResponse

Detailed API error response from Alpaca.

Asset

Asset information.

Auction

Auction data.

Bar

Market data bar

BatchJournalEntry

Batch journal entry.

BorrowRate

Borrow rate information for short selling.

BrokerAccount

Broker account.

BrokerCryptoWallet

Broker crypto wallet for Broker API.

BrokerTradeEvent

Trade event from SSE stream.

BuyingPowerCalculator

Buying power calculation helper.

Calendar

Calendar information

CalendarDay

Enhanced calendar day information.

CalendarParams

Calendar query parameters.

CipInfo

CIP (Customer Identification Program) info.

Clock

Clock information

ClosePositionParams

Close position request.

Contact

Contact information for broker account.

CorporateAction

Corporate action announcement.

CorporateActionAnnouncement

Corporate action announcement.

CorporateActionsParams

Parameters for corporate actions request.

CreateAchRelationshipRequest

Request to create an ACH relationship.

CreateBatchJournalRequest

Request to create batch journal entries.

CreateBrokerAccountRequest

Request to create a broker account.

CreateCryptoTransferRequest

Request to create a crypto transfer.

CreateCryptoWalletRequest

Request to create a crypto wallet.

CreateCryptoWhitelistRequest

Request to add a whitelisted address.

CreateIraContributionRequest

IRA contribution request.

CreateIraDistributionRequest

IRA distribution request.

CreateJournalRequest

Request to create a journal entry.

CreateTransferRequest

Request to create a transfer.

CreateWireBankRequest

Request to create a wire bank.

Credentials

Authentication credentials for Alpaca API.

CryptoBar

Crypto bar data.

CryptoBarsParams

Parameters for crypto bars request.

CryptoOrderbook

Crypto orderbook.

CryptoOrderbookEntry

Crypto orderbook entry.

CryptoQuote

Crypto quote data.

CryptoSnapshot

Crypto snapshot with current price data.

CryptoTrade

Crypto trade data.

CryptoTransfer

Crypto transfer.

CryptoWallet

Crypto wallet

CryptoWhitelistAddress

Whitelisted crypto address.

CurrencyPair

Currency pair for exchange rate queries.

Disclosures

Disclosures for broker account.

Document

Document for broker account.

DocumentParams

Document query parameters.

EnhancedAsset

Enhanced asset with all fields.

EnhancedNewsArticle

Enhanced news article with images and additional fields.

EnvironmentGuard

Environment safety guard.

ExchangeRate

Exchange rate between two currencies.

FixSequenceNumbers

FIX sequence numbers.

FixSessionConfig

FIX session configuration.

FractionalQty

Fractional quantity with precision.

FractionalValidator

Fractional trading validation.

Identity

Identity information for broker account.

IraBeneficiary

IRA beneficiary.

IraContribution

IRA contribution.

IraDistribution

IRA distribution.

Journal

Journal entry.

JournalStatusEvent

Journal status event from SSE stream.

LctPosition

Local currency position values.

ListActivitiesParams

Parameters for listing account activities.

ListAnnouncementsParams

Parameters for listing corporate action announcements.

ListAssetsParams

Parameters for listing assets.

ListBrokerAccountsParams

Parameters for listing broker accounts.

ListJournalsParams

Parameters for listing journals.

ListTransfersParams

Parameters for listing transfers.

LocateRequest

Locate request for short selling.

LocateResponse

Locate response for short selling.

Luld

Limit Up Limit Down (LULD) data.

MarginInfo

Margin information for an account.

MarginRequirement

Margin requirement for a position.

MarketClock

Enhanced market clock information.

MultiBarsParams

Parameters for multi-symbol bars request.

MultiQuotesParams

Parameters for multi-symbol quotes request.

MultiTradesParams

Parameters for multi-symbol trades request.

NewsArticle

News article

NewsImage

News image.

NewsParams

Parameters for news request.

NewsSource

News source.

NonTradeActivity

Non-trade activity with detailed fields.

NonTradeActivityEvent

Non-trade activity event from SSE stream.

NotionalAmount

Notional order amount (dollar-based).

OAuthConfig

OAuth 2.0 configuration.

OAuthRevokeRequest

Request to revoke a token.

OAuthToken

OAuth token for API access.

OAuthTokenRequest

Request to exchange authorization code for token.

OptionBar

Option bar (OHLCV) data.

OptionBarsParams

Parameters for querying option bars.

OptionChainEntry

Options chain entry for a specific strike/expiration.

OptionContract

Option contract information.

OptionContractAsset

Option contract asset.

OptionContractParams

Parameters for querying option contracts.

OptionExerciseRequest

Request to exercise an option.

OptionGreeks

Option Greeks for pricing and risk analysis.

OptionQuote

Option quote data.

OptionSnapshot

Option snapshot with latest quote, trade, and greeks.

OptionTrade

Option trade data.

OptionsApproval

Options approval status response.

OptionsApprovalRequest

Options approval request for an account.

Order

Order information.

PaginatedResponse

Response wrapper with pagination information

Pagination

Pagination parameters for API requests

PaperTradingConfig

Paper trading configuration.

PortfolioHistory

Portfolio history

PortfolioHistoryParams

Parameters for portfolio history.

Position

Position information

Quote

Market data quote

RateLimitConfig

Rate limit configuration.

RateLimitInfo

Rate limit information from API response headers.

RateLimitStatus

Rate limit information from response headers.

RateLimiter

Rate limiter for API requests

RebalancePortfolio

Rebalance portfolio.

RebalancePortfolioRequest

Rebalance portfolio request.

RebalanceRun

Rebalance run result.

RebalanceRunRequest

Rebalance run request.

ResetAccountRequest

Paper trading account reset request.

RetryConfig

Retry configuration for API requests

ShortPosition

Short position information.

SseEventParams

Parameters for SSE event stream.

StockSnapshot

Stock snapshot with latest market data.

StopLoss

Stop loss configuration for bracket orders.

TakeProfit

Take profit configuration for bracket orders.

TargetAllocation

Target allocation for rebalancing.

TaxDocument

Tax document.

Trade

Market data trade

TradeActivity

Trade activity with detailed fields.

TradeConfirmation

Trade confirmation document.

TradingDay

Trading day utilities.

TradingStatus

Trading status update.

Transfer

Transfer.

TransferStatusEvent

Transfer status event from SSE stream.

TrustedContact

Trusted contact for broker account.

UpdateBrokerAccountRequest

Request to update a broker account.

UrlBuilder

URL builder helper

ValidationError

Validation error for a specific field.

Watchlist

Watchlist information

WireBank

Wire bank details.

Enums

AccountStatus

Account status.

AccountStatusEventType

Account status event type.

AchRelationshipStatus

ACH relationship status.

ActivityType

Activity type

AgreementType

Agreement type for broker accounts.

AlpacaError

Error types for the Alpaca API client.

ApiErrorCode

Alpaca-specific API error codes.

AssetAttribute

Asset attribute.

AssetClass

Asset class.

AssetExchange

Asset exchange.

AssetStatus

Asset status.

BankAccountType

Bank account type.

BrokerAccountStatus

Broker account status.

BrokerSseEvent

SSE event wrapper for all broker events.

CorporateActionType

Corporate action type.

CryptoChain

Crypto blockchain chain.

CryptoTransferDirection

Crypto transfer direction.

CryptoTransferStatus

Crypto transfer status.

CryptoWalletStatus

Crypto wallet status.

Currency

Supported currencies for Local Currency Trading.

DocumentType

Document type for KYC.

Environment

Trading environment for Alpaca API.

FixMsgType

FIX message type.

FixSessionState

FIX session state.

FixVersion

FIX protocol version.

FractionalOrderRestriction

Fractional order type restrictions.

FundingSource

Funding source for broker accounts.

IraAccountType

IRA account type.

JournalEntryType

Journal entry type.

JournalStatus

Journal status.

JournalStatusEventType

Journal status event type.

MarketSession

Market session type.

NewsContentType

News content type.

NewsImageSize

News image size.

NonTradeActivityType

Non-trade activity event type.

OAuthScope

OAuth 2.0 scope.

OptionStyle

Option style (American or European).

OptionType

Option type (call or put).

OptionsApprovalLevel

Options trading approval level.

OptionsApprovalStatus

Options approval status.

OrderClass

Order class.

OrderQueryStatus

Order query status filter.

OrderSide

Order side.

OrderStatus

Order status

OrderType

Order type.

PdtStatus

Pattern day trader status.

PortfolioPeriod

Portfolio history period.

PortfolioTimeframe

Portfolio history timeframe.

PositionIntent

Position intent for options orders.

PositionSide

Position side

RebalanceStatus

Rebalance status.

RequestPriority

Request priority for queue management.

SortDirection

Sort direction for order queries.

StatementType

Statement document type.

TaxFormType

Tax form type.

TaxIdType

Tax ID type.

TimeInForce

Time in force for orders.

Timeframe

Timeframe for market data

TradingEnvironment

Trading environment.

TransferDirection

Transfer direction.

TransferStatus

Transfer status.

TransferStatusEventType

Transfer status event type.

TransferType

Transfer type.

Functions

format_decimal

Format decimal value to string with specified precision

generate_client_order_id

Generate a random client order ID

init_logger

Logger configuration

parse_decimal

Parse a string to a decimal value with validation

parse_rfc3339

Parse RFC3339 timestamp

timestamp_to_rfc3339

Convert timestamp to RFC3339 format

validate_price

Validate price value

validate_quantity

Validate quantity value

validate_symbol

Validate symbol format

Type Aliases

Result

Result type for Alpaca API operations.