@upbit-official/upbit-sdk 0.9.0

package/resources/api-keys.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-keys.d.mts","sourceRoot":"","sources":["../src/resources/api-keys.ts"],"names":[],"mappings":"OACO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG/D;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAElF,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,sBAAsB;QACrC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}

package/resources/api-keys.d.ts

@@ -0,0 +1,33 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class APIKeys extends APIResource {
+    /**
+     * List API Keys
+     *
+     * GET /v1/api_keys
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-api-keys
+     * - docs(global): https://global-docs.upbit.com/reference/list-api-keys
+     */
+    list(options?: RequestOptions): APIPromise<APIKeyListResponse>;
+}
+export type APIKeyListResponse = Array<APIKeyListResponse.APIKeyListResponseItem>;
+export declare namespace APIKeyListResponse {
+    interface APIKeyListResponseItem {
+        /**
+         * Access key of the API key.
+         */
+        access_key: string;
+        /**
+         * Expiration timestamp of the access key.
+         *
+         * [Format] yyyy-MM-dd'T'HH:mm:ss+09:00
+         */
+        expire_at: string;
+    }
+}
+export declare namespace APIKeys {
+    export { type APIKeyListResponse as APIKeyListResponse };
+}
+//# sourceMappingURL=api-keys.d.ts.map

package/resources/api-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../src/resources/api-keys.ts"],"names":[],"mappings":"OACO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG/D;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAElF,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,sBAAsB;QACrC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}

package/resources/api-keys.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIKeys = void 0;
+const resource_1 = require("../core/resource.js");
+class APIKeys extends resource_1.APIResource {
+    /**
+     * List API Keys
+     *
+     * GET /v1/api_keys
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-api-keys
+     * - docs(global): https://global-docs.upbit.com/reference/list-api-keys
+     */
+    list(options) {
+        return this._client.get('/v1/api_keys', options);
+    }
+}
+exports.APIKeys = APIKeys;
+//# sourceMappingURL=api-keys.js.map

package/resources/api-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../src/resources/api-keys.ts"],"names":[],"mappings":";;;AACA,kDAA+C;AAI/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF;AAZD,0BAYC"}

package/resources/api-keys.mjs

@@ -0,0 +1,15 @@
+import { APIResource } from "../core/resource.mjs";
+export class APIKeys extends APIResource {
+    /**
+     * List API Keys
+     *
+     * GET /v1/api_keys
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-api-keys
+     * - docs(global): https://global-docs.upbit.com/reference/list-api-keys
+     */
+    list(options) {
+        return this._client.get('/v1/api_keys', options);
+    }
+}
+//# sourceMappingURL=api-keys.mjs.map

package/resources/api-keys.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-keys.mjs","sourceRoot":"","sources":["../src/resources/api-keys.ts"],"names":[],"mappings":"OACO,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF"}

package/resources/candles.d.mts

@@ -0,0 +1,310 @@
+import { APIResource } from "../core/resource.mjs";
+import * as CandlesAPI from "./candles.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Candles extends APIResource {
+    /**
+     * List Day Candles
+     *
+     * GET /v1/candles/days
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-days
+     * - docs(global): https://global-docs.upbit.com/reference/list-candles-days
+     *
+     * @example
+     * ```ts
+     * const response = await client.candles.listDays({
+     *   market: 'KRW-BTC',
+     * });
+     * ```
+     */
+    listDays(query: CandleListDaysParams, options?: RequestOptions): APIPromise<CandleListDaysResponse>;
+    /**
+     * List Minute Candles
+     *
+     * GET /v1/candles/minutes/{unit}
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-minutes
+     * - docs(global): https://global-docs.upbit.com/reference/list-candles-minutes
+     *
+     * @example
+     * ```ts
+     * const candles = await client.candles.listMinutes(15, {
+     *   market: 'KRW-BTC',
+     * });
+     * ```
+     */
+    listMinutes(unit: 1 | 3 | 5 | 10 | 15 | 30 | 60 | 240, query: CandleListMinutesParams, options?: RequestOptions): APIPromise<CandleListMinutesResponse>;
+    /**
+     * List Month Candles
+     *
+     * GET /v1/candles/months
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-months
+     * - docs(global): https://global-docs.upbit.com/reference/list-candles-months
+     *
+     * @example
+     * ```ts
+     * const candlePeriods = await client.candles.listMonths({
+     *   market: 'KRW-BTC',
+     * });
+     * ```
+     */
+    listMonths(query: CandleListMonthsParams, options?: RequestOptions): APIPromise<CandleListMonthsResponse>;
+    /**
+     * List Second Candles
+     *
+     * GET /v1/candles/seconds
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-seconds
+     * - docs(global): https://global-docs.upbit.com/reference/list-candles-seconds
+     *
+     * @example
+     * ```ts
+     * const candles = await client.candles.listSeconds({
+     *   market: 'KRW-BTC',
+     * });
+     * ```
+     */
+    listSeconds(query: CandleListSecondsParams, options?: RequestOptions): APIPromise<CandleListSecondsResponse>;
+    /**
+     * List Week Candles
+     *
+     * GET /v1/candles/weeks
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-weeks
+     * - docs(global): https://global-docs.upbit.com/reference/list-candles-weeks
+     *
+     * @example
+     * ```ts
+     * const candlePeriods = await client.candles.listWeeks({
+     *   market: 'KRW-BTC',
+     * });
+     * ```
+     */
+    listWeeks(query: CandleListWeeksParams, options?: RequestOptions): APIPromise<CandleListWeeksResponse>;
+    /**
+     * List Year Candles
+     *
+     * GET /v1/candles/years
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-years
+     * - docs(global): https://global-docs.upbit.com/reference/list-candles-years
+     *
+     * @example
+     * ```ts
+     * const candlePeriods = await client.candles.listYears({
+     *   market: 'KRW-BTC',
+     * });
+     * ```
+     */
+    listYears(query: CandleListYearsParams, options?: RequestOptions): APIPromise<CandleListYearsResponse>;
+}
+export interface Candle {
+    /**
+     * The total trade amount (in the quoted currency) accumulated during the candle
+     * period.
+     */
+    candle_acc_trade_price: string;
+    /**
+     * The total traded volume (in the base asset) accumulated during the candle
+     * period.
+     */
+    candle_acc_trade_volume: string;
+    /**
+     * Start time of the candle period in KST. Supported in KOREA only.
+     *
+     * [Format]: yyyy-MM-dd'T'HH:mm:ss
+     */
+    candle_date_time_kst: string;
+    /**
+     * Start time of the candle period in UTC.
+     *
+     * [Format]: yyyy-MM-dd'T'HH:mm:ss
+     */
+    candle_date_time_utc: string;
+    /**
+     * The highest trading price, recorded during the candle period.
+     */
+    high_price: string;
+    /**
+     * The lowest trading price. recorded during the candle period.
+     */
+    low_price: string;
+    /**
+     * Trading pair code representing the market.
+     *
+     * [Example]: "SGD-BTC"
+     */
+    market: string;
+    /**
+     * The opening price of the candle, representing the first trading price during the
+     * candle period.
+     */
+    opening_price: string;
+    /**
+     * The timestamp (in milliseconds) when the last tick of the candle was recorded.
+     */
+    timestamp: number;
+    /**
+     * The closing price of the candle, representing the last trading price during the
+     * candle period.
+     */
+    trade_price: string;
+}
+export interface CandlePeriod extends Candle {
+    /**
+     * Start date of candle aggregation period (yyyy-MM-dd).
+     */
+    first_day_of_period: string;
+}
+export type CandleListDaysResponse = Array<CandleListDaysResponse.CandleListDaysResponseItem>;
+export declare namespace CandleListDaysResponse {
+    interface CandleListDaysResponseItem extends CandlesAPI.Candle {
+        /**
+         * Price change = trade_price - prev_closing_price.
+         */
+        change_price: string;
+        /**
+         * Change rate = (trade_price - prev_closing_price) / prev_closing_price.
+         */
+        change_rate: string;
+        /**
+         * Previous day's closing price (UTC-based).
+         */
+        prev_closing_price: string;
+        /**
+         * Closing price converted per converting_price_unit. Null for non-digital asset
+         * markets.
+         */
+        converted_trade_price?: string;
+    }
+}
+export type CandleListMinutesResponse = Array<Candle>;
+export type CandleListMonthsResponse = Array<CandlePeriod>;
+export type CandleListSecondsResponse = Array<Candle>;
+export type CandleListWeeksResponse = Array<CandlePeriod>;
+export type CandleListYearsResponse = Array<CandlePeriod>;
+export interface CandleListDaysParams {
+    /**
+     * Trading pair code to query.
+     */
+    market: string;
+    /**
+     * Currency to convert the closing price into. When specified, the response
+     * includes a "converted_trade_price" field with the closing price converted to the
+     * given currency.
+     *
+     * [Example] Specifying "KRW" returns the closing price converted to KRW.
+     */
+    converting_price_unit?: string;
+    /**
+     * Number of candles to retrieve.
+     *
+     * Up to 200 candles are supported. Default: 1.
+     */
+    count?: number;
+    /**
+     * End time of the query range. Retrieves candles before the specified time. If not
+     * specified, the most recent candles are returned.
+     *
+     * Accepts ISO 8601 datetime format.
+     */
+    to?: string;
+}
+export interface CandleListMinutesParams {
+    /**
+     * Trading pair code to query.
+     */
+    market: string;
+    /**
+     * Number of candles to retrieve.
+     *
+     * Up to 200 candles are supported. Default: 1.
+     */
+    count?: number;
+    /**
+     * End time of the query range. Retrieves candles before the specified time. If not
+     * specified, the most recent candles are returned.
+     *
+     * Accepts ISO 8601 datetime format.
+     *
+     * [Example] 2025-06-24T04:56:53Z 2025-06-24 04:56:53 2025-06-24T13:56:53+08:00
+     */
+    to?: string;
+}
+export interface CandleListMonthsParams {
+    /**
+     * Trading pair code to query.
+     */
+    market: string;
+    /**
+     * Number of candles to retrieve. Up to 200, default: 1.
+     */
+    count?: number;
+    /**
+     * End time of the query range. If not specified, the most recent candles are
+     * returned.
+     *
+     * Accepts ISO 8601 datetime format.
+     */
+    to?: string;
+}
+export interface CandleListSecondsParams {
+    /**
+     * Trading pair code to query.
+     */
+    market: string;
+    /**
+     * Number of candles to retrieve.
+     *
+     * Up to 200 candles are supported. Default: 1.
+     */
+    count?: number;
+    /**
+     * End time of the query range. Retrieves candles before the specified time. If not
+     * specified, the most recent candles are returned.
+     *
+     * Accepts ISO 8601 datetime format. URL encoding is required for spaces and
+     * special characters.
+     *
+     * [Example] 2025-06-24T04:56:53Z 2025-06-24 04:56:53 2025-06-24T13:56:53+08:00
+     *
+     * Second candles only support data up to 3 months prior. An empty array is
+     * returned for older times.
+     */
+    to?: string;
+}
+export interface CandleListWeeksParams {
+    /**
+     * Trading pair code to query.
+     */
+    market: string;
+    /**
+     * Number of candles to retrieve. Up to 200, default: 1.
+     */
+    count?: number;
+    /**
+     * End time of the query range. Retrieves candles before the specified time. If not
+     * specified, the most recent candles are returned.
+     */
+    to?: string;
+}
+export interface CandleListYearsParams {
+    /**
+     * Trading pair code to query.
+     */
+    market: string;
+    /**
+     * Number of candles to retrieve. Up to 200, default: 1.
+     */
+    count?: number;
+    /**
+     * End time of the query range. ISO 8601 format.
+     */
+    to?: string;
+}
+export declare namespace Candles {
+    export { type Candle as Candle, type CandlePeriod as CandlePeriod, type CandleListDaysResponse as CandleListDaysResponse, type CandleListMinutesResponse as CandleListMinutesResponse, type CandleListMonthsResponse as CandleListMonthsResponse, type CandleListSecondsResponse as CandleListSecondsResponse, type CandleListWeeksResponse as CandleListWeeksResponse, type CandleListYearsResponse as CandleListYearsResponse, type CandleListDaysParams as CandleListDaysParams, type CandleListMinutesParams as CandleListMinutesParams, type CandleListMonthsParams as CandleListMonthsParams, type CandleListSecondsParams as CandleListSecondsParams, type CandleListWeeksParams as CandleListWeeksParams, type CandleListYearsParams as CandleListYearsParams, };
+}
+//# sourceMappingURL=candles.d.mts.map

package/resources/candles.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"candles.d.mts","sourceRoot":"","sources":["../src/resources/candles.ts"],"names":[],"mappings":"OACO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;;;;;;;;;;;;;OAcG;IACH,WAAW,CACT,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,EACzC,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIzG;;;;;;;;;;;;;;OAcG;IACH,WAAW,CACT,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGvG;AAED,MAAM,WAAW,MAAM;IACrB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;AAE9F,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,0BAA2B,SAAQ,UAAU,CAAC,MAAM;QACnE;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;CACF;AAED,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAE3D,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAE1D,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAE1D,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}