@adaptic/utils 0.1.44 → 0.1.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +4558 -59031
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +4554 -58772
- package/dist/index.mjs.map +1 -1
- package/dist/test.js +218 -563
- package/dist/test.js.map +1 -1
- package/dist/types/adaptic.d.ts.map +1 -1
- package/dist/types/alpaca-functions.d.ts +233 -0
- package/dist/types/alpaca-functions.d.ts.map +1 -0
- package/dist/types/alpaca-market-data-api.d.ts +10 -12
- package/dist/types/alpaca-market-data-api.d.ts.map +1 -1
- package/dist/types/alpaca-trading-api.d.ts +2 -2
- package/dist/types/alpaca-trading-api.d.ts.map +1 -1
- package/dist/types/alphavantage.d.ts.map +1 -1
- package/dist/types/asset-allocation-algorithm.d.ts +0 -6
- package/dist/types/asset-allocation-algorithm.d.ts.map +1 -1
- package/dist/types/crypto.d.ts +2 -2
- package/dist/types/crypto.d.ts.map +1 -1
- package/dist/types/examples/asset-allocation-example.d.ts +6 -7
- package/dist/types/examples/asset-allocation-example.d.ts.map +1 -1
- package/dist/types/index.d.ts +37 -373
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/market-hours.d.ts.map +1 -1
- package/dist/types/market-time.d.ts +11 -73
- package/dist/types/market-time.d.ts.map +1 -1
- package/dist/types/metrics-calcs.d.ts.map +1 -1
- package/dist/types/misc-utils.d.ts +0 -3
- package/dist/types/misc-utils.d.ts.map +1 -1
- package/dist/types/performance-metrics.d.ts +5 -5
- package/dist/types/performance-metrics.d.ts.map +1 -1
- package/dist/types/polygon-indices.d.ts +2 -2
- package/dist/types/polygon-indices.d.ts.map +1 -1
- package/dist/types/polygon.d.ts.map +1 -1
- package/dist/types/price-utils.d.ts.map +1 -1
- package/dist/types/technical-analysis.d.ts.map +1 -1
- package/dist/types/trading-policy/defaults.d.ts +46 -0
- package/dist/types/trading-policy/defaults.d.ts.map +1 -0
- package/dist/types/trading-policy/index.d.ts +8 -0
- package/dist/types/trading-policy/index.d.ts.map +1 -0
- package/dist/types/types/adaptic-types.d.ts +1 -1
- package/dist/types/types/adaptic-types.d.ts.map +1 -1
- package/dist/types/types/alpaca-types.d.ts +17 -91
- package/dist/types/types/alpaca-types.d.ts.map +1 -1
- package/dist/types/types/logging-types.d.ts +1 -1
- package/dist/types/types/logging-types.d.ts.map +1 -1
- package/dist/types/types/metrics-types.d.ts +1 -1
- package/dist/types/types/metrics-types.d.ts.map +1 -1
- package/package.json +10 -25
- package/dist/types/__tests__/alpaca-functions.test.d.ts +0 -2
- package/dist/types/__tests__/alpaca-functions.test.d.ts.map +0 -1
- package/dist/types/__tests__/api-endpoints.test.d.ts +0 -2
- package/dist/types/__tests__/api-endpoints.test.d.ts.map +0 -1
- package/dist/types/__tests__/asset-allocation.test.d.ts +0 -2
- package/dist/types/__tests__/asset-allocation.test.d.ts.map +0 -1
- package/dist/types/__tests__/auth-validator.test.d.ts +0 -2
- package/dist/types/__tests__/auth-validator.test.d.ts.map +0 -1
- package/dist/types/__tests__/cache.test.d.ts +0 -2
- package/dist/types/__tests__/cache.test.d.ts.map +0 -1
- package/dist/types/__tests__/errors.test.d.ts +0 -2
- package/dist/types/__tests__/errors.test.d.ts.map +0 -1
- package/dist/types/__tests__/format-tools.test.d.ts +0 -2
- package/dist/types/__tests__/format-tools.test.d.ts.map +0 -1
- package/dist/types/__tests__/http-keep-alive.test.d.ts +0 -2
- package/dist/types/__tests__/http-keep-alive.test.d.ts.map +0 -1
- package/dist/types/__tests__/http-timeout.test.d.ts +0 -2
- package/dist/types/__tests__/http-timeout.test.d.ts.map +0 -1
- package/dist/types/__tests__/logger.test.d.ts +0 -2
- package/dist/types/__tests__/logger.test.d.ts.map +0 -1
- package/dist/types/__tests__/market-time.test.d.ts +0 -2
- package/dist/types/__tests__/market-time.test.d.ts.map +0 -1
- package/dist/types/__tests__/misc-utils.test.d.ts +0 -2
- package/dist/types/__tests__/misc-utils.test.d.ts.map +0 -1
- package/dist/types/__tests__/paginator.test.d.ts +0 -2
- package/dist/types/__tests__/paginator.test.d.ts.map +0 -1
- package/dist/types/__tests__/performance-metrics.test.d.ts +0 -2
- package/dist/types/__tests__/performance-metrics.test.d.ts.map +0 -1
- package/dist/types/__tests__/polygon.test.d.ts +0 -2
- package/dist/types/__tests__/polygon.test.d.ts.map +0 -1
- package/dist/types/__tests__/property-based-financial.test.d.ts +0 -2
- package/dist/types/__tests__/property-based-financial.test.d.ts.map +0 -1
- package/dist/types/__tests__/rate-limiter.test.d.ts +0 -2
- package/dist/types/__tests__/rate-limiter.test.d.ts.map +0 -1
- package/dist/types/__tests__/schema-validation.test.d.ts +0 -2
- package/dist/types/__tests__/schema-validation.test.d.ts.map +0 -1
- package/dist/types/__tests__/technical-analysis.test.d.ts +0 -2
- package/dist/types/__tests__/technical-analysis.test.d.ts.map +0 -1
- package/dist/types/__tests__/time-utils.test.d.ts +0 -2
- package/dist/types/__tests__/time-utils.test.d.ts.map +0 -1
- package/dist/types/alpaca/client.d.ts +0 -95
- package/dist/types/alpaca/client.d.ts.map +0 -1
- package/dist/types/alpaca/crypto/data.d.ts +0 -281
- package/dist/types/alpaca/crypto/data.d.ts.map +0 -1
- package/dist/types/alpaca/crypto/index.d.ts +0 -75
- package/dist/types/alpaca/crypto/index.d.ts.map +0 -1
- package/dist/types/alpaca/crypto/orders.d.ts +0 -221
- package/dist/types/alpaca/crypto/orders.d.ts.map +0 -1
- package/dist/types/alpaca/index.d.ts +0 -205
- package/dist/types/alpaca/index.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/account.d.ts +0 -34
- package/dist/types/alpaca/legacy/account.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/assets.d.ts +0 -13
- package/dist/types/alpaca/legacy/assets.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/auth.d.ts +0 -18
- package/dist/types/alpaca/legacy/auth.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/index.d.ts +0 -15
- package/dist/types/alpaca/legacy/index.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/market-data.d.ts +0 -32
- package/dist/types/alpaca/legacy/market-data.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/orders.d.ts +0 -84
- package/dist/types/alpaca/legacy/orders.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/positions.d.ts +0 -66
- package/dist/types/alpaca/legacy/positions.d.ts.map +0 -1
- package/dist/types/alpaca/legacy/utils.d.ts +0 -18
- package/dist/types/alpaca/legacy/utils.d.ts.map +0 -1
- package/dist/types/alpaca/market-data/bars.d.ts +0 -142
- package/dist/types/alpaca/market-data/bars.d.ts.map +0 -1
- package/dist/types/alpaca/market-data/index.d.ts +0 -13
- package/dist/types/alpaca/market-data/index.d.ts.map +0 -1
- package/dist/types/alpaca/market-data/news.d.ts +0 -87
- package/dist/types/alpaca/market-data/news.d.ts.map +0 -1
- package/dist/types/alpaca/market-data/quotes.d.ts +0 -85
- package/dist/types/alpaca/market-data/quotes.d.ts.map +0 -1
- package/dist/types/alpaca/market-data/trades.d.ts +0 -98
- package/dist/types/alpaca/market-data/trades.d.ts.map +0 -1
- package/dist/types/alpaca/options/contracts.d.ts +0 -279
- package/dist/types/alpaca/options/contracts.d.ts.map +0 -1
- package/dist/types/alpaca/options/data.d.ts +0 -126
- package/dist/types/alpaca/options/data.d.ts.map +0 -1
- package/dist/types/alpaca/options/index.d.ts +0 -17
- package/dist/types/alpaca/options/index.d.ts.map +0 -1
- package/dist/types/alpaca/options/orders.d.ts +0 -366
- package/dist/types/alpaca/options/orders.d.ts.map +0 -1
- package/dist/types/alpaca/options/strategies.d.ts +0 -224
- package/dist/types/alpaca/options/strategies.d.ts.map +0 -1
- package/dist/types/alpaca/streams/base-stream.d.ts +0 -143
- package/dist/types/alpaca/streams/base-stream.d.ts.map +0 -1
- package/dist/types/alpaca/streams/crypto-stream.d.ts +0 -173
- package/dist/types/alpaca/streams/crypto-stream.d.ts.map +0 -1
- package/dist/types/alpaca/streams/index.d.ts +0 -54
- package/dist/types/alpaca/streams/index.d.ts.map +0 -1
- package/dist/types/alpaca/streams/option-stream.d.ts +0 -167
- package/dist/types/alpaca/streams/option-stream.d.ts.map +0 -1
- package/dist/types/alpaca/streams/stock-stream.d.ts +0 -176
- package/dist/types/alpaca/streams/stock-stream.d.ts.map +0 -1
- package/dist/types/alpaca/streams/stream-manager.d.ts +0 -277
- package/dist/types/alpaca/streams/stream-manager.d.ts.map +0 -1
- package/dist/types/alpaca/streams/trading-stream.d.ts +0 -186
- package/dist/types/alpaca/streams/trading-stream.d.ts.map +0 -1
- package/dist/types/alpaca/streams.d.ts +0 -88
- package/dist/types/alpaca/streams.d.ts.map +0 -1
- package/dist/types/alpaca/test-imports.d.ts +0 -7
- package/dist/types/alpaca/test-imports.d.ts.map +0 -1
- package/dist/types/alpaca/trading/account.d.ts +0 -198
- package/dist/types/alpaca/trading/account.d.ts.map +0 -1
- package/dist/types/alpaca/trading/bracket-orders.d.ts +0 -162
- package/dist/types/alpaca/trading/bracket-orders.d.ts.map +0 -1
- package/dist/types/alpaca/trading/clock.d.ts +0 -99
- package/dist/types/alpaca/trading/clock.d.ts.map +0 -1
- package/dist/types/alpaca/trading/index.d.ts +0 -15
- package/dist/types/alpaca/trading/index.d.ts.map +0 -1
- package/dist/types/alpaca/trading/oco-orders.d.ts +0 -203
- package/dist/types/alpaca/trading/oco-orders.d.ts.map +0 -1
- package/dist/types/alpaca/trading/order-utils.d.ts +0 -404
- package/dist/types/alpaca/trading/order-utils.d.ts.map +0 -1
- package/dist/types/alpaca/trading/orders.d.ts +0 -199
- package/dist/types/alpaca/trading/orders.d.ts.map +0 -1
- package/dist/types/alpaca/trading/oto-orders.d.ts +0 -282
- package/dist/types/alpaca/trading/oto-orders.d.ts.map +0 -1
- package/dist/types/alpaca/trading/positions.d.ts +0 -389
- package/dist/types/alpaca/trading/positions.d.ts.map +0 -1
- package/dist/types/alpaca/trading/smart-orders.d.ts +0 -301
- package/dist/types/alpaca/trading/smart-orders.d.ts.map +0 -1
- package/dist/types/alpaca/trading/trailing-stops.d.ts +0 -240
- package/dist/types/alpaca/trading/trailing-stops.d.ts.map +0 -1
- package/dist/types/config/api-endpoints.d.ts +0 -94
- package/dist/types/config/api-endpoints.d.ts.map +0 -1
- package/dist/types/errors/index.d.ts +0 -130
- package/dist/types/errors/index.d.ts.map +0 -1
- package/dist/types/examples/rate-limiter-example.d.ts +0 -7
- package/dist/types/examples/rate-limiter-example.d.ts.map +0 -1
- package/dist/types/http-timeout.d.ts +0 -37
- package/dist/types/http-timeout.d.ts.map +0 -1
- package/dist/types/logger.d.ts +0 -56
- package/dist/types/logger.d.ts.map +0 -1
- package/dist/types/rate-limiter.d.ts +0 -171
- package/dist/types/rate-limiter.d.ts.map +0 -1
- package/dist/types/schemas/alpaca-schemas.d.ts +0 -779
- package/dist/types/schemas/alpaca-schemas.d.ts.map +0 -1
- package/dist/types/schemas/alphavantage-schemas.d.ts +0 -255
- package/dist/types/schemas/alphavantage-schemas.d.ts.map +0 -1
- package/dist/types/schemas/index.d.ts +0 -21
- package/dist/types/schemas/index.d.ts.map +0 -1
- package/dist/types/schemas/polygon-schemas.d.ts +0 -551
- package/dist/types/schemas/polygon-schemas.d.ts.map +0 -1
- package/dist/types/schemas/validate-response.d.ts +0 -88
- package/dist/types/schemas/validate-response.d.ts.map +0 -1
- package/dist/types/utils/auth-validator.d.ts +0 -32
- package/dist/types/utils/auth-validator.d.ts.map +0 -1
- package/dist/types/utils/http-keep-alive.d.ts +0 -110
- package/dist/types/utils/http-keep-alive.d.ts.map +0 -1
- package/dist/types/utils/paginator.d.ts +0 -154
- package/dist/types/utils/paginator.d.ts.map +0 -1
- package/dist/types/utils/retry.d.ts +0 -78
- package/dist/types/utils/retry.d.ts.map +0 -1
|
@@ -1,281 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Crypto Market Data Module
|
|
3
|
-
* Real-time and historical cryptocurrency data
|
|
4
|
-
* Crypto data is available 24/7
|
|
5
|
-
*/
|
|
6
|
-
import { AlpacaClient } from "../client";
|
|
7
|
-
import { CryptoBar, CryptoPair, BTCPairs, USDTPairs, USDCPairs, USDPairs } from "../../types/alpaca-types";
|
|
8
|
-
/**
|
|
9
|
-
* Error thrown when crypto data operations fail
|
|
10
|
-
*/
|
|
11
|
-
export declare class CryptoDataError extends Error {
|
|
12
|
-
code: string;
|
|
13
|
-
symbol?: string | undefined;
|
|
14
|
-
details?: unknown | undefined;
|
|
15
|
-
constructor(message: string, code: string, symbol?: string | undefined, details?: unknown | undefined);
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Crypto trade data
|
|
19
|
-
*/
|
|
20
|
-
export interface CryptoTrade {
|
|
21
|
-
/** Trade price */
|
|
22
|
-
price: number;
|
|
23
|
-
/** Trade size */
|
|
24
|
-
size: number;
|
|
25
|
-
/** Trade timestamp */
|
|
26
|
-
timestamp: Date;
|
|
27
|
-
/** Trade ID */
|
|
28
|
-
id?: number;
|
|
29
|
-
/** Taker side: 'B' for buy, 'S' for sell */
|
|
30
|
-
takerSide?: "B" | "S";
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* Crypto quote data
|
|
34
|
-
*/
|
|
35
|
-
export interface CryptoQuote {
|
|
36
|
-
/** Bid price */
|
|
37
|
-
bid: number;
|
|
38
|
-
/** Bid size */
|
|
39
|
-
bidSize: number;
|
|
40
|
-
/** Ask price */
|
|
41
|
-
ask: number;
|
|
42
|
-
/** Ask size */
|
|
43
|
-
askSize: number;
|
|
44
|
-
/** Quote timestamp */
|
|
45
|
-
timestamp: Date;
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Parameters for fetching crypto bars
|
|
49
|
-
*/
|
|
50
|
-
export interface GetCryptoBarsParams {
|
|
51
|
-
/** Array of crypto symbols (e.g., ['BTC/USD', 'ETH/USD']) */
|
|
52
|
-
symbols: string[];
|
|
53
|
-
/** Timeframe for bars (e.g., '1Min', '1Hour', '1Day') */
|
|
54
|
-
timeframe: string;
|
|
55
|
-
/** Start date/time for data range */
|
|
56
|
-
start?: Date;
|
|
57
|
-
/** End date/time for data range */
|
|
58
|
-
end?: Date;
|
|
59
|
-
/** Maximum number of bars to return per symbol */
|
|
60
|
-
limit?: number;
|
|
61
|
-
/** Sort order */
|
|
62
|
-
sort?: "asc" | "desc";
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Crypto snapshot data
|
|
66
|
-
*/
|
|
67
|
-
export interface CryptoSnapshot {
|
|
68
|
-
/** Symbol */
|
|
69
|
-
symbol: string;
|
|
70
|
-
/** Latest trade */
|
|
71
|
-
latestTrade?: CryptoTrade;
|
|
72
|
-
/** Latest quote */
|
|
73
|
-
latestQuote?: CryptoQuote;
|
|
74
|
-
/** Daily bar */
|
|
75
|
-
dailyBar?: CryptoBar;
|
|
76
|
-
/** Previous daily bar */
|
|
77
|
-
prevDailyBar?: CryptoBar;
|
|
78
|
-
/** Minute bar */
|
|
79
|
-
minuteBar?: CryptoBar;
|
|
80
|
-
}
|
|
81
|
-
/**
|
|
82
|
-
* Get crypto bars (OHLCV data)
|
|
83
|
-
*
|
|
84
|
-
* @param client - AlpacaClient instance
|
|
85
|
-
* @param params - Parameters for fetching bars
|
|
86
|
-
* @returns Map of symbol to array of bars
|
|
87
|
-
*
|
|
88
|
-
* @example
|
|
89
|
-
* const bars = await getCryptoBars(client, {
|
|
90
|
-
* symbols: ['BTC/USD', 'ETH/USD'],
|
|
91
|
-
* timeframe: '1Hour',
|
|
92
|
-
* start: new Date('2024-01-01'),
|
|
93
|
-
* limit: 100,
|
|
94
|
-
* });
|
|
95
|
-
*/
|
|
96
|
-
export declare function getCryptoBars(client: AlpacaClient, params: GetCryptoBarsParams): Promise<Map<string, CryptoBar[]>>;
|
|
97
|
-
/**
|
|
98
|
-
* Get latest crypto trades
|
|
99
|
-
*
|
|
100
|
-
* @param client - AlpacaClient instance
|
|
101
|
-
* @param symbols - Array of crypto symbols
|
|
102
|
-
* @returns Map of symbol to latest trade data
|
|
103
|
-
*
|
|
104
|
-
* @example
|
|
105
|
-
* const trades = await getLatestCryptoTrades(client, ['BTC/USD', 'ETH/USD']);
|
|
106
|
-
* const btcTrade = trades.get('BTC/USD');
|
|
107
|
-
* console.log(`BTC last trade: $${btcTrade?.price}`);
|
|
108
|
-
*/
|
|
109
|
-
export declare function getLatestCryptoTrades(client: AlpacaClient, symbols: string[]): Promise<Map<string, CryptoTrade>>;
|
|
110
|
-
/**
|
|
111
|
-
* Get latest crypto quotes
|
|
112
|
-
*
|
|
113
|
-
* @param client - AlpacaClient instance
|
|
114
|
-
* @param symbols - Array of crypto symbols
|
|
115
|
-
* @returns Map of symbol to latest quote data
|
|
116
|
-
*
|
|
117
|
-
* @example
|
|
118
|
-
* const quotes = await getLatestCryptoQuotes(client, ['BTC/USD']);
|
|
119
|
-
* const btcQuote = quotes.get('BTC/USD');
|
|
120
|
-
* console.log(`BTC bid/ask: $${btcQuote?.bid}/$${btcQuote?.ask}`);
|
|
121
|
-
*/
|
|
122
|
-
export declare function getLatestCryptoQuotes(client: AlpacaClient, symbols: string[]): Promise<Map<string, CryptoQuote>>;
|
|
123
|
-
/**
|
|
124
|
-
* Get the current price for a crypto symbol
|
|
125
|
-
* Uses the latest trade price
|
|
126
|
-
*
|
|
127
|
-
* @param client - AlpacaClient instance
|
|
128
|
-
* @param symbol - Crypto symbol (e.g., 'BTC/USD')
|
|
129
|
-
* @returns Current price
|
|
130
|
-
*
|
|
131
|
-
* @example
|
|
132
|
-
* const btcPrice = await getCryptoPrice(client, 'BTC/USD');
|
|
133
|
-
* console.log(`Bitcoin is currently $${btcPrice.toFixed(2)}`);
|
|
134
|
-
*/
|
|
135
|
-
export declare function getCryptoPrice(client: AlpacaClient, symbol: string): Promise<number>;
|
|
136
|
-
/**
|
|
137
|
-
* Get the bid-ask spread for a crypto symbol
|
|
138
|
-
*
|
|
139
|
-
* @param client - AlpacaClient instance
|
|
140
|
-
* @param symbol - Crypto symbol (e.g., 'BTC/USD')
|
|
141
|
-
* @returns Object with bid, ask, spread, and spreadPercent
|
|
142
|
-
*
|
|
143
|
-
* @example
|
|
144
|
-
* const spread = await getCryptoSpread(client, 'BTC/USD');
|
|
145
|
-
* console.log(`BTC spread: $${spread.spread.toFixed(2)} (${spread.spreadPercent.toFixed(4)}%)`);
|
|
146
|
-
*/
|
|
147
|
-
export declare function getCryptoSpread(client: AlpacaClient, symbol: string): Promise<{
|
|
148
|
-
bid: number;
|
|
149
|
-
ask: number;
|
|
150
|
-
spread: number;
|
|
151
|
-
spreadPercent: number;
|
|
152
|
-
}>;
|
|
153
|
-
/**
|
|
154
|
-
* Get crypto snapshots with latest trade, quote, and bar data
|
|
155
|
-
*
|
|
156
|
-
* @param client - AlpacaClient instance
|
|
157
|
-
* @param symbols - Array of crypto symbols
|
|
158
|
-
* @returns Map of symbol to snapshot data
|
|
159
|
-
*
|
|
160
|
-
* @example
|
|
161
|
-
* const snapshots = await getCryptoSnapshots(client, ['BTC/USD', 'ETH/USD']);
|
|
162
|
-
*/
|
|
163
|
-
export declare function getCryptoSnapshots(client: AlpacaClient, symbols: string[]): Promise<Map<string, CryptoSnapshot>>;
|
|
164
|
-
/**
|
|
165
|
-
* Get historical crypto trades
|
|
166
|
-
*
|
|
167
|
-
* @param client - AlpacaClient instance
|
|
168
|
-
* @param symbol - Crypto symbol
|
|
169
|
-
* @param start - Start date/time
|
|
170
|
-
* @param end - Optional end date/time
|
|
171
|
-
* @param limit - Maximum number of trades
|
|
172
|
-
* @returns Array of trades
|
|
173
|
-
*
|
|
174
|
-
* @example
|
|
175
|
-
* const trades = await getCryptoTrades(client, 'BTC/USD', new Date('2024-01-01'), undefined, 100);
|
|
176
|
-
*/
|
|
177
|
-
export declare function getCryptoTrades(client: AlpacaClient, symbol: string, start: Date, end?: Date, limit?: number): Promise<CryptoTrade[]>;
|
|
178
|
-
/**
|
|
179
|
-
* Get daily prices for a crypto symbol
|
|
180
|
-
*
|
|
181
|
-
* @param client - AlpacaClient instance
|
|
182
|
-
* @param symbol - Crypto symbol
|
|
183
|
-
* @param days - Number of days of history
|
|
184
|
-
* @returns Array of daily bars
|
|
185
|
-
*
|
|
186
|
-
* @example
|
|
187
|
-
* const dailyBars = await getCryptoDailyPrices(client, 'BTC/USD', 30);
|
|
188
|
-
*/
|
|
189
|
-
export declare function getCryptoDailyPrices(client: AlpacaClient, symbol: string, days: number): Promise<CryptoBar[]>;
|
|
190
|
-
/**
|
|
191
|
-
* Calculate 24-hour price change for a crypto symbol
|
|
192
|
-
*
|
|
193
|
-
* @param client - AlpacaClient instance
|
|
194
|
-
* @param symbol - Crypto symbol
|
|
195
|
-
* @returns Object with current price, previous price, change, and change percent
|
|
196
|
-
*
|
|
197
|
-
* @example
|
|
198
|
-
* const change = await getCrypto24HourChange(client, 'BTC/USD');
|
|
199
|
-
* console.log(`BTC 24h change: ${change.changePercent.toFixed(2)}%`);
|
|
200
|
-
*/
|
|
201
|
-
export declare function getCrypto24HourChange(client: AlpacaClient, symbol: string): Promise<{
|
|
202
|
-
currentPrice: number;
|
|
203
|
-
previousPrice: number;
|
|
204
|
-
change: number;
|
|
205
|
-
changePercent: number;
|
|
206
|
-
}>;
|
|
207
|
-
/**
|
|
208
|
-
* All supported BTC trading pairs
|
|
209
|
-
*/
|
|
210
|
-
export declare const BTC_PAIRS: BTCPairs[];
|
|
211
|
-
/**
|
|
212
|
-
* All supported USDT trading pairs
|
|
213
|
-
*/
|
|
214
|
-
export declare const USDT_PAIRS: USDTPairs[];
|
|
215
|
-
/**
|
|
216
|
-
* All supported USDC trading pairs
|
|
217
|
-
*/
|
|
218
|
-
export declare const USDC_PAIRS: USDCPairs[];
|
|
219
|
-
/**
|
|
220
|
-
* All supported USD trading pairs
|
|
221
|
-
*/
|
|
222
|
-
export declare const USD_PAIRS: USDPairs[];
|
|
223
|
-
/**
|
|
224
|
-
* Get all supported crypto pairs
|
|
225
|
-
*
|
|
226
|
-
* @returns Array of all supported crypto trading pairs
|
|
227
|
-
*
|
|
228
|
-
* @example
|
|
229
|
-
* const pairs = getSupportedCryptoPairs();
|
|
230
|
-
* console.log(`${pairs.length} crypto pairs available`);
|
|
231
|
-
*/
|
|
232
|
-
export declare function getSupportedCryptoPairs(): CryptoPair[];
|
|
233
|
-
/**
|
|
234
|
-
* Get supported crypto pairs by quote currency
|
|
235
|
-
*
|
|
236
|
-
* @param quoteCurrency - Quote currency ('USD', 'USDC', 'USDT', 'BTC')
|
|
237
|
-
* @returns Array of supported pairs for that quote currency
|
|
238
|
-
*
|
|
239
|
-
* @example
|
|
240
|
-
* const usdPairs = getCryptoPairsByQuote('USD');
|
|
241
|
-
*/
|
|
242
|
-
export declare function getCryptoPairsByQuote(quoteCurrency: "USD" | "USDC" | "USDT" | "BTC"): CryptoPair[];
|
|
243
|
-
/**
|
|
244
|
-
* Check if a crypto pair is supported
|
|
245
|
-
*
|
|
246
|
-
* @param symbol - Crypto pair to check
|
|
247
|
-
* @returns true if the pair is supported
|
|
248
|
-
*
|
|
249
|
-
* @example
|
|
250
|
-
* if (isSupportedCryptoPair('BTC/USD')) {
|
|
251
|
-
* // Trade BTC
|
|
252
|
-
* }
|
|
253
|
-
*/
|
|
254
|
-
export declare function isSupportedCryptoPair(symbol: string): boolean;
|
|
255
|
-
/**
|
|
256
|
-
* Get popular crypto pairs (most commonly traded)
|
|
257
|
-
*
|
|
258
|
-
* @returns Array of popular crypto trading pairs
|
|
259
|
-
*/
|
|
260
|
-
export declare function getPopularCryptoPairs(): CryptoPair[];
|
|
261
|
-
declare const _default: {
|
|
262
|
-
getCryptoBars: typeof getCryptoBars;
|
|
263
|
-
getLatestCryptoTrades: typeof getLatestCryptoTrades;
|
|
264
|
-
getLatestCryptoQuotes: typeof getLatestCryptoQuotes;
|
|
265
|
-
getCryptoPrice: typeof getCryptoPrice;
|
|
266
|
-
getCryptoSpread: typeof getCryptoSpread;
|
|
267
|
-
getCryptoSnapshots: typeof getCryptoSnapshots;
|
|
268
|
-
getCryptoTrades: typeof getCryptoTrades;
|
|
269
|
-
getCryptoDailyPrices: typeof getCryptoDailyPrices;
|
|
270
|
-
getCrypto24HourChange: typeof getCrypto24HourChange;
|
|
271
|
-
getSupportedCryptoPairs: typeof getSupportedCryptoPairs;
|
|
272
|
-
getCryptoPairsByQuote: typeof getCryptoPairsByQuote;
|
|
273
|
-
isSupportedCryptoPair: typeof isSupportedCryptoPair;
|
|
274
|
-
getPopularCryptoPairs: typeof getPopularCryptoPairs;
|
|
275
|
-
BTC_PAIRS: BTCPairs[];
|
|
276
|
-
USDT_PAIRS: USDTPairs[];
|
|
277
|
-
USDC_PAIRS: USDCPairs[];
|
|
278
|
-
USD_PAIRS: USDPairs[];
|
|
279
|
-
};
|
|
280
|
-
export default _default;
|
|
281
|
-
//# sourceMappingURL=data.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/alpaca/crypto/data.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EACL,SAAS,EACT,UAAU,EAEV,QAAQ,EACR,SAAS,EACT,SAAS,EACT,QAAQ,EACT,MAAM,0BAA0B,CAAC;AAWlC;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IAG/B,IAAI,EAAE,MAAM;IACZ,MAAM,CAAC,EAAE,MAAM;IACf,OAAO,CAAC,EAAE,OAAO;gBAHxB,OAAO,EAAE,MAAM,EACR,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,YAAA,EACf,OAAO,CAAC,EAAE,OAAO,YAAA;CAK3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,SAAS,EAAE,IAAI,CAAC;IAChB,eAAe;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB;IACtB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,mCAAmC;IACnC,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB;IACjB,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,mBAAmB;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,yBAAyB;IACzB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,iBAAiB;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAmCD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAsInC;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CA8DnC;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CA8DnC;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,CAoBjB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IACT,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC,CA6BD;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CA2JtC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,IAAI,EACX,GAAG,CAAC,EAAE,IAAI,EACV,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,EAAE,CAAC,CAqGxB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,SAAS,EAAE,CAAC,CAmCtB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IACT,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC,CAuCD;AAMD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,QAAQ,EAK/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,EAWjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,EAmBjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,QAAQ,EAqB/B,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,IAAI,UAAU,EAAE,CAEtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAC7C,UAAU,EAAE,CAad;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAI7D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,IAAI,UAAU,EAAE,CAWpD;;;;;;;;;;;;;;;;;;;;AAED,wBAkBE"}
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Crypto Module Index
|
|
3
|
-
* Exports all crypto trading and market data functions
|
|
4
|
-
* Crypto trading is available 24/7 on Alpaca
|
|
5
|
-
*/
|
|
6
|
-
export { CryptoOrderError, CryptoOrderParams, createCryptoOrder, createCryptoMarketOrder, createCryptoLimitOrder, createCryptoStopOrder, createCryptoStopLimitOrder, buyCryptoNotional, sellCryptoNotional, sellAllCrypto, getOpenCryptoOrders, cancelAllCryptoOrders, isCryptoPair, } from "./orders";
|
|
7
|
-
export { CryptoDataError, CryptoTrade, CryptoQuote, GetCryptoBarsParams, CryptoSnapshot, getCryptoBars, getLatestCryptoTrades, getLatestCryptoQuotes, getCryptoPrice, getCryptoSpread, getCryptoSnapshots, getCryptoTrades, getCryptoDailyPrices, getCrypto24HourChange, getSupportedCryptoPairs, getCryptoPairsByQuote, isSupportedCryptoPair, getPopularCryptoPairs, BTC_PAIRS, USDT_PAIRS, USDC_PAIRS, USD_PAIRS, } from "./data";
|
|
8
|
-
export declare const orders: {
|
|
9
|
-
createCryptoOrder: typeof import("./orders").createCryptoOrder;
|
|
10
|
-
createCryptoMarketOrder: typeof import("./orders").createCryptoMarketOrder;
|
|
11
|
-
createCryptoLimitOrder: typeof import("./orders").createCryptoLimitOrder;
|
|
12
|
-
createCryptoStopOrder: typeof import("./orders").createCryptoStopOrder;
|
|
13
|
-
createCryptoStopLimitOrder: typeof import("./orders").createCryptoStopLimitOrder;
|
|
14
|
-
buyCryptoNotional: typeof import("./orders").buyCryptoNotional;
|
|
15
|
-
sellCryptoNotional: typeof import("./orders").sellCryptoNotional;
|
|
16
|
-
sellAllCrypto: typeof import("./orders").sellAllCrypto;
|
|
17
|
-
getOpenCryptoOrders: typeof import("./orders").getOpenCryptoOrders;
|
|
18
|
-
cancelAllCryptoOrders: typeof import("./orders").cancelAllCryptoOrders;
|
|
19
|
-
isCryptoPair: typeof import("./orders").isCryptoPair;
|
|
20
|
-
};
|
|
21
|
-
export declare const data: {
|
|
22
|
-
getCryptoBars: typeof import("./data").getCryptoBars;
|
|
23
|
-
getLatestCryptoTrades: typeof import("./data").getLatestCryptoTrades;
|
|
24
|
-
getLatestCryptoQuotes: typeof import("./data").getLatestCryptoQuotes;
|
|
25
|
-
getCryptoPrice: typeof import("./data").getCryptoPrice;
|
|
26
|
-
getCryptoSpread: typeof import("./data").getCryptoSpread;
|
|
27
|
-
getCryptoSnapshots: typeof import("./data").getCryptoSnapshots;
|
|
28
|
-
getCryptoTrades: typeof import("./data").getCryptoTrades;
|
|
29
|
-
getCryptoDailyPrices: typeof import("./data").getCryptoDailyPrices;
|
|
30
|
-
getCrypto24HourChange: typeof import("./data").getCrypto24HourChange;
|
|
31
|
-
getSupportedCryptoPairs: typeof import("./data").getSupportedCryptoPairs;
|
|
32
|
-
getCryptoPairsByQuote: typeof import("./data").getCryptoPairsByQuote;
|
|
33
|
-
isSupportedCryptoPair: typeof import("./data").isSupportedCryptoPair;
|
|
34
|
-
getPopularCryptoPairs: typeof import("./data").getPopularCryptoPairs;
|
|
35
|
-
BTC_PAIRS: import("../..").BTCPairs[];
|
|
36
|
-
USDT_PAIRS: import("../..").USDTPairs[];
|
|
37
|
-
USDC_PAIRS: import("../..").USDCPairs[];
|
|
38
|
-
USD_PAIRS: import("../..").USDPairs[];
|
|
39
|
-
};
|
|
40
|
-
declare const _default: {
|
|
41
|
-
orders: {
|
|
42
|
-
createCryptoOrder: typeof import("./orders").createCryptoOrder;
|
|
43
|
-
createCryptoMarketOrder: typeof import("./orders").createCryptoMarketOrder;
|
|
44
|
-
createCryptoLimitOrder: typeof import("./orders").createCryptoLimitOrder;
|
|
45
|
-
createCryptoStopOrder: typeof import("./orders").createCryptoStopOrder;
|
|
46
|
-
createCryptoStopLimitOrder: typeof import("./orders").createCryptoStopLimitOrder;
|
|
47
|
-
buyCryptoNotional: typeof import("./orders").buyCryptoNotional;
|
|
48
|
-
sellCryptoNotional: typeof import("./orders").sellCryptoNotional;
|
|
49
|
-
sellAllCrypto: typeof import("./orders").sellAllCrypto;
|
|
50
|
-
getOpenCryptoOrders: typeof import("./orders").getOpenCryptoOrders;
|
|
51
|
-
cancelAllCryptoOrders: typeof import("./orders").cancelAllCryptoOrders;
|
|
52
|
-
isCryptoPair: typeof import("./orders").isCryptoPair;
|
|
53
|
-
};
|
|
54
|
-
data: {
|
|
55
|
-
getCryptoBars: typeof import("./data").getCryptoBars;
|
|
56
|
-
getLatestCryptoTrades: typeof import("./data").getLatestCryptoTrades;
|
|
57
|
-
getLatestCryptoQuotes: typeof import("./data").getLatestCryptoQuotes;
|
|
58
|
-
getCryptoPrice: typeof import("./data").getCryptoPrice;
|
|
59
|
-
getCryptoSpread: typeof import("./data").getCryptoSpread;
|
|
60
|
-
getCryptoSnapshots: typeof import("./data").getCryptoSnapshots;
|
|
61
|
-
getCryptoTrades: typeof import("./data").getCryptoTrades;
|
|
62
|
-
getCryptoDailyPrices: typeof import("./data").getCryptoDailyPrices;
|
|
63
|
-
getCrypto24HourChange: typeof import("./data").getCrypto24HourChange;
|
|
64
|
-
getSupportedCryptoPairs: typeof import("./data").getSupportedCryptoPairs;
|
|
65
|
-
getCryptoPairsByQuote: typeof import("./data").getCryptoPairsByQuote;
|
|
66
|
-
isSupportedCryptoPair: typeof import("./data").isSupportedCryptoPair;
|
|
67
|
-
getPopularCryptoPairs: typeof import("./data").getPopularCryptoPairs;
|
|
68
|
-
BTC_PAIRS: import("../..").BTCPairs[];
|
|
69
|
-
USDT_PAIRS: import("../..").USDTPairs[];
|
|
70
|
-
USDC_PAIRS: import("../..").USDCPairs[];
|
|
71
|
-
USD_PAIRS: import("../..").USDPairs[];
|
|
72
|
-
};
|
|
73
|
-
};
|
|
74
|
-
export default _default;
|
|
75
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/alpaca/crypto/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,GACb,MAAM,UAAU,CAAC;AAGlB,OAAO,EACL,eAAe,EACf,WAAW,EACX,WAAW,EACX,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,SAAS,EACT,UAAU,EACV,UAAU,EACV,SAAS,GACV,MAAM,QAAQ,CAAC;AAMhB,eAAO,MAAM,MAAM;;;;;;;;;;;;CAAe,CAAC;AACnC,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;CAAa,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE/B,wBAGE"}
|
|
@@ -1,221 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Crypto Orders Module
|
|
3
|
-
* Create and manage cryptocurrency orders
|
|
4
|
-
* Crypto trading is available 24/7 on Alpaca
|
|
5
|
-
*/
|
|
6
|
-
import { AlpacaClient } from "../client";
|
|
7
|
-
import { AlpacaOrder, OrderSide, OrderType, TimeInForce } from "../../types/alpaca-types";
|
|
8
|
-
/**
|
|
9
|
-
* Error thrown when crypto order operations fail
|
|
10
|
-
*/
|
|
11
|
-
export declare class CryptoOrderError extends Error {
|
|
12
|
-
code: string;
|
|
13
|
-
symbol?: string | undefined;
|
|
14
|
-
details?: unknown | undefined;
|
|
15
|
-
constructor(message: string, code: string, symbol?: string | undefined, details?: unknown | undefined);
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Parameters for creating a crypto order
|
|
19
|
-
* Crypto trading is available 24/7
|
|
20
|
-
*/
|
|
21
|
-
export interface CryptoOrderParams {
|
|
22
|
-
/** Crypto pair symbol (e.g., 'BTC/USD', 'ETH/USD') */
|
|
23
|
-
symbol: string;
|
|
24
|
-
/** Quantity to trade (mutually exclusive with notional) */
|
|
25
|
-
qty?: number;
|
|
26
|
-
/** Dollar amount to trade (mutually exclusive with qty) */
|
|
27
|
-
notional?: number;
|
|
28
|
-
/** Order side: 'buy' or 'sell' */
|
|
29
|
-
side: OrderSide;
|
|
30
|
-
/** Order type: 'market', 'limit', 'stop', 'stop_limit' */
|
|
31
|
-
type: OrderType;
|
|
32
|
-
/** Limit price for limit/stop_limit orders */
|
|
33
|
-
limitPrice?: number;
|
|
34
|
-
/** Stop price for stop/stop_limit orders */
|
|
35
|
-
stopPrice?: number;
|
|
36
|
-
/** Time in force - typically 'gtc' for crypto */
|
|
37
|
-
timeInForce?: TimeInForce;
|
|
38
|
-
/** Optional client-specified order ID */
|
|
39
|
-
clientOrderId?: string;
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Create a crypto order
|
|
43
|
-
* Crypto trading is available 24/7 on Alpaca
|
|
44
|
-
*
|
|
45
|
-
* @param client - The AlpacaClient instance
|
|
46
|
-
* @param params - Crypto order parameters
|
|
47
|
-
* @returns The created order
|
|
48
|
-
* @throws CryptoOrderError if order creation fails
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* // Buy 0.5 BTC at market price
|
|
52
|
-
* const order = await createCryptoOrder(client, {
|
|
53
|
-
* symbol: 'BTC/USD',
|
|
54
|
-
* qty: 0.5,
|
|
55
|
-
* side: 'buy',
|
|
56
|
-
* type: 'market',
|
|
57
|
-
* });
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* // Buy $100 worth of ETH
|
|
61
|
-
* const order = await createCryptoOrder(client, {
|
|
62
|
-
* symbol: 'ETH/USD',
|
|
63
|
-
* notional: 100,
|
|
64
|
-
* side: 'buy',
|
|
65
|
-
* type: 'market',
|
|
66
|
-
* });
|
|
67
|
-
*/
|
|
68
|
-
export declare function createCryptoOrder(client: AlpacaClient, params: CryptoOrderParams): Promise<AlpacaOrder>;
|
|
69
|
-
/**
|
|
70
|
-
* Create a crypto market order
|
|
71
|
-
* Executes immediately at the current market price
|
|
72
|
-
*
|
|
73
|
-
* @param client - The AlpacaClient instance
|
|
74
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
75
|
-
* @param side - Order side: 'buy' or 'sell'
|
|
76
|
-
* @param qty - Quantity to trade
|
|
77
|
-
* @returns The created order
|
|
78
|
-
*
|
|
79
|
-
* @example
|
|
80
|
-
* const order = await createCryptoMarketOrder(client, 'BTC/USD', 'buy', 0.1);
|
|
81
|
-
*/
|
|
82
|
-
export declare function createCryptoMarketOrder(client: AlpacaClient, symbol: string, side: OrderSide, qty: number): Promise<AlpacaOrder>;
|
|
83
|
-
/**
|
|
84
|
-
* Create a crypto limit order
|
|
85
|
-
* Executes only at the specified price or better
|
|
86
|
-
*
|
|
87
|
-
* @param client - The AlpacaClient instance
|
|
88
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
89
|
-
* @param side - Order side: 'buy' or 'sell'
|
|
90
|
-
* @param qty - Quantity to trade
|
|
91
|
-
* @param limitPrice - Maximum (buy) or minimum (sell) price
|
|
92
|
-
* @returns The created order
|
|
93
|
-
*
|
|
94
|
-
* @example
|
|
95
|
-
* // Buy 0.5 BTC at $40,000 or lower
|
|
96
|
-
* const order = await createCryptoLimitOrder(client, 'BTC/USD', 'buy', 0.5, 40000);
|
|
97
|
-
*/
|
|
98
|
-
export declare function createCryptoLimitOrder(client: AlpacaClient, symbol: string, side: OrderSide, qty: number, limitPrice: number): Promise<AlpacaOrder>;
|
|
99
|
-
/**
|
|
100
|
-
* Create a crypto stop order
|
|
101
|
-
* Becomes a market order when the stop price is reached
|
|
102
|
-
*
|
|
103
|
-
* @param client - The AlpacaClient instance
|
|
104
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
105
|
-
* @param side - Order side: 'buy' or 'sell'
|
|
106
|
-
* @param qty - Quantity to trade
|
|
107
|
-
* @param stopPrice - Price at which to trigger the order
|
|
108
|
-
* @returns The created order
|
|
109
|
-
*
|
|
110
|
-
* @example
|
|
111
|
-
* // Sell 0.5 BTC if price drops to $35,000
|
|
112
|
-
* const order = await createCryptoStopOrder(client, 'BTC/USD', 'sell', 0.5, 35000);
|
|
113
|
-
*/
|
|
114
|
-
export declare function createCryptoStopOrder(client: AlpacaClient, symbol: string, side: OrderSide, qty: number, stopPrice: number): Promise<AlpacaOrder>;
|
|
115
|
-
/**
|
|
116
|
-
* Create a crypto stop-limit order
|
|
117
|
-
* Becomes a limit order when the stop price is reached
|
|
118
|
-
*
|
|
119
|
-
* @param client - The AlpacaClient instance
|
|
120
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
121
|
-
* @param side - Order side: 'buy' or 'sell'
|
|
122
|
-
* @param qty - Quantity to trade
|
|
123
|
-
* @param stopPrice - Price at which to trigger the limit order
|
|
124
|
-
* @param limitPrice - Limit price for the resulting order
|
|
125
|
-
* @returns The created order
|
|
126
|
-
*
|
|
127
|
-
* @example
|
|
128
|
-
* // Sell 0.5 BTC when price drops to $35,000, but not below $34,500
|
|
129
|
-
* const order = await createCryptoStopLimitOrder(client, 'BTC/USD', 'sell', 0.5, 35000, 34500);
|
|
130
|
-
*/
|
|
131
|
-
export declare function createCryptoStopLimitOrder(client: AlpacaClient, symbol: string, side: OrderSide, qty: number, stopPrice: number, limitPrice: number): Promise<AlpacaOrder>;
|
|
132
|
-
/**
|
|
133
|
-
* Buy crypto with a dollar amount (notional order)
|
|
134
|
-
* Allows purchasing crypto with a specific USD amount
|
|
135
|
-
*
|
|
136
|
-
* @param client - The AlpacaClient instance
|
|
137
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
138
|
-
* @param dollarAmount - Amount in USD to spend
|
|
139
|
-
* @returns The created order
|
|
140
|
-
*
|
|
141
|
-
* @example
|
|
142
|
-
* // Buy $500 worth of Bitcoin
|
|
143
|
-
* const order = await buyCryptoNotional(client, 'BTC/USD', 500);
|
|
144
|
-
*/
|
|
145
|
-
export declare function buyCryptoNotional(client: AlpacaClient, symbol: string, dollarAmount: number): Promise<AlpacaOrder>;
|
|
146
|
-
/**
|
|
147
|
-
* Sell crypto for a dollar amount (notional order)
|
|
148
|
-
* Allows selling crypto for a specific USD amount
|
|
149
|
-
*
|
|
150
|
-
* @param client - The AlpacaClient instance
|
|
151
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
152
|
-
* @param dollarAmount - Amount in USD to receive
|
|
153
|
-
* @returns The created order
|
|
154
|
-
*
|
|
155
|
-
* @example
|
|
156
|
-
* // Sell $200 worth of Ethereum
|
|
157
|
-
* const order = await sellCryptoNotional(client, 'ETH/USD', 200);
|
|
158
|
-
*/
|
|
159
|
-
export declare function sellCryptoNotional(client: AlpacaClient, symbol: string, dollarAmount: number): Promise<AlpacaOrder>;
|
|
160
|
-
/**
|
|
161
|
-
* Sell all of a crypto position
|
|
162
|
-
* Closes the entire position for the specified crypto pair
|
|
163
|
-
*
|
|
164
|
-
* @param client - The AlpacaClient instance
|
|
165
|
-
* @param symbol - Crypto pair symbol (e.g., 'BTC/USD')
|
|
166
|
-
* @returns The close order
|
|
167
|
-
* @throws CryptoOrderError if no position exists or close fails
|
|
168
|
-
*
|
|
169
|
-
* @example
|
|
170
|
-
* const order = await sellAllCrypto(client, 'BTC/USD');
|
|
171
|
-
*/
|
|
172
|
-
export declare function sellAllCrypto(client: AlpacaClient, symbol: string): Promise<AlpacaOrder>;
|
|
173
|
-
/**
|
|
174
|
-
* Get all open crypto orders
|
|
175
|
-
*
|
|
176
|
-
* @param client - The AlpacaClient instance
|
|
177
|
-
* @param symbols - Optional array of crypto symbols to filter by
|
|
178
|
-
* @returns Array of open crypto orders
|
|
179
|
-
*
|
|
180
|
-
* @example
|
|
181
|
-
* const orders = await getOpenCryptoOrders(client);
|
|
182
|
-
* const btcOrders = await getOpenCryptoOrders(client, ['BTC/USD']);
|
|
183
|
-
*/
|
|
184
|
-
export declare function getOpenCryptoOrders(client: AlpacaClient, symbols?: string[]): Promise<AlpacaOrder[]>;
|
|
185
|
-
/**
|
|
186
|
-
* Cancel all open crypto orders
|
|
187
|
-
*
|
|
188
|
-
* @param client - The AlpacaClient instance
|
|
189
|
-
* @param symbol - Optional specific crypto symbol to cancel orders for
|
|
190
|
-
* @returns Number of orders canceled
|
|
191
|
-
*
|
|
192
|
-
* @example
|
|
193
|
-
* // Cancel all crypto orders
|
|
194
|
-
* const canceled = await cancelAllCryptoOrders(client);
|
|
195
|
-
*
|
|
196
|
-
* // Cancel only BTC orders
|
|
197
|
-
* const canceled = await cancelAllCryptoOrders(client, 'BTC/USD');
|
|
198
|
-
*/
|
|
199
|
-
export declare function cancelAllCryptoOrders(client: AlpacaClient, symbol?: string): Promise<number>;
|
|
200
|
-
/**
|
|
201
|
-
* Check if a symbol is a valid crypto pair
|
|
202
|
-
*
|
|
203
|
-
* @param symbol - Symbol to check
|
|
204
|
-
* @returns true if the symbol appears to be a crypto pair
|
|
205
|
-
*/
|
|
206
|
-
export declare function isCryptoPair(symbol: string): boolean;
|
|
207
|
-
declare const _default: {
|
|
208
|
-
createCryptoOrder: typeof createCryptoOrder;
|
|
209
|
-
createCryptoMarketOrder: typeof createCryptoMarketOrder;
|
|
210
|
-
createCryptoLimitOrder: typeof createCryptoLimitOrder;
|
|
211
|
-
createCryptoStopOrder: typeof createCryptoStopOrder;
|
|
212
|
-
createCryptoStopLimitOrder: typeof createCryptoStopLimitOrder;
|
|
213
|
-
buyCryptoNotional: typeof buyCryptoNotional;
|
|
214
|
-
sellCryptoNotional: typeof sellCryptoNotional;
|
|
215
|
-
sellAllCrypto: typeof sellAllCrypto;
|
|
216
|
-
getOpenCryptoOrders: typeof getOpenCryptoOrders;
|
|
217
|
-
cancelAllCryptoOrders: typeof cancelAllCryptoOrders;
|
|
218
|
-
isCryptoPair: typeof isCryptoPair;
|
|
219
|
-
};
|
|
220
|
-
export default _default;
|
|
221
|
-
//# sourceMappingURL=orders.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../../src/alpaca/crypto/orders.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EACL,WAAW,EACX,SAAS,EACT,SAAS,EACT,WAAW,EAEZ,MAAM,0BAA0B,CAAC;AAWlC;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IAGhC,IAAI,EAAE,MAAM;IACZ,MAAM,CAAC,EAAE,MAAM;IACf,OAAO,CAAC,EAAE,OAAO;gBAHxB,OAAO,EAAE,MAAM,EACR,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,YAAA,EACf,OAAO,CAAC,EAAE,OAAO,YAAA;CAK3B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,0DAA0D;IAC1D,IAAI,EAAE,SAAS,CAAC;IAChB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA8FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,WAAW,CAAC,CAuFtB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,EACf,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,WAAW,CAAC,CAOtB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,EACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,WAAW,CAAC,CAQtB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,EACf,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,WAAW,CAAC,CAQtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,EACf,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,WAAW,CAAC,CAStB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,WAAW,CAAC,CAetB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,WAAW,CAAC,CAetB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CAuFtB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,WAAW,EAAE,CAAC,CA0CxB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAyCjB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGpD;;;;;;;;;;;;;;AAED,wBAYE"}
|