Developers › API reference › Portfolio Center

GET `/api/v1/proposals/{id}`

One proposal with its trades.

Scope pipeline:read
operationId portfolioProposal

The token needs the scope pipeline:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/proposals/{id}

Path parameters

Name	Description	Example
`id`	The id of the proposal.	`88`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/proposals/88" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/proposals/88",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/proposals/88", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: Proposal. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`account_id`	id (string)	The account's id.
`source`	string	"rebalance", "whatif" or "pipeline".
`status`	string	proposed, accepted or discarded.
`pipeline_run_id`	id (string) or null	The Intent Pipeline request it came from.
`request`	string	The request in the user's words.
`trades`	list of ProposedTrade	The proposed trades.
`trades[].symbol`	string	Ticker symbol.
`trades[].side`	string	"buy" or "sell".
`trades[].quantity`	decimal string or null	Shares, as a decimal string.
`trades[].price`	decimal string or null	Price (simulated unless the firm uploaded it).
`trades[].value`	decimal string or null	Value at the latest (simulated) closes.
`summary`	any	Totals: trades, buys, sells, estimated gain and cost.
`explanation`	string	Why these trades, in plain words.
`explanation_by_ai`	boolean	True when the AI wrote the explanation.
`created_at`	date-time or null	When it was created.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "1042",
    "account_id": "12",
    "source": "rebalance",
    "status": "proposed",
    "pipeline_run_id": null,
    "request": "Rebalance growth accounts, no gains over $25k",
    "trades": [
        {
            "symbol": "AAPL",
            "side": "buy",
            "quantity": "100",
            "price": "231.45",
            "value": "5240000.00"
        }
    ],
    "summary": {
        "trades": 4,
        "est_realized_gain": "8120.00",
        "est_cost": "84.10"
    },
    "explanation": "",
    "explanation_by_ai": false,
    "created_at": "2026-10-27T14:30:00Z"
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/proposals/88"
}

On the screens

The same thing in the app is explained in: