Skip to main content
POST
/
investors
/
{investor_id}
/
order-estimates
curl --request POST \ --url https://api.bluumfinance.com/v1/investors/{investor_id}/order-estimates \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data ' { "symbol": "AAPL", "side": "buy", "type": "market", "quantity": "10" } '
{
  "object": "order_estimate",
  "livemode": false,
  "id": "inv_01j9x8m2k7qpzwv3t5r6y8n0ab",
  "created": 1747776000,
  "metadata": {},
  "investor_id": "<string>",
  "symbol": "<string>",
  "currency": "USD",
  "total_estimated_value": "<string>",
  "estimated_price": "<string>",
  "estimated_quantity": "<string>",
  "commission": "<string>",
  "errors": [
    "<string>"
  ]
}

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_…).

Body

application/json
​
symbol
string
required

Ticker symbol of the asset to estimate.

Example:

"AAPL"

​
side
enum<string>
required
Available options:
buy,
sell
​
type
enum<string>
required

Only market and limit are supported. Stop, stop-limit, and trailing orders cannot be estimated via this endpoint.

Available options:
market,
limit
​
market
string

Optional market disambiguation (same as place order).

​
isin
string

Optional ISIN.

​
figi
string

Optional FIGI.

​
quantity
string

Share quantity (required for sell; for market buy, provide either quantity or notional).

Example:

"10"

​
notional
string

Dollar amount for a market buy estimate when quantity is omitted; uses the asset reference price. Not supported for sells.

Example:

"1000.00"

​
limit_price
string

Required when type is limit (with quantity).

Response

Estimate returned.

Pre-trade cost estimate from the routed custodian. Values are indicative only; execution price and fees may differ.

​
object
string
required

The resource type discriminator.

Example:

"order_estimate"

​
livemode
boolean
required

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

Example:

false

​
id
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.

​
investor_id
string
​
symbol
string
​
side
enum<string>
Available options:
buy,
sell
​
type
enum<string>
Available options:
market,
limit
​
currency
string
Example:

"USD"

​
total_estimated_value
string

Formatted total estimated value (currency precision).

​
estimated_price
string | null
​
estimated_quantity
string | null
​
commission
string | null
​
errors
string[] | null