UNPKG

@nktkas/hyperliquid

Version:

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

54 lines (53 loc) 2.28 kB
import * as v from "valibot"; // ============================================================ // API Schemas // ============================================================ import { Address, UnsignedInteger } from "../../_schemas.js"; /** * Request user TWAP slice fills by time. * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills */ export const UserTwapSliceFillsByTimeRequest = /* @__PURE__ */ (()=>{ return v.object({ /** Type of request. */ type: v.literal("userTwapSliceFillsByTime"), /** User address. */ user: Address, /** Start time (in ms since epoch). */ startTime: UnsignedInteger, /** End time (in ms since epoch). */ endTime: v.nullish(UnsignedInteger) }); })(); // ============================================================ // Execution Logic // ============================================================ import { parse } from "../../../_base.js"; /** * Request user TWAP slice fills by time. * * @param config General configuration for Info API requests. * @param params Parameters specific to the API request. * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request. * @return Array of user's TWAP slice fill by time. * * @throws {ValidationError} When the request parameters fail validation (before sending). * @throws {TransportError} When the transport layer throws an error. * * @example * ```ts * import { HttpTransport } from "@nktkas/hyperliquid"; * import { userTwapSliceFillsByTime } from "@nktkas/hyperliquid/api/info"; * * const transport = new HttpTransport(); // or `WebSocketTransport` * * const data = await userTwapSliceFillsByTime({ transport }, { * user: "0x...", * startTime: Date.now() - 1000 * 60 * 60 * 24, * }); * ``` * * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills */ export function userTwapSliceFillsByTime(config, params, signal) { const request = parse(UserTwapSliceFillsByTimeRequest, { type: "userTwapSliceFillsByTime", ...params }); return config.transport.request("info", request, signal); } //# sourceMappingURL=userTwapSliceFillsByTime.js.map