View as Markdown
Alpaca icon

Alpaca ACTION

Cancel Order

Attempts to cancel an open order. If the order is no longer cancelable (example: status=filled), the server will reject the request, See the docs
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Alpaca account once, then configure and run Cancel Order 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: "alpaca-cancel-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    alpaca: { authProvisionId: "apn_xxxxxxx" },
    isPaperAPI: true,
    orderId: "Order Id",
  },
})

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.

Cancel Order inputs
Property Type Description
isPaperAPI Paper API boolean
Set to true if Paper API is used. Default is false.
Optional
orderId Order Id string
Order Id
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
alpaca-cancel-order
Version
0.0.3
App
Alpaca
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes