Wealthnow
Sign up

API ReferenceExecution & Research

Status

Score for your portfolio

POST/api/v3/research/portfolio_aware_score
Plan
Pro and up
Price
4 credits per call
MCP tool
research_portfolio_aware_score

Adjusts a candidate's standalone score for the user's portfolio. Send the candidate's standalone score (e.g. from the copilot score tool) and the user's holdings; the answer is the overlay: concentration_penalty (single-name cap, default 15%), sector_cap_penalty (GICS sector cap, default 30%), correlation_to_existing (top 5 holdings by |rho|), tax_lot_warnings (short-term gains, from each holding's purchase_date), and a rebalance_recommendation (action swap, trim_only, buy_naked or hold_no_add, with sell/buy/sector blocks). total_penalty multiplies the standalone score down to portfolio_aware_score. Use it only when you have the user's holdings.

Request body

application/json, required.

tickerstringRequired

Candidate ticker.

user_holdingsarray of objectRequired

Current positions; weights sum to at most 100.

user_holdings[].tickerstringRequired
user_holdings[].weight_pctnumberRequired

Percent of the portfolio (8.2 = 8.2%)

Range0 to …
user_holdings[].cost_basisnumber or nullOptional

Cost basis, USD per share.

user_holdings[].purchase_datestring or nullOptional

YYYY-MM-DD; flags a short-term tax lot.

user_holdings[].sectorstring or nullOptional

Optional GICS sector hint.

standalone_scoreobjectRequired

The candidate's standalone score, e.g. from the copilot score tool.

standalone_score.decileintegerRequired
Range1 to 10
standalone_score.scorenumberRequired
Range0 to 1
standalone_score.verdict_labelstring or nullOptional
cash_pctnumber or nullOptional

Cash, percent of the portfolio; accepted, not used by the overlay.

Range0 to …
total_portfolio_valuenumber or nullOptional

Portfolio value, USD; accepted, not used by the overlay.

Range0 to …
capsobject or nullOptional

Override the default risk caps.

caps.single_name_pctnumber or nullOptional

Single-name cap, percent (default 15)

caps.sector_pctnumber or nullOptional

Sector cap, percent (default 30)

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Execution & Research). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.

A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed.
401 unauthorizedMissing or invalid API key.
402 plan_requiredYour plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed.
403 scope_deniedThis API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed.
404 not_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe request ran past the server's time budget; retry. Not billed.

This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.

Guides

Read the Execution & Research guide for this endpoint's fields and examples.