---
title: "Enrich portfolio"
method: POST
path: "/v1/portfolios/{id}/enrich"
tags: ["Portfolios"]
---

# Enrich portfolio

`POST /v1/portfolios/{id}/enrich`

## Request

- Base URL: `https://api.onegoodarea.com`
- URL: `https://api.onegoodarea.com/v1/portfolios/{id}/enrich`
- Auth: HTTP bearer

Bulk-score every area in the portfolio.

## Path parameters

- `id` string, required

## Request body

- object
  - `preset` 'moving' | 'business' | 'investing' | 'research'

## Response `200`

Default Response

- object
  - `count` number, required
  - `results` object[], required
    - `area` string, required
    - `label` string, required
    - `score` object, required
      - `area` string, required
      - `preset` string, required
      - `score` number, required
      - `area_type` 'urban' | 'suburban' | 'rural', required
      - `rural_urban` string, required
      - `dimensions` object[], required
        - `key` string, required
        - `label` string, required
        - `score` number, required
        - `weight` number, required
        - `confidence` number, required
        - `reasoning` string, required
        - `confidence_reason` string, required
      - `confidence` number, required
      - `weights_source` 'preset' | 'custom', required
      - `reference` union, required
        - object
          - `kind` 'band', required
          - `band` 'urban' | 'suburban' | 'rural', required
        - object
          - `kind` 'cohort', required
          - `slug` string, required
          - `name` string, required
          - `areas` integer, required
        - object
          - `kind` 'national', required
          - `scope` 'GB', required
          - `reason` 'area_type_unavailable', required
      - `engine_version` string, required
      - `summary` string
      - `recommendations` string[]
      - `data_sources` string[]
    - `error` string, required

## Other responses

- `400`: Default Response
- `404`: Default Response
- `500`: Default Response

---

[API](https://skmtc.dev/onegoodarea/apis/onegoodarea-api.md) · [All operations](https://skmtc.dev/onegoodarea/apis/onegoodarea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onegoodarea/apis/onegoodarea-api/revisions/b318d28b3412?raw)