View as Markdown
BitMEX icon

BitMEX ACTION

List Trades

Retrieve a list of executed trades from your BitMEX account. 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 List Trades 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-list-trades",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bitmex: { authProvisionId: "apn_xxxxxxx" },
    filter: "Filter",
    symbol: "Symbol",
  },
})

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.

List Trades inputs
Property Type Description
filter Filter object
Generic table filter. Send JSON key/value pairs, such as {"execType": ["Settlement", "Trade"]} to filter on multiple values. For explanations on filters refer to http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_8_8.html
Optional
symbol Symbol string
Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. XBT:quarterly. Timeframes are nearest, daily, weekly, monthly, quarterly, biquarterly, and perpetual. Symbols are case-insensitive.
Optional Dynamic
columns Columns string[]
Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Optional
count Count integer
Number of results to fetch. Must be a positive integer. Defaults to 100
Optional
start Start integer
Starting point for results. Defaults to 0
Optional
reverse Reverse boolean
If true, will sort results newest first. Defaults to false
Optional
startTime Start Time string
Starting date filter for results (format: YYYY-MM-DDTHH:mm:ss.sssZ)
Optional
endTime End Time string
Ending date filter for results (format: YYYY-MM-DDTHH:mm:ss.sssZ)
Optional
targetAccountId Target Account ID integer
AccountId fetching the trade history, must be a paired account with main user
Optional
targetAccountIds Target Account IDs string
AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user
Optional

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-list-trades
Version
0.0.2
App
BitMEX
Authentication
API key
Read-only
Yes
Destructive
No
Open world
No