Developers › API reference › Portfolio Center

GET `/api/v1/accounts/{id}/drift`

Drift against the account's model.

Scope portfolio:read
operationId portfolioDrift

The token needs the scope portfolio: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/accounts/{id}/drift

Path parameters

Name	Description	Example
`id`	The id of the account.	`12`

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/accounts/12/drift" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/accounts/12/drift",
    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/accounts/12/drift", {
  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: Drift. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`account_id`	id (string)	The account's id.
`model_id`	id (string) or null	The account's model portfolio (null: none).
`tolerance_pct`	decimal string or null	The model's drift tolerance, in points.
`out_of_tolerance`	boolean	True when any line drifts beyond the tolerance.
`data`	list of DriftLine	The records of this page or list.
`data[].symbol`	string	Ticker symbol.
`data[].target_pct`	decimal string or null	Target weight, in percent.
`data[].actual_pct`	decimal string or null	The holding's actual weight in the account, in percent.
`data[].drift_pct`	decimal string or null	Actual minus target, in percentage points.

Example response

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

{
    "account_id": "12",
    "model_id": "1",
    "tolerance_pct": "1.50",
    "out_of_tolerance": true,
    "data": [
        {
            "symbol": "NVDA",
            "target_pct": "5.00",
            "actual_pct": "7.40",
            "drift_pct": "2.40"
        },
        {
            "symbol": "JNJ",
            "target_pct": "4.00",
            "actual_pct": "2.80",
            "drift_pct": "-1.20"
        }
    ]
}

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/accounts/12/drift"
}

On the screens

The same thing in the app is explained in: