Developer docs

Overview

Machine-native VeTrade DEX aggregator workflows for VeChain swaps, limit orders, MCP, and Codex.

Use hosted VeTrade tools to quote, prepare and read VeChain activity. Signing and broadcast happen in your own wallet or local runtime. A prepared bundle is not a completed transaction.

Choose your path

TaskStart hereWhat you need
Read a quote over HTTPSwap planscurl and token addresses; no signer key
Use hosted agent toolsMCP first callAn MCP client; no signer key
Execute locally in CodexInstall the skillLocal Node runtime, wallet and explicit execution intent
Run a self-hosted OpenAI agentSDK entry pathsOpenAI API access; signer only for execution
Use Anthropic Managed AgentsPlanning setup or execution setupYour managed environment and its own access controls

First read-only request

With curl installed, run:

curl -fsS https://vetrade.vet/v2/swap-plans

Expected: endpoint guidance with apiVersion, supportedMethods and a sample POST body. This request does not quote, sign or submit. Follow the complete quote example next.

Task index

  • Swap plans — quote-only or wallet-bound bundles; raw units and quote expiry.
  • Transfer plans — direct send, exact-input or exact-output swap-transfer; signer and recipient rules.
  • Limit orders — create, list, inspect and cancel.
  • Errors — field corrections and retry behavior.
  • Auth — access behavior checked against this checkout.
  • Public task guides — review steps for people using the app.

Hosted capabilities

The HTTP and MCP surfaces can prepare swap, transfer and limit-order packages; provide quote-only routes and warnings; resolve supported tokens and recipient .vet names; inspect balances and allowances; simulate bundles; and read order state. MCP also exposes block, transaction, account and event reads, plus signature lookup and event decoding. Hosted quote accepts human decimal amounts; hosted quote_swap accepts raw integer amounts.

The hosted surfaces do not custody keys, sign transactions or broadcast for a user. Do not send private keys, seed phrases or signer files to their arguments.

MCP also provides current app guides and review links, direct VET-wrapper conversion clauses, recurring-order lists and history, fresh owner-bound order reads, and unsigned recurring-buy creation/pause/resume/cancel preparation. DCA preparation simulates the requested change; it does not quote future purchases or establish the app's minimum USD value. MCP details.

Use list_app_guides / read_app_guide or MCP resources for the same documentation as the native app. Liquidity, Auto Compound, Automatic Optimization, Boost, bridges, wallet approvals, alerts and rewards have guides and app entry links; their transactions remain app workflows.

Local execution

The Codex skill and OpenAI SDK can derive the signer locally, validate bundles, estimate gas, submit a VeChain multi-clause transaction and inspect its receipt. Optional fee delegation also stays in the local runtime.

Before any submission, verify token addresses, units, recipient, permissions, gas and freshness. After submission, verify the receipt and intended settlement or final order status. A plan, a successful simulation and an accepted signature are different from a confirmed outcome.

Core endpoints

  • POST /v2/swap-plans — raw-unit swap plans.
  • POST /v2/transfer-plans — decimal-amount transfer and swap-transfer plans.
  • POST /v2/limit-order-plans — create or cancel a limit order.
  • GET /v2/limit-orders?maker=... — order list.
  • GET /v2/limit-orders/{orderId} — order status.
  • Each plan endpoint also supports GET guidance.
  • Remote MCP: mcp.vetrade.vet.
  • MCP manifest, Swap OpenAPI, Limit orders OpenAPI.

Maintenance and policies

Endpoint and tool coverage checked against the repository on 3 November 2026. This does not verify current production availability or third-party CLI compatibility. See Auth, Changelog, Privacy and Terms.