Nktkas Hyperliquid

https://nktkas.gitbook.io/hyperliquid
Admin
A TypeScript SDK for the Hyperliquid API that provides type-safe methods for reading data, placing...
Tokens:307,928
Snippets:939
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### ExchangeClient Quick Start

Source: https://nktkas.gitbook.io/hyperliquid/readme.md

Use ExchangeClient to place orders, transfer funds, and manage accounts. This example shows how to place a limit order.

```APIDOC
## ExchangeClient Quick Start

### Description
Place orders, transfer funds, manage accounts.
### Method
N/A (Client Method)
### Endpoint
N/A (Client Method)
### Parameters
N/A
### Request Example
```ts
import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { privateKeyToAccount } from "viem/accounts";

const wallet = privateKeyToAccount("0x...");

const transport = new HttpTransport();
const client = new ExchangeClient({ transport, wallet });

await client.order({
  orders: [{
    a: 0,
    b: true,
    p: "50000",
    s: "0.01",
    r: false,
    t: { limit: { tif: "Gtc" } },
  }],
  grouping: "na",
});
```
### Response
#### Success Response (200)
- **N/A** (N/A) - N/A
#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### SubscriptionClient Quick Start

Source: https://nktkas.gitbook.io/hyperliquid/readme.md

Use SubscriptionClient to receive real-time updates via WebSocket. This example subscribes to all market IDs.

```APIDOC
## SubscriptionClient Quick Start

### Description
Receive real-time updates via WebSocket.
### Method
N/A (Client Method)
### Endpoint
N/A (Client Method)
### Parameters
N/A
### Request Example
```ts
import { SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";

const transport = new WebSocketTransport();
const client = new SubscriptionClient({ transport });

await client.allMids((data) => {
  console.log(data.mids);
});
```
### Response
#### Success Response (200)
- **data** (object) - Real-time data updates
#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### ExplorerClient Quick Start

Source: https://nktkas.gitbook.io/hyperliquid/readme.md

Use ExplorerClient to look up blocks, transactions, and addresses. This example fetches details for a specific block height.

```APIDOC
## ExplorerClient Quick Start

### Description
Look up blocks, transactions, and addresses.
### Method
N/A (Client Method)
### Endpoint
N/A (Client Method)
### Parameters
N/A
### Request Example
```ts
import { ExplorerClient, HttpTransport } from "@nktkas/hyperliquid";

const transport = new HttpTransport();
const client = new ExplorerClient({ transport });

const block = await client.blockDetails({ height: 123 });
```
### Response
#### Success Response (200)
- **block** (object) - Block details
#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### InfoClient Quick Start

Source: https://nktkas.gitbook.io/hyperliquid/readme.md

Use InfoClient to read market data, account state, and order book information. This example demonstrates fetching all market IDs.

```APIDOC
## InfoClient Quick Start

### Description
Read market data, account state, order book.
### Method
N/A (Client Method)
### Endpoint
N/A (Client Method)
### Parameters
N/A
### Request Example
```ts
import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";

const transport = new HttpTransport();
const client = new InfoClient({ transport });

const mids = await client.allMids();
```
### Response
#### Success Response (200)
- **mids** (object) - Market data
#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Install Hyperliquid SDK with Bun

Source: https://nktkas.gitbook.io/hyperliquid

Install the Hyperliquid SDK using Bun.

```bash
bun add @nktkas/hyperliquid
```

--------------------------------

### Install Polyfills for fastAssetCtxs

Source: https://nktkas.gitbook.io/hyperliquid

Install necessary polyfills for `fastAssetCtxs` subscription on environments like Hermes.

```bash
npm i text-encoding-polyfill web-streams-polyfill compression-streams-polyfill
```

--------------------------------

### Install Hyperliquid SDK with npm

Source: https://nktkas.gitbook.io/hyperliquid

Install the Hyperliquid SDK using npm for Node.js environments.

```bash
npm i @nktkas/hyperliquid
```

--------------------------------

### Install URL Polyfill for React Native

Source: https://nktkas.gitbook.io/hyperliquid

Install `react-native-url-polyfill` for React Native versions older than 0.84.

```bash
npm i react-native-url-polyfill
```

--------------------------------

### Quick Start: ExplorerClient

Source: https://nktkas.gitbook.io/hyperliquid

Initialize and use the ExplorerClient to look up blocks, transactions, and addresses.

```typescript
import { ExplorerClient, HttpTransport } from "@nktkas/hyperliquid";

const transport = new HttpTransport();
const client = new ExplorerClient({ transport });

const block = await client.blockDetails({ height: 123 });
```

--------------------------------

### Install Hyperliquid SDK with Deno

Source: https://nktkas.gitbook.io/hyperliquid

Add the Hyperliquid SDK to your Deno project.

```bash
deno add jsr:@nktkas/hyperliquid
```

--------------------------------

### Quick Start: ExchangeClient

Source: https://nktkas.gitbook.io/hyperliquid

Initialize and use the ExchangeClient to place orders, transfer funds, and manage accounts. Requires a wallet.

```typescript
import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { privateKeyToAccount } from "viem/accounts";

const wallet = privateKeyToAccount("0x...");

const transport = new HttpTransport();
const client = new ExchangeClient({ transport, wallet });

await client.order({
  orders: [{
    a: 0,
    b: true,
    p: "50000",
    s: "0.01",
    r: false,
    t: { limit: { tif: "Gtc" } },
  }],
  grouping: "na",
});
```

--------------------------------

### Get User TWAP Slice Fills by Time

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods/usertwapslicefillsbytime.md

This example demonstrates how to fetch user TWAP slice fills within a specified time range. Ensure you have the correct authentication and parameters set.

```javascript
const fills = await hyperliquid.user.userTwapSliceFillsByTime(startTime, endTime);
```

--------------------------------

### Quick Start: SubscriptionClient

Source: https://nktkas.gitbook.io/hyperliquid

Initialize and use the SubscriptionClient to receive real-time updates via WebSocket.

```typescript
import { SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";

const transport = new WebSocketTransport();
const client = new SubscriptionClient({ transport });

await client.allMids((data) => {
  console.log(data.mids);
});
```

--------------------------------

### Quick Start: InfoClient

Source: https://nktkas.gitbook.io/hyperliquid

Initialize and use the InfoClient to read market data, account state, and order book information.

```typescript
import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";

const transport = new HttpTransport();
const client = new InfoClient({ transport });

const mids = await client.allMids();
```

--------------------------------

### metaAndAssetCtxs

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets system metadata and asset contexts.

```APIDOC
## GET /metaAndAssetCtxs

### Description
Fetches both general system metadata and the context information for all assets.

### Method
GET

### Endpoint
/metaAndAssetCtxs
```

--------------------------------

### Install Event Target Shim for React Native

Source: https://nktkas.gitbook.io/hyperliquid

Install `event-target-shim` for React Native versions older than 0.86.

```bash
npm i event-target-shim
```

--------------------------------

### Install React Native Polyfills

Source: https://nktkas.gitbook.io/hyperliquid/readme.md

Install necessary polyfills for React Native environments to support features like DecompressionStream, Web Streams, and TextDecoder. These should be imported before the Hyperliquid SDK.

```sh
npm i text-encoding-polyfill web-streams-polyfill compression-streams-polyfill
```

```ts
import "text-encoding-polyfill";
import "web-streams-polyfill/polyfill";
import "compression-streams-polyfill";
```

--------------------------------

### Sign L1 Action in Browser with ethers

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

This example shows how to sign an L1 action in a browser environment using ethers.js and window.ethereum.

```typescript
import { signL1Action } from "@nktkas/hyperliquid/signing";
import { BrowserProvider } from "ethers";

const provider = new BrowserProvider(window.ethereum!);
const wallet = await provider.getSigner();

const action = { type: "cancel", cancels: [{ a: 0, o: 12345 }] };
const nonce = Date.now();

const signature = await signL1Action({ wallet, action, nonce });

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action, signature, nonce }),
});
```

--------------------------------

### Validator Registration Example

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/exchange-methods/cvalidatoraction.md

Use this snippet to register a new validator. It requires profile details, initial stake, and jail status.

```json
{
  "action": {
    "type": "CValidatorAction",
    "register": {
      "profile": {
        "node_ip": {
          "Ip": "192.168.1.1"
        },
        "name": "MyValidator",
        "description": "A reliable validator node.",
        "delegations_disabled": false,
        "commission_bps": 100,
        "signer": "0x1234567890abcdef1234567890abcdef12345678"
      },
      "unjailed": true,
      "initial_wei": 1000000000000000000
    }
  },
  "nonce": 1678886400000,
  "signature": {
    "r": "0x...",
    "s": "0x...",
    "v": 27
  },
  "expiresAfter": 1678886460000
}
```

--------------------------------

### Importing Exchange Methods Directly

Source: https://nktkas.gitbook.io/hyperliquid/guides/tree-shaking.md

Import individual exchange methods directly for optimized bundle size. This example uses HttpTransport and requires wallet configuration.

```typescript
import { HttpTransport } from "@nktkas/hyperliquid";
import { order } from "@nktkas/hyperliquid/api/exchange";
import { privateKeyToAccount } from "viem/accounts";

const transport = new HttpTransport();
const wallet = privateKeyToAccount("0x...");

await order(
  { transport, wallet },
  {
    orders: [{
      a: 0,
      b: true,
      p: "50000",
      s: "0.01",
      r: false,
      t: { limit: { tif: "Gtc" } },
    }],
    grouping: "na",
  },
);
```

--------------------------------

### Sign L1 Action in Browser with viem

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

Sign an L1 action directly in the browser using viem and window.ethereum. Ensure viem and its chain modules are installed.

```typescript
import { signL1Action } from "@nktkas/hyperliquid/signing";
import { createWalletClient, custom } from "viem";
import { arbitrum } from "viem/chains";

const [account] = await window.ethereum!.request({ method: "eth_requestAccounts" }) as `0x${string}`[];
const wallet = createWalletClient({ account, chain: arbitrum, transport: custom(window.ethereum!) });

const action = { type: "cancel", cancels: [{ a: 0, o: 12345 }] };
const nonce = Date.now();

const signature = await signL1Action({ wallet, action, nonce });

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action, signature, nonce }),
});
```

--------------------------------

### Register Hyperliquidity

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/exchange-methods/spotdeploy.md

Configure hyperliquidity for a spot market. This involves setting the starting price, order size, number of orders, and the number of levels to seed with USDC.

```json
{
  "action": {
    "type": "spotDeploy",
    "registerHyperliquidity": {
      "spot": 0,
      "startPx": "1.0",
      "orderSz": "1000",
      "nOrders": 5,
      "nSeededLevels": 1
    }
  }
}
```

--------------------------------

### Spot Meta Request Example

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods/spotmeta.md

This JSON object represents a request to the /info endpoint to retrieve spot trading metadata. It specifies the request type as 'spotMeta'.

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Hyperliquid API - info/spotMeta",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "spotMeta"
    }
  ],
  "servers": [
    {
      "url": "https://api.hyperliquid.xyz",
      "description": "Mainnet"
    },
    {
      "url": "https://api.hyperliquid-testnet.xyz",
      "description": "Testnet"
    }
  ],
  "paths": {
    "/info": {
      "post": {
        "tags": [
          "spotMeta"
        ],
        "description": "Request spot trading metadata.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "type": {
                    "description": "Type of request.",
                    "enum": [
                      "spotMeta"
                    ]
                  }
                },
                "required": [
                  "type"
                ],
                "description": "Request spot trading metadata."
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Metadata for spot assets.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "universe": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "tokens": {
                            "type": "array",
                            "minItems": 2,
                            "items": [
                              {
                                "type": "number",
                                "title": "baseToken"
                              },
                              {
                                "type": "number",
                                "title": "quoteToken"
                              }
                            ],
                            "maxItems": 2,
                            "description": "Token indices included in this universe."
                          },
                          "name": {
                            "type": "string",
                            "description": "Name of the universe."
                          },
                          "index": {
                            "type": "number",
                            "description": "Unique identifier of the universe."
                          },
                          "isCanonical": {
                            "type": "boolean",
                            "description": "Indicates if the token is the primary representation in the system."
                          }
                        },
                        "required": [
                          "tokens",
                          "name",
                          "index",
                          "isCanonical"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Trading universes available for spot trading."
                    },
                    "tokens": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Name of the token."
                          },
                          "szDecimals": {
                            "type": "number",
                            "description": "Minimum decimal places for order sizes."
                          },
                          "weiDecimals": {
                            "type": "number",
                            "description": "Number of decimals for the token's smallest unit."
                          },
                          "index": {
                            "type": "number",
                            "description": "Unique identifier for the token."
                          },
                          "tokenId": {
                            "type": "string",
                            "description": "Token ID.",
                            "pattern": "^0x[a-fA-F0-9]{32}$"
                          },
                          "isCanonical": {
                            "type": "boolean",
                            "description": "Indicates if the token is the primary representation in the system."
                          },
                          "evmContract": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "address": {
                                    "type": "string",
                                    "description": "Contract address.",
                                    "pattern": "^0x[a-fA-F0-9]{40}$"
                                  },
                                  "evm_extra_wei_decimals": {
                                    "type": "number",
                                    "description": "Extra decimals in the token's smallest unit."
                                  }
                                },
                                "required": [
                                  "address",
                                  "evm_extra_wei_decimals"
                                ],
                                "additionalProperties": false,
                                "nullable": true
                              }
                            ],
                            "description": "EVM contract details."
                          },
                          "fullName": {
                            "type": "string",
                            "description": "Full display name of the token.",
                            "nullable": true
                          },
                          "deployerTradingFeeShare": {
                            "type": "string",
                            "description": "Deployer trading fee share for the token.",
                            "pattern": "^[0-9]+(\\.[0-9]+)?$"
                          }
                        },
                        "required": [
                          "name",
                          "szDecimals",
                          "weiDecimals",
                          "index",
                          "tokenId",
                          "isCanonical",
                          "evmContract",
                          "fullName",
                          "deployerTradingFeeShare"
                        ],
                        "additionalProperties": false
                      },
                      "description": "Tokens available for spot trading."
                    }
                  },
                  "required": [
                    "universe",
                    "tokens"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "422": {
            "description": "Failed to deserialize the JSON body into the target type",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "null"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Sign Multi-sig L1 Action in Browser with Ethers

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

This example demonstrates signing a multi-sig L1 action within a browser using ethers.js and the window.ethereum object.

```typescript
import { signMultiSigL1 } from "@nktkas/hyperliquid/signing";
import { BrowserProvider } from "ethers";

const provider = new BrowserProvider(window.ethereum!);
const leader = await provider.getSigner();

const multiSigUser = "0x..."; // the multi-sig account address
const signers = [leader /* additional signers */] as const;

const action = { type: "scheduleCancel", time: Date.now() + 10_000 };
const nonce = Date.now();

const { action: multiSigAction, signature } = await signMultiSigL1({
  signers,
  multiSigUser,
  signatureChainId: "0x66eee",
  action,
  nonce,
});

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action: multiSigAction, signature, nonce }),
});
```

--------------------------------

### Sign L1 Action with viem

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

Use this snippet to sign an L1 action using a viem wallet. Ensure the 'ethers-wallet' library is installed.

```typescript
import { signL1Action } from "@nktkas/hyperliquid/signing";
import { privateKeyToAccount } from "viem/accounts";

const wallet = privateKeyToAccount("0x...");

const action = { type: "cancel", cancels: [{ a: 0, o: 12345 }] };
const nonce = Date.now();

const signature = await signL1Action({ wallet, action, nonce });

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action, signature, nonce }),
});
```

--------------------------------

### Get Spot Pair Deploy Auction Status

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods/spotpairdeployauctionstatus.md

Requests the current status of the spot deploy auction. This includes details about the current gas price, the duration of the auction, the starting and ending gas prices, and the auction's start time.

```APIDOC
## POST /info

### Description
Requests the current status of the spot deploy auction.

### Method
POST

### Endpoint
/info

### Request Body
- **type** (string) - Required - Must be "spotPairDeployAuctionStatus".

### Request Example
```json
{
  "type": "spotPairDeployAuctionStatus"
}
```

### Response
#### Success Response (200)
- **currentGas** (string) - Current gas price. Nullable.
- **durationSeconds** (number) - The duration of the auction in seconds.
- **endGas** (string) - The gas price at the end of the auction. Nullable.
- **startGas** (string) - The gas price at the start of the auction.
- **startTimeSeconds** (number) - The auction start time in seconds since the epoch.

#### Response Example
```json
{
  "currentGas": "1000000000",
  "durationSeconds": 3600,
  "endGas": "500000000",
  "startGas": "2000000000",
  "startTimeSeconds": 1678886400
}
```
```

--------------------------------

### Sign L1 Action with ethers

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

This snippet demonstrates signing an L1 action using an ethers Wallet. Make sure the 'ethers-wallet' library is installed.

```typescript
import { signL1Action } from "@nktkas/hyperliquid/signing";
import { Wallet } from "ethers";

const wallet = new Wallet("0x...");

const action = { type: "cancel", cancels: [{ a: 0, o: 12345 }] };
const nonce = Date.now();

const signature = await signL1Action({ wallet, action, nonce });

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action, signature, nonce }),
});
```

--------------------------------

### Get User TWAP Slice Fills by Time

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods/usertwapslicefillsbytime.md

Fetches a list of user's TWAP slice fills, filtered by a start and end timestamp. Each fill record includes details such as the asset, price, size, side, timestamp, and associated TWAP order information.

```APIDOC
## POST /info

### Description
Retrieves user's TWAP slice fills within a specified time range.

### Method
POST

### Endpoint
/info

### Parameters
#### Query Parameters
- **start** (integer) - Required - The start timestamp (Unix epoch milliseconds) of the time range.
- **end** (integer) - Required - The end timestamp (Unix epoch milliseconds) of the time range.

### Request Body
```json
{
  "func": "userTwapSliceFillsByTime",
  "args": {
    "start": 1678886400000,
    "end": 1678972800000
  }
}
```

### Response
#### Success Response (200)
- **fills** (array) - An array of TWAP slice fill objects.
  - **coin** (string) - The asset traded.
  - **px** (string) - The price of the fill.
  - **sz** (string) - The size of the fill.
  - **side** (string) - The side of the fill (e.g., "BUY" or "SELL").
  - **time** (number) - The timestamp of the fill.
  - **startPosition** (string) - The starting position for the TWAP order.
  - **dir** (number) - The direction of the TWAP order.
  - **closedPnl** (string) - The realized PnL for the fill.
  - **hash** (string) - The hash of the fill transaction.
  - **oid** (number) - The order ID associated with the fill.
  - **crossed** (boolean) - Indicates if the order crossed the spread.
  - **fee** (string) - The fee amount for the fill.
  - **tid** (number) - Unique transaction identifier for a partial fill of an order.
  - **feeToken** (string) - Token in which the fee is denominated (e.g., USDC).
  - **twapId** (number, nullable) - ID of the TWAP.

#### Response Example
```json
{
  "fills": [
    {
      "coin": "BTC",
      "px": "30000.50",
      "sz": "0.001",
      "side": "BUY",
      "time": 1678886460000,
      "startPosition": "0",
      "dir": 1,
      "closedPnl": "0.0000",
      "hash": "0xabc123...",
      "oid": 12345,
      "crossed": false,
      "fee": "0.00000000",
      "tid": 1,
      "feeToken": "USDC",
      "twapId": 987
    }
  ]
}
```
```

--------------------------------

### Initialize ExchangeClient with Viem Wallet

Source: https://nktkas.gitbook.io/hyperliquid/clients.md

Set up an ExchangeClient using a Viem wallet for signing transactions. Requires a private key.

```typescript
import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { privateKeyToAccount } from "viem/accounts";

const wallet = privateKeyToAccount("0x...");

const transport = new HttpTransport();
const client = new ExchangeClient({ transport, wallet });

await client.order({ orders: [/* ... */], grouping: "na" });
```

--------------------------------

### Importing Info Methods Directly

Source: https://nktkas.gitbook.io/hyperliquid/guides/tree-shaking.md

Import individual info methods directly to include only that method, its validation schema, and transport logic. Use HttpTransport for this example.

```typescript
import { HttpTransport } from "@nktkas/hyperliquid";
import { allMids } from "@nktkas/hyperliquid/api/info";

const transport = new HttpTransport();
const result = await allMids({ transport });
```

--------------------------------

### Sign Multi-Sig User Action in Browser with viem

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

This example shows how to sign a multi-sig action within a browser environment using viem and `window.ethereum`. It requests accounts and sets up a viem client.

```typescript
import { signMultiSigUserSigned } from "@nktkas/hyperliquid/signing";
import { UsdSendTypes } from "@nktkas/hyperliquid/api/exchange";
import { createWalletClient, custom } from "viem";
import { arbitrum } from "viem/chains";

const [account] = await window.ethereum!.request({ method: "eth_requestAccounts" }) as `0x${string}`[];

const leader = createWalletClient({
  account,
  chain: arbitrum,
  transport: custom(window.ethereum!),
});

const multiSigUser = "0x..."; // the multi-sig account address
const signers = [leader /* additional signers */] as const;

const action = {
  type: "usdSend",
  signatureChainId: "0x66eee" as const,
  hyperliquidChain: "Mainnet" as const, // or "Testnet"
  destination: "0x...",
  amount: "100",
  time: Date.now(),
};

const { action: multiSigAction, signature } = await signMultiSigUserSigned({
  signers,
  multiSigUser,
  action,
  types: UsdSendTypes,
});

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action: multiSigAction, signature, nonce: action.time }),
});
```

--------------------------------

### predictedFundings

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets predicted funding rates.

```APIDOC
## GET /predictedFundings

### Description
Provides predicted funding rates for perpetual contracts.

### Method
GET

### Endpoint
/predictedFundings
```

--------------------------------

### POST /exchange

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/exchange-methods/spotdeploy.md

This endpoint allows for various spot deployment actions. It requires an action object, a nonce, and a signature. The action object specifies the type of operation and its associated parameters.

```APIDOC
## POST /exchange

### Description
This endpoint is used to perform various exchange actions, including spot deployment.

### Method
POST

### Endpoint
/exchange

### Request Body
- **action** (object) - Required - Specifies the action to perform. It must contain a `type` and one of the following sub-objects: `registerHyperliquidity`, `setDeployerTradingFeeShare`, `enableQuoteToken`, `disableQuoteToken`, or `requestEvmContract`.
  - **type** (string) - Required - Must be `spotDeploy`.
  - **registerHyperliquidity** (object) - Required - Parameters for registering Hyperliquidity.
  - **setDeployerTradingFeeShare** (object) - Required - Parameters for setting the deployer trading fee share.
    - **token** (integer) - Required - Token identifier (0 to 9007199254740991).
    - **share** (string) - Required - The deployer trading fee share (e.g., "10.5%").
  - **enableQuoteToken** (object) - Required - Parameters for enabling a quote token.
    - **token** (integer) - Required - The token ID to convert to a quote token (0 to 9007199254740991).
  - **disableQuoteToken** (object) - Required - Parameters for disabling a quote token.
    - **token** (integer) - Required - Token identifier to disable as quote token (0 to 9007199254740991).
  - **requestEvmContract** (object) - Required - Parameters for requesting an EVM contract link.
    - **token** (integer) - Required - Token identifier to link (0 to 9007199254740991).
    - **address** (string) - Required - ERC-20 contract address on the HyperEVM (42 characters, starting with 0x).
    - **evmExtraWeiDecimals** (integer) - Required - Difference in wei decimals between Core and EVM spot (-2 to 18).
- **nonce** (integer) - Required - Nonce (timestamp in ms) to prevent replay attacks (0 to 9007199254740991).
- **signature** (object) - Required - ECDSA signature components.
  - **r** (string) - Required - First 32-byte component (66 characters, starting with 0x).
  - **s** (string) - Required - Second 32-byte component (66 characters, starting with 0x).
  - **v** (number) - Required - Recovery identifier (27 or 28).
- **expiresAfter** (integer) - Optional - Expiration time of the action (0 to 9007199254740991).

### Responses
#### Success Response (200)
- **status** (string) - Successful status (`ok`).
- **response** (object)
  - **type** (string) - Type of response (`default`).

#### Error Response (200)
- **status** (string) - Error status (`err`).
- **response** (string) - Error message.

#### Unprocessable Entity (422)
- Response body is a plain text string indicating the error.
```

--------------------------------

### orderStatus

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the status of a specific order.

```APIDOC
## GET /orderStatus

### Description
Retrieves the current status of a specific order.

### Method
GET

### Endpoint
/orderStatus

### Parameters
#### Query Parameters
- **user** (string) - Required - The user address.
- **orderId** (integer) - Required - The ID of the order.
```

--------------------------------

### End-to-End Order Placement with Utilities

Source: https://nktkas.gitbook.io/hyperliquid/utilities.md

This example demonstrates resolving an asset ID, formatting price and size using utility functions, and submitting an order via `ExchangeClient`. Ensure to handle potential `undefined` return values from `getAssetId` and `getSzDecimals` in production.

```typescript
import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { formatPrice, formatSize, SymbolConverter } from "@nktkas/hyperliquid/utils";
import { privateKeyToAccount } from "viem/accounts";

const wallet = privateKeyToAccount("0x...");
const transport = new HttpTransport();
const converter = await SymbolConverter.create({ transport });
const client = new ExchangeClient({ transport, wallet });

const coin = "BTC";
const rawPrice = "97123.456789";
const rawSize = "0.00123456789";

// `!` asserts the symbol exists — in production, handle `undefined` explicitly
const assetId = converter.getAssetId(coin)!;
const szDecimals = converter.getSzDecimals(coin)!;

await client.order({
  orders: [{
    a: assetId,                           // "BTC" → 0
    b: true,
    p: formatPrice(rawPrice, szDecimals), // "97123.456789" → "97123"
    s: formatSize(rawSize, szDecimals),   // "0.00123456789" → "0.00123"
    r: false,
    t: { limit: { tif: "Gtc" } },
  }],
  grouping: "na",
});
```

--------------------------------

### maxBuilderFee

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the maximum builder fee.

```APIDOC
## GET /maxBuilderFee

### Description
Retrieves the maximum fee that can be charged by a builder.

### Method
GET

### Endpoint
/maxBuilderFee
```

--------------------------------

### exchangeStatus

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the current status of the exchange.

```APIDOC
## GET /exchangeStatus

### Description
Returns the current operational status of the exchange, including trading availability and system health.

### Method
GET

### Endpoint
/exchangeStatus
```

--------------------------------

### Sign Multi-sig L1 Action in Browser with Viem

Source: https://nktkas.gitbook.io/hyperliquid/signing.md

This example shows how to perform multi-sig L1 signing directly in a browser environment using Viem and the injected Ethereum provider.

```typescript
import { signMultiSigL1 } from "@nktkas/hyperliquid/signing";
import { createWalletClient, custom } from "viem";
import { arbitrum } from "viem/chains";

const [account] = await window.ethereum!.request({ method: "eth_requestAccounts" }) as `0x${string}`[];
const leader = createWalletClient({
  account,
  chain: arbitrum,
  transport: custom(window.ethereum!),
});

const multiSigUser = "0x..."; // the multi-sig account address
const signers = [leader /* additional signers */] as const;

const action = { type: "scheduleCancel", time: Date.now() + 10_000 };
const nonce = Date.now();

const { action: multiSigAction, signature } = await signMultiSigL1({
  signers,
  multiSigUser,
  signatureChainId: "0x66eee",
  action,
  nonce,
});

await fetch("https://api.hyperliquid.xyz/exchange", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ action: multiSigAction, signature, nonce }),
});
```

--------------------------------

### delegatorRewards

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the rewards accrued by a delegator.

```APIDOC
## GET /delegatorRewards

### Description
Retrieves the total rewards accrued by a specific delegator.

### Method
GET

### Endpoint
/delegatorRewards

### Parameters
#### Query Parameters
- **delegator** (string) - Required - The address of the delegator.
```

--------------------------------

### Initialize WebSocket Subscription Client

Source: https://nktkas.gitbook.io/hyperliquid/clients.md

Set up a SubscriptionClient using a WebSocketTransport. Ensure the WebSocketTransport is correctly initialized before creating the client.

```typescript
import { SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";

const transport = new WebSocketTransport();
const client = new SubscriptionClient({ transport });

const subscription = await client.allMids((data) => {
  console.log(data.mids);
});
```

--------------------------------

### Connect with viem

Source: https://nktkas.gitbook.io/hyperliquid/guides/browser-wallets.md

Connect to a browser wallet using viem and create an ExchangeClient. Requires window.ethereum to be available.

```typescript
import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { createWalletClient, custom } from "viem";
import { arbitrum } from "viem/chains";

const [account] = await window.ethereum!.request({ method: "eth_requestAccounts" }) as `0x${string}`[];
const wallet = createWalletClient({ account, chain: arbitrum, transport: custom(window.ethereum!) });

const transport = new HttpTransport();
const client = new ExchangeClient({ transport, wallet });
```

--------------------------------

### clearinghouseState

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the current state of the clearinghouse.

```APIDOC
## GET /clearinghouseState

### Description
Retrieves the overall state of the clearinghouse, including global parameters and statuses.

### Method
GET

### Endpoint
/clearinghouseState
```

--------------------------------

### Ask a Question via Documentation API

Source: https://nktkas.gitbook.io/hyperliquid/llms.txt

Use this GET request to query the documentation index with a specific question and an optional broader goal. The response includes a direct answer and relevant excerpts.

```http
GET https://nktkas.gitbook.io/hyperliquid/clients.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### allMids

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the mid-prices for all listed assets.

```APIDOC
## GET /allMids

### Description
Retrieves the current mid-price for every asset listed on the exchange.

### Method
GET

### Endpoint
/allMids
```

--------------------------------

### meta

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Fetches general metadata about the system.

```APIDOC
## GET /meta

### Description
Retrieves general metadata about the Hyperliquid system, such as version information and network status.

### Method
GET

### Endpoint
/meta
```

--------------------------------

### Vault Details

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets detailed information about vaults.

```APIDOC
## GET /vaultDetails

### Description
Gets detailed information about vaults.

### Method
GET

### Endpoint
/vaultDetails
```

--------------------------------

### perpDexLimits

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets the limits for perpetual DEX operations.

```APIDOC
## GET /perpDexLimits

### Description
Returns the operational limits for the perpetual decentralized exchange.

### Method
GET

### Endpoint
/perpDexLimits
```

--------------------------------

### Initializing SubscriptionClient and Subscribing to allMids

Source: https://nktkas.gitbook.io/hyperliquid/clients.md

Demonstrates how to initialize the SubscriptionClient with a WebSocketTransport and subscribe to all available market IDs (mids). The callback function processes the received data.

```APIDOC
## Initialize and Subscribe

### Description
Initializes the `SubscriptionClient` using a `WebSocketTransport` and subscribes to the `allMids` channel to receive real-time market data. A callback function is provided to handle the incoming data.

### Method
`client.allMids(callback, [options])`

### Parameters
#### Callback Function
- `data` (object) - The received market data. Expected to have a `mids` property.

#### Options (Optional)
- `signal` (AbortSignal) - An `AbortSignal` to cancel the subscription.
- `onError` (function) - A callback function to handle subscription errors.
  - `error` (TransportError) - The error object.

### Request Example
```ts
import { SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";

const transport = new WebSocketTransport();
const client = new SubscriptionClient({ transport });

const subscription = await client.allMids((data) => {
  console.log(data.mids);
});
```

### Response
- `subscription` (object) - An object with an `unsubscribe` method.
```

--------------------------------

### Importing Explorer Methods Directly

Source: https://nktkas.gitbook.io/hyperliquid/guides/tree-shaking.md

Import individual explorer methods directly to minimize bundle size. This example uses HttpTransport and demonstrates fetching block details.

```typescript
import { HttpTransport } from "@nktkas/hyperliquid";
import { blockDetails } from "@nktkas/hyperliquid/api/explorer";

const transport = new HttpTransport();
const block = await blockDetails({ transport }, { height: 123 });
```

--------------------------------

### perpAnnotation

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets annotation data for perpetual contracts.

```APIDOC
## GET /perpAnnotation

### Description
Retrieves annotation data associated with perpetual contracts.

### Method
GET

### Endpoint
/perpAnnotation
```

--------------------------------

### Initialize ExchangeClient with Browser Viem Wallet

Source: https://nktkas.gitbook.io/hyperliquid/clients.md

Connect an ExchangeClient to a browser-based Viem wallet (e.g., MetaMask). Requires user authorization via eth_requestAccounts.

```typescript
import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { createWalletClient, custom } from "viem";
import { arbitrum } from "viem/chains";

const [account] = await window.ethereum!.request({ method: "eth_requestAccounts" }) as `0x${string}`[];
const wallet = createWalletClient({ account, chain: arbitrum, transport: custom(window.ethereum!) });

const transport = new HttpTransport();
const client = new ExchangeClient({ transport, wallet });

await client.order({ orders: [/* ... */], grouping: "na" });
```

--------------------------------

### validatorL1Stream

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/exchange-methods.md

Starts or stops an L1 stream for validators.

```APIDOC
## validatorL1Stream

### Description
Starts or stops an L1 stream for validators.

### Method
POST

### Endpoint
/api/v1/validator/l1-stream

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform ('start' or 'stop').

### Request Example
```json
{
  "action": "start"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the action was performed successfully.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Initialize InfoClient

Source: https://nktkas.gitbook.io/hyperliquid/clients.md

Instantiate an InfoClient for read-only access to Hyperliquid data. Requires an HttpTransport.

```typescript
import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";

const transport = new HttpTransport();
const client = new InfoClient({ transport });

const book = await client.l2Book({ coin: "ETH" });
```

--------------------------------

### Spot Pair Deploy Auction Status Response Schema

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods/spotpairdeployauctionstatus.md

This schema defines the structure of the response when querying the status of a spot deploy auction. It includes details such as current gas, duration, ending gas, starting gas, and the auction start time.

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Hyperliquid API - info/spotPairDeployAuctionStatus",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "spotPairDeployAuctionStatus"
    }
  ],
  "servers": [
    {
      "url": "https://api.hyperliquid.xyz",
      "description": "Mainnet"
    },
    {
      "url": "https://api.hyperliquid-testnet.xyz",
      "description": "Testnet"
    }
  ],
  "paths": {
    "/info": {
      "post": {
        "tags": [
          "spotPairDeployAuctionStatus"
        ],
        "description": "Request for the status of the spot deploy auction.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "type": {
                    "description": "Type of request.",
                    "enum": [
                      "spotPairDeployAuctionStatus"
                    ]
                  }
                },
                "required": [
                  "type"
                ],
                "description": "Request for the status of the spot deploy auction."
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Status of the spot deploy auction.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/definitions/PerpDeployAuctionStatusResponse",
                  "description": "Status of the spot deploy auction.",
                  "definitions": {
                    "PerpDeployAuctionStatusResponse": {
                      "type": "object",
                      "properties": {
                        "currentGas": {
                          "type": "string",
                          "description": "Current gas.",
                          "pattern": "^[0-9]+(\\.[0-9]+)?$",
                          "nullable": true
                        },
                        "durationSeconds": {
                          "type": "number",
                          "description": "Duration in seconds."
                        },
                        "endGas": {
                          "type": "string",
                          "description": "Ending gas.",
                          "pattern": "^[0-9]+(\\.[0-9]+)?$",
                          "nullable": true
                        },
                        "startGas": {
                          "type": "string",
                          "description": "Starting gas.",
                          "pattern": "^[0-9]+(\\.[0-9]+)?$"
                        },
                        "startTimeSeconds": {
                          "type": "number",
                          "description": "Auction start time (in seconds since epoch)."
                        }
                      },
                      "required": [
                        "currentGas",
                        "durationSeconds",
                        "endGas",
                        "startGas",
                        "startTimeSeconds"
                      ],
                      "additionalProperties": false,
                      "description": "Status of the perpetual deploy auction."
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Failed to deserialize the JSON body into the target type",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "null"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Create SymbolConverter Instance

Source: https://nktkas.gitbook.io/hyperliquid/utilities.md

Instantiates a SymbolConverter by fetching necessary metadata. This is the recommended way to create an instance for runtime use.

```APIDOC
## Create SymbolConverter

`SymbolConverter.create()` fetches `meta`, `spotMeta`, and `outcomeMeta` (plus builder-DEX metadata when enabled) and resolves into a ready-to-use instance.

### Method

`SymbolConverter.create({ transport })`

### Parameters

#### Path Parameters

- **transport** (HttpTransport) - Required - The HTTP transport instance to use for fetching metadata.

### Request Example

```ts
import { HttpTransport } from "@nktkas/hyperliquid";
import { SymbolConverter } from "@nktkas/hyperliquid/utils";

const transport = new HttpTransport();
const converter = await SymbolConverter.create({ transport });
```

### Description

For synchronous initialization, use `new SymbolConverter({ transport })` and then explicitly call `await converter.reload()`.
```

--------------------------------

### Token Details

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/info-methods.md

Gets detailed information about specific tokens.

```APIDOC
## GET /tokenDetails

### Description
Gets detailed information about specific tokens.

### Method
GET

### Endpoint
/tokenDetails
```

--------------------------------

### spotAssetCtxs

Source: https://nktkas.gitbook.io/hyperliquid/api-reference/subscription-methods.md

Subscribe to context information for all spot assets.

```APIDOC
## GET /subscribe/spotAssetCtxs

### Description
Subscribes to context information for all spot assets.

### Method
GET

### Endpoint
/subscribe/spotAssetCtxs
```
Tokens:
Raw