@sudowealth/schwab-api
Version:
TypeScript client for Charles Schwab API with OAuth support, market data, trading functionality, and complete type safety
114 lines (113 loc) • 4.61 kB
JavaScript
export * from './schema.js';
export * from './endpoints.js';
/**
* Extracts and aggregates quote errors from a GetQuotesResponseBody
*
* When using the quotes endpoints, it's possible to get a successful HTTP 200 response
* that contains a mix of valid quotes and per-symbol errors. This function helps identify
* and extract those symbol-level errors for easier processing.
*
* @param responseBody - The response body from getQuotes or getQuoteBySymbolId
* @returns An object with information about the errors, including:
* - hasErrors: Boolean indicating if any symbols had errors
* - errorCount: Total number of symbols with errors
* - symbolErrors: Map of symbol to error information
* - invalidSymbols: List of symbols marked as invalid
* - invalidCusips: List of CUSIPs marked as invalid
* - invalidSSIDs: List of SSIDs marked as invalid
*/
export function extractQuoteErrors(responseBody) {
const result = {
hasErrors: false,
errorCount: 0,
symbolErrors: {},
invalidSymbols: [],
invalidCusips: [],
invalidSSIDs: [],
};
// Early return if response is empty
if (!responseBody || typeof responseBody !== 'object') {
return result;
}
// Check each symbol in the response
for (const [symbol, data] of Object.entries(responseBody)) {
// Check if this entry is an error (lacks assetType but might have error properties)
// We're using a simple heuristic: if it has description, invalidSymbols, etc. but no assetType
if (data && typeof data === 'object' && !('assetType' in data)) {
// This appears to be an error entry
result.hasErrors = true;
result.errorCount++;
result.symbolErrors[symbol] = data;
// Collect specific error details if available
if ('invalidSymbols' in data && Array.isArray(data.invalidSymbols)) {
result.invalidSymbols.push(...data.invalidSymbols);
}
if ('invalidCusips' in data && Array.isArray(data.invalidCusips)) {
result.invalidCusips.push(...data.invalidCusips);
}
if ('invalidSSIDs' in data && Array.isArray(data.invalidSSIDs)) {
result.invalidSSIDs.push(...data.invalidSSIDs);
}
}
}
return result;
}
/**
* Checks if a specific symbol has an error in the quotes response
*
* @param responseBody - The response body from getQuotes or getQuoteBySymbolId
* @param symbol - The symbol to check for errors
* @returns True if the symbol has an error, false if it has valid quote data or isn't in the response
*/
export function hasSymbolError(responseBody, symbol) {
if (!responseBody ||
typeof responseBody !== 'object' ||
!(symbol in responseBody)) {
return false;
}
const data = responseBody[symbol];
// Check if this entry is an error (lacks assetType but has error-related properties)
return data && typeof data === 'object' && !('assetType' in data);
}
/**
* Extracts the quote data for a single symbol from the getQuoteBySymbolId response
*
* Since the Schwab API returns the quote data wrapped in an object with the symbol as the key
* (e.g., { "TSLA": { assetType: "EQUITY", ... } }), this utility function makes it easier
* to extract the actual quote data.
*
* @param responseBody - The response body from getQuoteBySymbolId
* @param symbol - The symbol to extract (if not provided, will use the first key in the response)
* @returns The quote data for the symbol, or null if not found or has an error
*
* @example
* ```typescript
* const response = await client.marketData.quotes.getQuoteBySymbolId({
* pathParams: { symbol_id: 'TSLA' },
* queryParams: { fields: ['all'] }
* });
*
* const quote = extractSingleQuote(response, 'TSLA');
* if (quote) {
* console.log(`${quote.symbol}: $${quote.quote?.lastPrice}`);
* }
* ```
*/
export function extractSingleQuote(responseBody, symbol) {
if (!responseBody || typeof responseBody !== 'object') {
return null;
}
// If no symbol provided, use the first key
const targetSymbol = symbol || Object.keys(responseBody)[0];
if (!targetSymbol || !(targetSymbol in responseBody)) {
return null;
}
const data = responseBody[targetSymbol];
// Check if this is valid quote data (has assetMainType or assetType) and not an error
if (data &&
typeof data === 'object' &&
('assetMainType' in data || 'assetType' in data)) {
return data;
}
return null;
}