View as Markdown
BitMEX icon

BitMEX ACTION

Get User Wallet

Retrieve your current wallet information from BitMEX. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BitMEX account once, then configure and run Get User Wallet from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "bitmex-get-user-wallet",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bitmex: { authProvisionId: "apn_xxxxxxx" },
    currency: "Currency",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get User Wallet inputs
Property Type Description
currency Currency string
Any currency symbol, such as "XBt" or "USDt". For all currencies specify "all". Defaults to "XBt"
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
bitmex-get-user-wallet
Version
0.0.2
App
BitMEX
Authentication
API key
Read-only
Yes
Destructive
No
Open world
No