@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/rest/endpoints/GetMarketMakerRewardsEpochs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetMarketMakerRewardsEpochs.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetMarketMakerRewardsEpochs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C;;;GAGG;AACH,UAAU,sBAAuB,SAAQ,2BAA2B;IAClE;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,kDACf,SAAQ,sBAAsB;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,+CACf,SAAQ,sBAAsB;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,qCAAqC,GAC7C,+CAA+C,GAC/C,kDAAkD,CAAC;AAEvD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,sCAAsC;CAAG;AAE1D;;;GAGG;AACH,UAAU,iCAAiC;IACzC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,oCAAoC,EAAE,MAAM,CAAC;IAC7C;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IACtC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;;;;OAQG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,0CACf,SAAQ,iCAAiC;IACzC,gBAAgB,CAAC,EAAE,SAAS,CAAC;IAC7B,mBAAmB,CAAC,EAAE,SAAS,CAAC;IAChC,yBAAyB,CAAC,EAAE,SAAS,CAAC;IACtC,8BAA8B,CAAC,EAAE,SAAS,CAAC;IAC3C,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAClC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,uCACf,SAAQ,iCAAiC;IACzC,kBAAkB;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB;IAClB,yBAAyB,EAAE,MAAM,CAAC;IAClC,kBAAkB;IAClB,8BAA8B,EAAE,MAAM,CAAC;IACvC,kBAAkB;IAClB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB;IAClB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,6BAA6B,GACrC,uCAAuC,GACvC,0CAA0C,CAAC;AAE/C;;;;;;;;;;;;;;;GAeG;AACH,UAAU,2BAA2B;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;;;;;OASG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C;;;;;OAKG;IACH,4CAA4C,CAAC,EAAE,MAAM,CAAC;IACtD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;OAOG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;;;;OAQG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,6BAA6B,EAAE,CAAC;CAC3C;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yCAAyC,GAAG,MAAM,CAC5D,IAAI,CACF,2BAA2B,EAC3B,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,cAAc,CACnD,CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,4CACf,SAAQ,2BAA2B;IACnC,kBAAkB;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,OAAO,EAAE,0CAA0C,EAAE,CAAC;IAItD,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC,yBAAyB,CAAC,EAAE,SAAS,CAAC;IACtC,8BAA8B,CAAC,EAAE,SAAS,CAAC;CAC5C;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,yCACf,SAAQ,2BAA2B;IACnC,kBAAkB;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB;IAClB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB;IAClB,yBAAyB,EAAE,MAAM,CAAC;IAClC,kBAAkB;IAClB,8BAA8B,EAAE,MAAM,CAAC;IACvC,kBAAkB;IAClB,OAAO,EAAE,uCAAuC,EAAE,CAAC;CACpD;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,kCAAkC,GAC1C,4CAA4C,GAC5C,yCAAyC,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,MAAM,sCAAsC,CAChD,WAAW,SACT,qCAAqC,GAAG,qCAAqC,IAE/E,WAAW,SAAS,+CAA+C,GACjE,yCAAyC,GACzC,WAAW,SAAS,kDAAkD,GACtE,4CAA4C,GAC1C,4CAA4C,GAC5C,yCAAyC,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,uCAAuC,GACjD,yCAAyC,EAAE,CAAC"}

package/dist/types/rest/endpoints/GetMarketMakerRewardsEpochs.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/GetMarkets.d.ts

@@ -0,0 +1,161 @@
+import type { MarketStatus, RestRequestByMarketOptional } from '#index';
+/**
+ * GET markets
+ *
+ * @see response {@link RestResponseGetMarkets}
+ * @see type     {@link KatanaPerpsMarket}
+ *
+ * @category KatanaPerps - Get Markets
+ */
+export interface RestRequestGetMarkets extends RestRequestByMarketOptional {
+}
+/**
+ * Katana Perps Market
+ *
+ * @category KatanaPerps - Get Markets
+ * @category KatanaPerps Interfaces
+ */
+export interface KatanaPerpsMarket {
+    /**
+     * Market symbol
+     */
+    market: string;
+    /**
+     * Market type, always `perpetual`
+     */
+    type: 'perpetual';
+    /**
+     * Market trading status
+     *
+     * @see {@link MarketStatus}
+     */
+    status: MarketStatus;
+    /** Base asset symbol */
+    baseAsset: string;
+    /** Quote asset symbol */
+    quoteAsset: string;
+    /**
+     * Minimum quantity increment change in base terms
+     */
+    stepSize: string;
+    /**
+     * Minimum price increment change in quote terms
+     */
+    tickSize: string;
+    /**
+     * Current index price of the market
+     */
+    indexPrice: string;
+    /**
+     * Index price 24 hours ago.
+     *
+     * - For the first 24 hours after the market is created, this value will return `0.00000000`.
+     */
+    indexPrice24h: string;
+    /**
+     * Percent change in index price from 24h ago to current
+     *
+     * - `1.00%` is expressed as `0.01000000`
+     * - For the first 24 hours after the market is created, this value will return `0.00000000`.
+     */
+    indexPricePercentChange: string;
+    /**
+     * Funding rate of the last payment
+     *
+     * - `1.00%` is expressed as `0.01000000`
+     */
+    lastFundingRate: string | null;
+    /**
+     * Current funding rate
+     *
+     * - `1.00%` is expressed as `0.01000000`
+     */
+    currentFundingRate: string | null;
+    /**
+     * Time of the next funding payment
+     */
+    nextFundingTime: number;
+    /**
+     * Minimum size of an order that can rest on the order book in base terms
+     */
+    makerOrderMinimum: string;
+    /**
+     * Minimum order size that is accepted by the matching engine for execution in base terms
+     */
+    takerOrderMinimum: string;
+    /**
+     * Execution price limit for market orders on the market.
+     */
+    marketOrderExecutionPriceLimit: string;
+    /**
+     * Execution price limit for limit orders on the market.
+     */
+    limitOrderExecutionPriceLimit: string;
+    /** Minimum position size in base terms */
+    minimumPositionSize: string;
+    /** Maximum position size in base terms */
+    maximumPositionSize: string;
+    /** Margin requirement to open a position expressed as a fraction */
+    initialMarginFraction: string;
+    /** Margin requirement prevent liquidation expressed as a fraction */
+    maintenanceMarginFraction: string;
+    /**
+     * Maximum position size available under the {@link initialMarginFraction}
+     */
+    basePositionSize: string;
+    /**
+     * If a position exceeds {@link basePositionSize}, each
+     * step of {@link incrementalPositionSize} increases
+     * the {@link initialMarginFraction} by
+     * {@link incrementalInitialMarginFraction}
+     */
+    incrementalPositionSize: string;
+    /**
+     * - If a position exceeds {@link basePositionSize}
+     *   - for each step of {@link incrementalPositionSize}
+     *     - increases the {@link initialMarginFraction} by {@link incrementalInitialMarginFraction} (this value)
+     */
+    incrementalInitialMarginFraction: string;
+    /**
+     * Default maker trade fee rate for the market
+     *
+     * - Overrides the "Get Exchange" endpoint's `defaultMakerFeeRate`
+     * - May be overidden by the wallet's `makerFeeRate`
+     * - Effective fee rate will be the lowest of the three
+     */
+    makerFeeRate: string;
+    /**
+     * Default taker trade fee rate for the market
+     *
+     * - Overrides the "Get Exchange" endpoint's `defaultTakerFeeRate`
+     * - May be overidden by the "Get Wallets" endpoint's `takerFeeRate`
+     * - Effective fee rate will be the lowest of the three
+     */
+    takerFeeRate: string;
+    /** Trailing 24h volume for the market in USD */
+    volume24h: string;
+    /** Number of trade executions in the market in the trailing 24h */
+    trades24h: number;
+    /** Open interest quantity in base terms */
+    openInterest: string;
+    /**
+     * - Indicates if the market is featured on the trading markets listing
+     *
+     * @internal
+     */
+    featured?: true;
+    /**
+     * - Indicates if this is the default market when loading the exchange.
+     *
+     * @internal
+     */
+    default?: true;
+}
+/**
+ * @see type {@link KatanaPerpsMarket}
+ * @see request {@link RestRequestGetMarkets}
+ *
+ * @category KatanaPerps - Get Markets
+ */
+export type RestResponseGetMarkets = KatanaPerpsMarket[];
+//# sourceMappingURL=GetMarkets.d.ts.map

package/dist/types/rest/endpoints/GetMarkets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetMarkets.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetMarkets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,2BAA2B,EAAE,MAAM,QAAQ,CAAC;AAExE;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;CAAG;AAE7E;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;;;OAIG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,8BAA8B,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IACtC,0CAA0C;IAC1C,mBAAmB,EAAE,MAAM,CAAC;IAC5B,0CAA0C;IAC1C,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oEAAoE;IACpE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,qEAAqE;IACrE,yBAAyB,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,gCAAgC,EAAE,MAAM,CAAC;IACzC;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,EAAE,CAAC"}

package/dist/types/rest/endpoints/GetMarkets.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/GetOrderBook.d.ts

@@ -0,0 +1,176 @@
+import type { RestRequestByMarket, RestRequestPagination } from '#index';
+/**
+ * OrderBookPriceLevel
+ *
+ * - `price` and `size` as decimal strings
+ * - `totalOrders` = # of limit orders at this price level (0 for synthetic levels)
+ *
+ * @example
+ * ```typescript
+ *  [ "202.01000000", "8.11400000", 0 ]
+ * ```
+ *
+ * @category KatanaPerps - Get OrderBook
+ */
+export type OrderBookPriceLevel = [
+    price: string,
+    size: string,
+    totalOrders: number
+];
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * @category Base Types
+ */
+export interface GetOrderBookBase extends RestRequestByMarket {
+    /**
+     * Level of order book, `1` or `2`.
+     *
+     * @defaultValue `1`
+     */
+    level?: 1 | 2;
+}
+/**
+ * GET Order Books
+ *
+ * @see related {@link OrderBookPriceLevel} (bids/asks)
+ * @see level 1 - request  - {@link RestRequestGetOrderBookLevel1}
+ * @see level 1 - response - {@link RestResponseGetOrderBookLevel1}
+ * @see level 2 - request  - {@link RestRequestGetOrderBookLevel2}
+ * @see level 2 - response - {@link RestResponseGetOrderBookLevel2}
+ *
+ * @category KatanaPerps - Get OrderBook
+ */
+export interface RestRequestGetOrderBookLevel1 extends GetOrderBookBase {
+    /**
+     * - Not required & ignored when using the Katana Perps SDK, and is already defaulted
+     *   to level 1 when using the REST API.
+     *
+     * @inheritDoc
+     */
+    level?: 1;
+}
+/**
+ * GET Order Books
+ *
+ * @see related {@link OrderBookPriceLevel} (bids/asks)
+ * @see level 1 - request  - {@link RestRequestGetOrderBookLevel1}
+ * @see level 1 - response - {@link RestResponseGetOrderBookLevel1}
+ * @see level 2 - request  - {@link RestRequestGetOrderBookLevel2}
+ * @see level 2 - response - {@link RestResponseGetOrderBookLevel2}
+ *
+ * @category KatanaPerps - Get OrderBook
+ */
+export interface RestRequestGetOrderBookLevel2 extends GetOrderBookBase, Pick<RestRequestPagination, 'limit'> {
+    /**
+     * - Not required & ignored when using the Katana Perps SDK, but required when using the REST API directly
+     *   as it normally will default to level 1.
+     *
+     * @inheritDoc
+     */
+    level?: 2;
+    /**
+     * - Number of `bids` and `asks` to return, only applicable for `level: 2` data.
+     * - `0` returns maximum of `500` price levels per side
+     *
+     * @inheritDoc
+     * @defaultValue 50
+     */
+    limit?: number;
+}
+/**
+ * The Base OrderBook response which matches both level 1 and level 2 orderbook
+ * responses.
+ *
+ * @see related {@link OrderBookPriceLevel} (bids/asks)
+ * @see level 1 - request  - {@link RestRequestGetOrderBookLevel1}
+ * @see level 1 - response - {@link RestResponseGetOrderBookLevel1}
+ * @see level 2 - request  - {@link RestRequestGetOrderBookLevel2}
+ * @see level 2 - response - {@link RestResponseGetOrderBookLevel2}
+ *
+ * @category KatanaPerps - Get OrderBook
+ * @category KatanaPerps Interfaces
+ */
+export interface KatanaPerpsOrderBook {
+    /**
+     * Most recent order book update sequence number reflected in the returned snapshot
+     */
+    sequence: number;
+    /**
+     * Price of the last trade in quote terms
+     */
+    lastPrice: string | null;
+    /**
+     * Mark price
+     */
+    markPrice: string | null;
+    /**
+     * Index price
+     */
+    indexPrice: string | null;
+    /**
+     * One or more bids depending on the Orderbook Level
+     *
+     * @see type {@link OrderBookPriceLevel}
+     */
+    bids: OrderBookPriceLevel[];
+    /**
+     * One or more asks depending on the Orderbook Level
+     *
+     * @see type {@link OrderBookPriceLevel}
+     */
+    asks: OrderBookPriceLevel[];
+}
+/**
+ * Level-1 order book data is limited to the best bid and ask for a market, including hybrid liquidity synthetic price levels.
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#get-order-books)
+ * @see related {@link OrderBookPriceLevel} (bids/asks)
+ * @see type {@link KatanaPerpsOrderBook}
+ * @see level 1 - request  - {@link RestRequestGetOrderBookLevel1}
+ * @see level 1 - response - {@link RestResponseGetOrderBookLevel1}
+ * @see level 2 - request  - {@link RestRequestGetOrderBookLevel2}
+ * @see level 2 - response - {@link RestResponseGetOrderBookLevel2}
+ *
+ * @category KatanaPerps - Get OrderBook
+ */
+export interface RestResponseGetOrderBookLevel1 extends KatanaPerpsOrderBook {
+    /**
+     * - Level-1 order book data is limited to the best bid and ask for a market
+     * @inheritDoc
+     */
+    bids: [OrderBookPriceLevel] | [];
+    /**
+     * - Level-1 order book data is limited to the best bid and ask for a market
+     * @inheritDoc
+     */
+    asks: [OrderBookPriceLevel] | [];
+}
+/**
+ * Level-2 order book data includes price and quantity information for all price levels in the order book.
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#get-order-books)
+ * @see type {@link KatanaPerpsOrderBook}
+ * @see related {@link OrderBookPriceLevel} (bids/asks)
+ * @see level 1 - request  - {@link RestRequestGetOrderBookLevel1}
+ * @see level 1 - response - {@link RestResponseGetOrderBookLevel1}
+ * @see level 2 - request  - {@link RestRequestGetOrderBookLevel2}
+ * @see level 2 - response - {@link RestResponseGetOrderBookLevel2}
+ *
+ * @category KatanaPerps - Get OrderBook
+ */
+export interface RestResponseGetOrderBookLevel2 extends KatanaPerpsOrderBook {
+    /**
+     * - Level-2 order book data includes price and quantity information for all price levels in the order book.
+     * @inheritDoc
+     */
+    bids: OrderBookPriceLevel[];
+    /**
+     * - Level-2 order book data includes price and quantity information for all price levels in the order book.
+     * @inheritDoc
+     */
+    asks: OrderBookPriceLevel[];
+}
+//# sourceMappingURL=GetOrderBook.d.ts.map

package/dist/types/rest/endpoints/GetOrderBook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetOrderBook.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetOrderBook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAC;AAEzE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM;IACb,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,MAAM;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;CACf;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC;CACX;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,6BACf,SAAQ,gBAAgB,EACtB,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC;IACtC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC;IACV;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;;OAIG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;IAC5B;;;;OAIG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IAC1E;;;OAGG;IACH,IAAI,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC;IACjC;;;OAGG;IACH,IAAI,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IAC1E;;;OAGG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;IAC5B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;CAC7B"}

package/dist/types/rest/endpoints/GetOrderBook.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/GetOrders.d.ts

@@ -0,0 +1,188 @@
+import type { OrderStatus, OrderType, OrderSide, TimeInForce, SelfTradePrevention, TriggerType, RestRequestByWallet, RestRequestPaginationWithFromId, KatanaPerpsOrderFill, RestRequestByMarketOptional } from '#index';
+/**
+ * Request parameters for making a request to get a single order from the API.
+ *
+ * @see request {@link _RestAuthenticatedClient.getOrder RestAuthenticatedClient.getOrder}
+ *
+ * @category KatanaPerps - Get Orders
+ */
+export interface RestRequestGetOrder extends RestRequestByWallet {
+    /**
+     * Single orderId or clientOrderId to cancel; prefix client-provided ids with client:
+     */
+    orderId: `client:${string}` | string;
+}
+/**
+ * Request parameters for getting multiple matching orders based on the provided parameters.
+ *
+ * @see request {@link _RestAuthenticatedClient.getOrders RestAuthenticatedClient.getOrders}
+ *
+ * @category KatanaPerps - Get Orders
+ */
+export interface RestRequestGetOrders extends RestRequestByWallet, RestRequestPaginationWithFromId, RestRequestByMarketOptional {
+    /**
+     * - only applies if `orderId` is absent
+     * - `false` only returns active orders on the order book
+     * - `true` only returns orders that are no longer on the order book and resulted in at least one fill
+     */
+    closed?: boolean;
+    orderId?: undefined;
+}
+/**
+ * The standard order object.
+ *
+ * @category KatanaPerps - Get Orders
+ * @category KatanaPerps Interfaces
+ */
+export interface KatanaPerpsOrder {
+    /** Market symbol as base-quote pair e.g. 'ETH-USD' */
+    market: string;
+    /** Exchange-assigned order identifier */
+    orderId: string;
+    /** Client-specified order identifier (if provided) */
+    clientOrderId?: string;
+    /** Address of the wallet which placed the order */
+    wallet: string;
+    /** Timestamp of initial order processing by the matching engine */
+    time: number;
+    /**
+     * Current order status
+     *
+     * @see enum {@link OrderStatus}
+     */
+    status: OrderStatus;
+    /**
+     * Error short code explaining forced cancelation condition
+     */
+    errorCode?: string;
+    /**
+     * Error description explaining forced cancelation condition
+     */
+    errorMessage?: string;
+    /**
+     * OrderType
+     *
+     * @see enum {@link OrderType}
+     */
+    type: OrderType;
+    /**
+     * Order side, {@link OrderSide.buy buy} or {@link OrderSide.sell sell}
+     *
+     * @see enum {@link OrderSide}
+     */
+    side: OrderSide;
+    /** Original quantity specified by the order in base terms */
+    originalQuantity: string;
+    /** Quantity that has been executed in base terms */
+    executedQuantity: string;
+    /**
+     * Cumulative quantity that has been spent (buy orders) or received (sell orders) in quote terms.
+     */
+    cumulativeQuoteQuantity: string;
+    /**
+     * Weighted average price of fills associated with the order; only present with fills
+     */
+    avgExecutionPrice?: string;
+    /**
+     * Original price specified by the order in quote terms, omitted for all market orders
+     */
+    price?: string;
+    /**
+     * - Only allowed for certain order types mentioned below, omitted otherwise.
+     *
+     * Stop loss or take profit price for order types:
+     *
+     * - {@link OrderType.stopLossMarket stopLossMarket}
+     * - {@link OrderType.stopLossLimit stopLossLimit}
+     * - {@link OrderType.takeProfitMarket takeProfitMarket}
+     * - {@link OrderType.takeProfitLimit takeProfitLimit}
+     *
+     * Activation price for order types:
+     *
+     * - {@link OrderType.trailingStopMarket trailingStopMarket}
+     */
+    triggerPrice?: string;
+    /**
+     * Price type for {@link triggerPrice}, last or index, only present when {@link triggerPrice} is defined
+     *
+     * @see enum {@link TriggerType}
+     */
+    triggerType?: Exclude<TriggerType, 'none'>;
+    /**
+     * **Internal:** Not yet available in production APIs.
+     *
+     * - Only applicable when {@link type} is {@link OrderType.trailingStopMarket trailingStopMarket}.
+     *
+     * @alpha
+     * @internal
+     */
+    callbackRate?: string;
+    /**
+     * **Internal:** Not yet available in production APIs.
+     *
+     * - Only applicable to stop {@link OrderType order types}:
+     *   - {@link OrderType.stopLossMarket stopLossMarket}
+     *   - {@link OrderType.stopLossLimit stopLossLimit}
+     *   - {@link OrderType.takeProfitMarket takeProfitMarket}
+     *   - {@link OrderType.trailingStopMarket trailingStopMarket}
+     * - Indicates an {@link orderId} of an open {@link OrderType.limit limit} order
+     *   by the same wallet in the same market that must be filled before the stop becomes active.
+     * - Canceling the conditional order also cancels the stop order.
+     *
+     * @alpha
+     * @internal
+     */
+    conditionalOrderId?: string;
+    /**
+     * Reduce only orders are only accepted opposite open positions and only reduce an opposite position’s size
+     */
+    reduceOnly: boolean;
+    /**
+     * @see enum {@link TimeInForce}
+     */
+    timeInForce?: TimeInForce;
+    /**
+     * Self-trade prevention policy
+     *
+     * @see [API Documentation](https://api-docs-v1-perps.katana.network/#self-trade-prevention)
+     * @see enum {@link SelfTradePrevention}
+     */
+    selfTradePrevention: SelfTradePrevention;
+    /**
+     * Delegated key, if present
+     *
+     * @internal
+     */
+    delegatedKey?: string;
+    /**
+     * Array of order fill objects
+     */
+    fills?: KatanaPerpsOrderFill[];
+    /**
+     * - When `true`, the order is a liquidation acquisition only order.
+     * - These will not be included in get orders unless the request includes `isLiquidationAcquisitionOnly`
+     *
+     * @internal
+     */
+    isLiquidationAcquisitionOnly?: true | undefined;
+}
+type ConditionalOrdersMixin = {
+    conditionalTakeProfitOrder?: KatanaPerpsOrder & {
+        type: typeof OrderType.takeProfitMarket;
+    };
+    conditionalStopLossOrder?: KatanaPerpsOrder & {
+        type: typeof OrderType.stopLossMarket;
+    };
+};
+/**
+ * @see type {@link KatanaPerpsOrder}
+ * @category KatanaPerps - Get Orders
+ */
+export type RestResponseGetOrder = KatanaPerpsOrder & ConditionalOrdersMixin;
+/**
+ * @see type {@link KatanaPerpsOrder}
+ * @category KatanaPerps - Get Orders
+ */
+export type RestResponseGetOrders = (KatanaPerpsOrder & ConditionalOrdersMixin)[];
+export {};
+//# sourceMappingURL=GetOrders.d.ts.map

package/dist/types/rest/endpoints/GetOrders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetOrders.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,2BAA2B,EAE5B,MAAM,QAAQ,CAAC;AAEhB;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,OAAO,EAAE,UAAU,MAAM,EAAE,GAAG,MAAM,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBACf,SAAQ,mBAAmB,EACzB,+BAA+B,EAC/B,2BAA2B;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,EAAE,WAAW,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB,6DAA6D;IAC7D,gBAAgB,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC3C;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;;;OAKG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IACzC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAE/B;;;;;OAKG;IACH,4BAA4B,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACjD;AAED,KAAK,sBAAsB,GAAG;IAC5B,0BAA0B,CAAC,EAAE,gBAAgB,GAAG;QAC9C,IAAI,EAAE,OAAO,SAAS,CAAC,gBAAgB,CAAC;KACzC,CAAC;IACF,wBAAwB,CAAC,EAAE,gBAAgB,GAAG;QAC5C,IAAI,EAAE,OAAO,SAAS,CAAC,cAAc,CAAC;KACvC,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,sBAAsB,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,gBAAgB,GACnD,sBAAsB,CAAC,EAAE,CAAC"}

package/dist/types/rest/endpoints/GetOrders.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/GetPing.d.ts

@@ -0,0 +1,8 @@
+import type { EmptyObj } from '#types/utils';
+/**
+ * Ping `/v1/time` Response
+ *
+ * @category KatanaPerps - Get Ping
+ */
+export type RestResponseGetPing = EmptyObj;
+//# sourceMappingURL=GetPing.d.ts.map

package/dist/types/rest/endpoints/GetPing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetPing.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetPing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC"}

package/dist/types/rest/endpoints/GetPing.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/GetPositions.d.ts

@@ -0,0 +1,104 @@
+import type { RestRequestByMarketOptional, RestRequestByWallet } from '#index';
+/**
+ * Get Positions
+ *
+ * @see response {@link RestResponseGetPositions}
+ * @see type {@link KatanaPerpsPosition}
+ * @category KatanaPerps - Get Positions
+ */
+export interface RestRequestGetPositions extends RestRequestByWallet, RestRequestByMarketOptional {
+}
+/**
+ * @see request {@link RestRequestGetPositions}
+ * @see response {@link RestResponseGetPositions}
+ * @category KatanaPerps Interfaces
+ * @category KatanaPerps - Get Positions
+ */
+export interface KatanaPerpsPosition {
+    /**
+     * Market symbol for the item
+     */
+    market: string;
+    /**
+     * Base quantity, negative for short positions
+     */
+    quantity: string;
+    /**
+     * Maximum absolute quantity of the position during its existence
+     */
+    maximumQuantity: string;
+    /**
+     * Average entry price of the position
+     */
+    entryPrice: string;
+    /**
+     * Average exit price of the position
+     */
+    exitPrice: string;
+    /**
+     * Current mark price of the market
+     */
+    markPrice: string;
+    /**
+     * Current index price of the market
+     */
+    indexPrice: string;
+    /**
+     * Index price beyond which the position will be liquidated
+     */
+    liquidationPrice: string;
+    /**
+     * Position value at mark price
+     */
+    value: string;
+    /**
+     * Realized PnL of the position in quote terms, including funding payments
+     */
+    realizedPnL: string;
+    /**
+     * Unrealized PnL of the position in quote terms at the mark price
+     */
+    unrealizedPnL: string;
+    /**
+     * Current initial margin requirement of the position
+     */
+    marginRequirement: string;
+    /**
+     * Cross-margined position leverage
+     */
+    leverage: string;
+    /** Net total of all funding payments for the position */
+    totalFunding: string;
+    /**
+     * Total of all trade quantities that increased the position in base terms
+     */
+    totalOpen: string;
+    /**
+     * Total of all trade quantities that decreased the position in base terms
+     */
+    totalClose: string;
+    /**
+     * Position ADL risk, 0-5 (5 is highest risk)
+     */
+    adlQuintile: number;
+    /**
+     * Id of the fill that opened the position
+     */
+    openedByFillId: string;
+    /**
+     * Id of the fill that most recently updated the position
+     */
+    lastFillId: string;
+    /**
+     * The timestamp indicating when the item was created.
+     */
+    time: number;
+}
+/**
+ * @see type {@link KatanaPerpsPosition}
+ * @see request {@link RestRequestGetPositions}
+ *
+ * @category KatanaPerps - Get Positions
+ */
+export type RestResponseGetPositions = KatanaPerpsPosition[];
+//# sourceMappingURL=GetPositions.d.ts.map