Connect to OKX via Vezgo API

Data mapping

A field-level guide to the Vezgo API data for OKX — what each attribute means and where to read it — so you can map it into your own system.

How to read a transaction

Each OKX activity maps to a Vezgo transaction. Read the value movement from parts[], and classify with transaction_type / transaction_subtype:

• Value movement — parts[] (direction sent/received, ticker, provider_ticker, amount, fiat_value in USD). Amounts are positive; direction carries the sign. A spot trade carries one part per OKX bill on the order — two (base + quote) for a single fill, more when the order filled in several executions — and a Convert / Simple trade has two. Every other activity, including token conversions and fiat orders, has one part. Trade part amounts are balance changes (OKX's balChg), so the fee is already deducted from the leg it was charged on, and a maker rebate is already added to its leg.
• Type — transaction_type is trade, deposit, withdrawal, staking / unstaking (Earn subscriptions / redemptions), reward, bonus or other. transaction_subtype refines it: buy / sell on a trade (on a spot trade they follow the pair's base currency — buy = base received), or trade_crypto for Convert, Simple trade and token conversions; fiat_deposit / fiat_withdrawal and transfer_in / transfer_out (moves between OKX accounts) on ledger deposits / withdrawals; staking_reward / interest_income / income_reward on a reward; distribution / rebate / referral_bonus on a bonus; fees / refund / cancel on other. Some activities carry no subtype, including on-chain deposits / withdrawals and Earn subscriptions / redemptions.
• Fees — fees[] holds a trade's fee or a withdrawal's network fee: the native fee asset and amount, with fiat_value in USD. On a trade it is informational: the parts already reflect the fee, and a maker rebate sits in its leg. On a withdrawal it is charged on top: the part is the amount sent and the network fee comes on top of it, so deduct the fee from the balance of the asset in fees[].ticker. The funding ledger can also book that network fee as its own transaction (origin_type withdrawal-fee, other / fees): match it to its withdrawal by coin, fee amount and time, and count the fee once. Other fee entries in the ledgers (e.g. interest deductions, funding fees) are their own transactions too (transaction_type other, subtype fees), with the fee as their part.
• misc.origin_id is the OKX order id (ordId) for a trade — Convert and Simple trade legs, which share no order id, use the received leg's bill id — the transaction hash (txId) for an on-chain deposit / withdrawal, OKX's own id for an internal transfer (deposit-<depId> / withdrawal-<wdId>), and the bill id (billId) for every other ledger entry. misc.origin_type is Vezgo's label for the activity: buy-trade / sell-trade / convert / deposit / withdrawal, or the ledger entry's type (e.g. earn-subscription, staking-yield, transfer-to-trading). Trades also carry misc.order_id, misc.bill_id, misc.trade_id and misc.origin_pair (the OKX instrument, e.g. BTC-USDT); ledger entries carry OKX's bill type code in misc.funding_bill_type, or misc.trading_bill_type with misc.trading_bill_subtype. Deposits / withdrawals carry the destination in parts[].to_address — an on-chain address, or an OKX account identifier for an internal transfer. There is no from_address and no top-level transaction_hash.
• Older rows — crypto deposits and withdrawals imported up to October 2, 2026 keep their earlier form: a withdrawal's part amount is negative (its direction is sent), internal transfers share an empty misc.origin_id and can be merged into one transaction, an unpriced coin carries its coin amount as fiat_value, and some failed or cancelled withdrawals are still listed.

// One Vezgo transaction = an OKX activity (a trade carries its legs as parts)
const wallet = tx.wallet;              // account.wallets[].id — the main wallet or the funding wallet
const id     = tx.misc.origin_id;      // ordId (trades), billId (convert, ledger entries), txId (on-chain deposits/withdrawals)
                                       // or deposit-<depId> / withdrawal-<wdId> (internal transfers)
const kind   = tx.misc.origin_type;    // buy-trade, sell-trade, convert, deposit, withdrawal, or a ledger type

const type    = tx.transaction_type;   // trade | deposit | withdrawal | staking | unstaking | reward | bonus | other
const subtype = tx.transaction_subtype;// buy | sell | trade_crypto | fiat_deposit | transfer_in | staking_reward | …
const parts   = tx.parts ?? [];        // spot trade = one per bill (2 for a single fill); convert = 2; else 1
const fees    = tx.fees ?? [];         // trade fee (already in the parts) or withdrawal network fee (on top: deduct it)

// Deposits/withdrawals: destination is parts[].to_address; an on-chain one's hash is misc.origin_id (txId).
// Ledger entries carry OKX's bill type code in misc.funding_bill_type or misc.trading_bill_type.
// A move between the funding and trading accounts appears on both wallets.