@nktkas/hyperliquid/esm/api/info/_methods/settledOutcome.js

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

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { UnsignedInteger } from "../../_schemas.js";
/**
 * Request information about a settled outcome.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-settled-outcome
 */ export const SettledOutcomeRequest = /* @__PURE__ */ (()=>{
  return v.object({
    /** Type of request. */ type: v.literal("settledOutcome"),
    /** Outcome identifier. */ outcome: UnsignedInteger
  });
})();
// ============================================================
// Execution Logic
// ============================================================
import { parse } from "../../../_base.js";
/**
 * Request information about a settled outcome.
 *
 * @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 Information about a settled outcome.
 *
 * @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 { settledOutcome } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await settledOutcome({ transport }, {
 *   outcome: 0,
 * });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-settled-outcome
 */ export function settledOutcome(config, params, signal) {
  const request = parse(SettledOutcomeRequest, {
    type: "settledOutcome",
    ...params
  });
  return config.transport.request("info", request, signal);
}
//# sourceMappingURL=settledOutcome.js.map