Registry / finance / nest-wrapper-kiwoom

nest-wrapper-kiwoom

library0.117.0jsnpmunverified

A NestJS module wrapper for Kiwoom Securities (키움증권) REST API. Version 0.117.0 provides easy integration with NestJS's module system and dependency injection. It supports account management, short selling, institutional/foreign investor data, stock lending, rankings, market prices, credit orders, sectors, stock info, charts, themes, ELW, and ETF. Data is fetched via API calls with TypeScript type definitions and error handling. This module is specifically targeted at Korean developers using Kiwoom's REST API and is not a general-purpose library. Releases are ongoing with future plans for real-time quotes and order placement.

finance

npm install nest-wrapper-kiwoom

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NEST-WRAPPER-KIWOO

nest-wrapper-kiwoom

financejavascriptv0.117.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

KiwoomModule

✓ import { KiwoomModule } from 'nest-wrapper-kiwoom'

✗ const { KiwoomModule } = require('nest-wrapper-kiwoom')

ESM syntax is preferred; CJS require may work but TypeScript targets prefer ESM.

KiwoomService

✓ import { KiwoomService } from 'nest-wrapper-kiwoom'

Named export; used as a provider in NestJS modules.

KiwoomConfig

✓ import { KiwoomConfig } from 'nest-wrapper-kiwoom'

TypeScript interface for configuration, typically used for dependency injection.

Registers the KiwoomModule asynchronously using NestJS ConfigModule for secure API key handling.

import { Module } from '@nestjs/common'; import { KiwoomModule } from 'nest-wrapper-kiwoom'; import { ConfigModule, ConfigService } from '@nestjs/config'; @Module({ imports: [ ConfigModule.forRoot({ envFilePath: '.env', }), KiwoomModule.forRootAsync({ imports: [ConfigModule], inject: [ConfigService], useFactory: async (configService: ConfigService) => ({ apiKey: configService.get<string>('KIWOOM_API_KEY') ?? '', secretKey: configService.get<string>('KIWOOM_SECRET_KEY') ?? '', }), }), ], }) export class AppModule {}

Debug

Known issues

gotchaReal-time quotes and order placement are not yet implemented; marked as 'coming soon' in the README.

fix

Use only for historical data and account information for now. Monitor package updates for real-time features.

affects: 0.117.0

gotchaThis package is specifically for Kiwoom Securities (키움증권) REST API; it will not work with other brokers.

fix

Ensure you have a Kiwoom account and API credentials.

affects: all

gotchaThe package does not include the '키움 REST API 문서.xlsx' spreadsheet referenced in the README; you must obtain it separately from Kiwoom.

fix

Download the API documentation from Kiwoom's open API center.

affects: all

deprecatedPotential TypeScript typing issues due to rapid development; some endpoints may lack complete type definitions.

fix

Use 'as any' as fallback or contribute types to the package.

affects: >=0.100.0

Errors

Common errors & fixes

Cannot find module 'nest-wrapper-kiwoom' or its corresponding type declarations.

Package may not be fully installed or TypeScript compiler is not resolving module types.

fix

Run 'npm install nest-wrapper-kiwoom' and ensure 'tsconfig.json' includes 'node_modules' in type roots.

TypeError: KiwoomModule.forRootAsync is not a function

Attempting to use an asynchronous initialization pattern when the module may only support synchronous configuration.

fix

Check the documentation: use 'KiwoomModule.forRoot({ apiKey, secretKey })' synchronously if forRootAsync is not exported.

Error: API key or secret key missing

Environment variables not loaded correctly or not provided.

fix

Set 'KIWOOM_API_KEY' and 'KIWOOM_SECRET_KEY' in your .env file or pass them directly.

Upgrade

Version history

0.117.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

35 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/gong-yeongbin/nest-wrapper-kiwoom ↗

packagenest-wrapper-kiwoom ↗

homepagehttps://github.com/gong-yeongbin/nest-wrapper-kiwoom ↗