preTransferCheck

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request user existence check before transfer.

Body

application/json

Request user existence check before transfer.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

sourcestring · min: 42 · max: 42Required

Source address.

Pattern: ^0[xX][0-9a-fA-F]+$

Responses

200

Pre-transfer user existence check result.

application/json

Pre-transfer user existence check result.

feestringRequired

Activation fee.

Pattern: ^[0-9]+(\.[0-9]+)?$

isSanctionedbooleanRequired

Whether the user is sanctioned.

userExistsbooleanRequired

Whether the user exists.

userHasSentTxbooleanRequired

Whether the user has sent a transaction.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.preTransferCheck({ user: "0x...", source: "0x..." });

{
  "fee": "text",
  "isSanctioned": true,
  "userExists": true,
  "userHasSentTx": true
}