Cancel an open order - Bluum Finance

{ "object": "investor", "livemode": false, "id": "inv_01j9x8m2k7qpzwv3t5r6y8n0ab", "created": 1747776000, "metadata": {}, "investor_id": "inv_01j9x8m2k7qpzwv3t5r6y8n0ab", "symbol": "AAPL", "class": "equity", "currency": "USD", "quantity": "5", "notional": "1000.00", "limit_price": "<string>", "stop_price": "<string>", "trail_percent": "<string>", "trail_price": "<string>", "extended_hours": true, "client_order_id": "<string>", "status": "pending", "filled_quantity": "0", "remaining_quantity": "5", "average_price": "<string>", "commission": "<string>", "submitted_at": "2023-11-07T05:31:56Z", "filled_at": "2023-11-07T05:31:56Z", "cancelled_at": "2023-11-07T05:31:56Z", "failure_reason": "<string>", "settlement_date": "2026-05-22", "bond": { "clean_price": "99.875", "dirty_price": "100.342", "accrued_interest": "0.467", "face_value": "10000", "yield_at_execution": "0.0475" } }

Authorizations

Authorization

string

header

required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Path Parameters

investor_id

string

required

Prefixed public id of the investor (e.g. inv_…).

order_id

string

required

Prefixed public id of the order (e.g. ord_…).

Response

Order cancellation requested.

Trading order resource. Flat shape: quantity not qty, failure_reason not reject_reason, investor_id not account_id, Bluum-native status vocab. The envelope created field is the canonical creation timestamp; submitted_at mirrors when the order was submitted to the custodian (null until submission).

object

string

required

The resource type discriminator.

Example:

"investor"

livemode

boolean

required

Whether this resource was created against a live API key. Test-mode keys always return false.

Example:

false

string

Prefixed public id (e.g. inv_…, ord_…, dep_…).

Example:

"inv_01j9x8m2k7qpzwv3t5r6y8n0ab"

created

integer | null

Unix-seconds timestamp of resource creation.

Example:

1747776000

metadata

object

Partner-set key/value map for cross-referencing.

Show child attributes

investor_id

string

Prefixed public id of the investor.

Example:

"inv_01j9x8m2k7qpzwv3t5r6y8n0ab"

symbol

string

Example:

"AAPL"

class

string

Asset class name (e.g. equity, bond, etf).

Example:

"equity"

currency

string

Example:

"USD"

quantity

string

Quantity of shares ordered (for quantity-based orders).

Example:

"5"

notional

string

Notional amount ordered (for notional-based orders).

Example:

"1000.00"

side

enum<string>

Available options:

buy,

sell

type

enum<string>

Available options:

market,

limit,

stop,

stop_limit,

trailing_stop

time_in_force

enum<string>

FIX-standard time-in-force; not Alpaca-coined.

Available options:

day,

gtc,

opg,

cls,

ioc,

fok

limit_price

string

stop_price

string

trail_percent

string

trail_price

string

extended_hours

boolean

client_order_id

string

status

enum<string>

Bluum-native order status.

Available options:

pending,

filled,

partial,

cancelled,

failed

Example:

"pending"

filled_quantity

string

Example:

"0"

remaining_quantity

string

Example:

"5"

average_price

string

commission

string

commission_type

enum<string>

Available options:

notional,

per_share,

bps

submitted_at

string<date-time> | null

When the order was submitted to the custodian. Null until submission.

filled_at

string<date-time> | null

cancelled_at

string<date-time> | null

failure_reason

string | null

settlement_date

string<date> | null

Settlement date Alpaca will use for bond orders, when known. Bluum does not specify or override this — Alpaca chooses based on the bond's subtype. Null for non-bond orders or until Alpaca confirms.

Example:

"2026-05-22"

bond

object

Fixed-income execution detail. Populated only when the underlying asset is a bond. Prices are % of par; accrued and face_value are in currency.

Show child attributes