GMX Account

post/gmx-account/deposit/cross-chain/prepare

Request body

innerDatastring

Optional extra payload appended to the LayerZero compose message (hex).

nativeDropAmountstring

Optional native drop (gas) for the destination chain, in destination native decimals.

nativeFeestring

Optional; when omitted, server quotes Stargate nativeFee on the source chain.

composeGasstring

Optional client-supplied destination compose-gas hint; bypasses server quote.

tokenKind'trade' | 'platform'

"trade" → IStargate.sendToken (default); "platform" → IStargate.send.

isNativeOnSourceboolean

Whether the source-chain token is the chain's native gas asset (ETH/BNB/etc.) — Stargate auto-wraps it to WETH/WBNB on the source side. Optional override; otherwise resolved from the registry.

destinationStargatePoolAddressstring

Optional override; otherwise resolved from the registry by symbol/token.

sourceStargatePoolAddressstring

Optional override; otherwise resolved from the registry by symbol/token.

tokenAddressstring

Token address on the settlement chain (alternative to tokenSymbol).

tokenSymbolstring

Token identifier. Provide one of:

  • tokenSymbol (e.g. "USDC" | "USDT" | "ETH"), or
  • tokenAddress on the settlement chain. Stargate pool addresses and source-side isNativeOnSource are resolved server-side.
amountstring required

Amount in token-native decimals as a base-10 string.

accountstring required

GMX account that will receive the deposit on the settlement chain.

srcChainIdnumber double required

Source chain id (where the user holds funds and signs the bridge tx).

Response

Success

expiresAtnumber double required
nativeFeestring required
composeGasstring required
payloadType'transaction' required