Skip to main content

default

Stock Screening Platform - Frontend API v0.1.0

Stock Screening Platform - Frontend API / services/marketService / default

Variable: default

const default: object

Defined in: src/services/marketService.ts:126

Market service object with all API functions

Type Declaration​

getMarketIndices()​

getMarketIndices: () => Promise<MarketIndicesResponse>

Fetch current market indices (KOSPI, KOSDAQ, KRX100)

Returns​

Promise<MarketIndicesResponse>

Promise with market indices data

Throws​

Error if request fails

getMarketBreadth()​

getMarketBreadth: (market) => Promise<MarketBreadth>

Fetch market breadth indicators

Parameters​

market​

MarketType = 'ALL'

Market filter (ALL, KOSPI, KOSDAQ)

Returns​

Promise<MarketBreadth>

Promise with market breadth data

Throws​

Error if request fails

getSectorPerformance()​

getSectorPerformance: (timeframe) => Promise<SectorsPerformanceResponse>

Fetch sector performance data

Parameters​

timeframe​

Timeframe for performance calculation (1D, 1W, 1M, 3M)

"1D" | "1W" | "1M" | "3M"

Returns​

Promise<SectorsPerformanceResponse>

Promise with sector performance data

Throws​

Error if request fails

getMarketMovers()​

getMarketMovers: (market, limit) => Promise<MarketMoversResponse>

Fetch top market movers (gainers and losers)

Parameters​

market​

MarketType = 'ALL'

Market filter (ALL, KOSPI, KOSDAQ)

limit​

number = 10

Number of results per category (default: 10)

Returns​

Promise<MarketMoversResponse>

Promise with market movers data

Throws​

Error if request fails

getMostActive()​

getMostActive: (market, limit) => Promise<MostActiveResponse>

Fetch most active stocks by volume

Parameters​

market​

MarketType = 'ALL'

Market filter (ALL, KOSPI, KOSDAQ)

limit​

number = 20

Number of results (default: 20)

Returns​

Promise<MostActiveResponse>

Promise with most active stocks data

Throws​

Error if request fails

getMarketTrend()​

getMarketTrend: (timeframe, indices) => Promise<MarketTrendResponse>

Fetch historical market trend data

Parameters​

timeframe​

TrendTimeframe = '3M'

Timeframe for historical data (1D, 5D, 1M, 3M, 6M, 1Y)

indices​

string[] = ...

Array of index codes to fetch (default: ['KOSPI', 'KOSDAQ'])

Returns​

Promise<MarketTrendResponse>

Promise with market trend data

Throws​

Error if request fails