GMX V2 GM / GLV deposit · withdraw · cancel

GET 
/v1/actions/vaults/gmx

Build calldata for GMX V2 GM-market / GLV liquidity actions (Arbitrum 42161, Avalanche 43114). These are async: each call returns a single ExchangeRouter (GM) / GlvRouter (GLV) multicall transaction (plus any ERC-20 approval to the GMX Router), and a keeper executes the request a few seconds later. The deposit/withdraw tx must carry a native executionFee (the keeper's gas reimbursement) — GMX reverts if it's underpaid.

Actions

• deposit (default) — add liquidity. Needs longToken + shortToken (the market legs), payAsset (the token paid in), amount, executionFee.
• withdraw — remove liquidity (burn GM/GLV tokens). Needs amount (GM/GLV tokens), executionFee.
• cancel — cancel a still-pending deposit/withdrawal ticket. Needs request=deposit|withdrawal and the 32-byte key (from /v1/data/vaults/gmx).

GM vs GLV (kind)

• gm (default) — a single GM market; market defaults to vault.
• glv — an auto-rebalancing GLV vault; you must name the GM market within the GLV.

Plain-text reference — GET /v1/actions/vaults/gmx

Parameters

Parameter	In	Type	Required	Description
chainId	query	string	yes	Chain ID — 42161 (Arbitrum) or 43114 (Avalanche). See the ChainId schema for the full set of supported chains.
action	query	deposit, withdraw, cancel	no	Operation to build.
kind	query	gm, glv	no	Pool kind.
vault	query	string	yes	GM market token (gm) or GLV token (glv).
operator	query	string	yes	Caller wallet (deposit/withdraw). receiver defaults to it.
receiver	query	string	no	Recipient. Defaults to operator.
amount	query	string	no	deposit: input-token amount. withdraw: GM/GLV tokens to burn. Wei.
executionFee	query	string	no	deposit/withdraw: native keeper fee (wei), forwarded as the tx value. GMX rejects underpaid requests — quote it from the GMX UI/SDK.
market	query	string	no	GLV: required — the GM market within the GLV. GM: defaults to vault.
longToken	query	string	no	deposit: required — the market long leg.
shortToken	query	string	no	deposit: required — the market short leg.
payAsset	query	string	no	deposit: token paid in. Zero / 0xEEEE… = native. Defaults to longToken.
minOut	query	integer	no	Slippage floor on output GM/GLV (deposit) or output token (withdraw).
minLongTokenAmount	query	integer	no	withdraw: min long-token received.
minShortTokenAmount	query	integer	no	withdraw: min short-token received.
isMarketTokenDeposit	query	boolean	no	deposit: the input is already GM tokens (GLV deposit of an existing GM position).
shouldUnwrapNativeToken	query	boolean	no	withdraw: unwrap WETH/WAVAX output to native.
uiFeeReceiver	query	string	no	Optional UI-fee recipient.
callbackGasLimit	query	integer	no	Optional gas limit for the keeper callback.
request	query	deposit, withdrawal	no	cancel: which pending ticket to cancel.
key	query	string	no	cancel: 32-byte request key (from /v1/data/vaults/gmx).

Response 200

Field	Type	Description
success	True
data	object	Informational data (quotes, simulation results, etc.)
actions	object	Transaction calldata and approvals. Null for quote-only responses (no account provided).
actions.transactions	object[]	Pre-trade setup transactions (e.g. e-mode switch, collateral enable). Execute these before the main swap. Empty when no setup is needed.
actions.transactions[].to	string	Target contract address
actions.transactions[].data	string	Encoded calldata
actions.transactions[].value	string	ETH value to send with the transaction
actions.transactions[].description	string	Human-readable label. For alternatives, this is the aggregator name (e.g. "Paraswap"). For transactions, describes the setup action (e.g. "Switch e-mode to 1").
actions.alternatives	object[]	DEX aggregator swap transactions sorted by best output (descending). Each entry's description is the aggregator name. The client should pick one to execute. Present on loop action endpoints.
actions.alternatives[].to	string	Target contract address
actions.alternatives[].data	string	Encoded calldata
actions.alternatives[].value	string	ETH value to send with the transaction
actions.alternatives[].description	string	Human-readable label. For alternatives, this is the aggregator name (e.g. "Paraswap"). For transactions, describes the setup action (e.g. "Switch e-mode to 1").
actions.permissions	object[]	Approval/delegation transactions that must execute before both transactions and alternatives. Includes ERC20 allowances (targeting the composer contract) and lender borrow/withdrawal delegations (targeting the lending protocol contract directly). Filtered against on-chain state so only missing approvals are returned. Null when no approvals are needed.
actions.permissions[].to	string	Target contract address
actions.permissions[].data	string	Encoded calldata
actions.permissions[].value	string	ETH value
actions.permissions[].description	string	Human-readable description of the approval (e.g. "Approve borrow for AAVE_V3", "Approve ERC20")
actions.permissions[].spender	string	ERC-20 approve spender (x-chain permissions). Match it against the selected quote's approvalTarget — several bridges can share one spender, so do not match by description.

Example response

{
  "success": true,
  "data": {},
  "actions": {
    "transactions": [
      {
        "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string"
      }
    ],
    "alternatives": [
      {
        "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string"
      }
    ],
    "permissions": [
      {
        "to": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string",
        "spender": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
      }
    ]
  }
}

Request

Responses

200

A single ExchangeRouter/GlvRouter multicall transaction (plus any Router approval). A keeper executes the request shortly after.

400

Validation error

429

Rate limited. Unauthenticated callers share a per-IP budget; send an x-api-key header to lift it. Retry with exponential backoff.

500

Unexpected server error. Safe to retry with backoff.

502

An upstream data source or protocol origin failed (error.code is ORIGIN_FAILED). error.details carries the per-origin status. This is also what a missing or malformed required parameter currently returns, rather than a 400.