Portfolios

What moved among the places a portfolio holds

One entry per stored signal of a held place that a completed refresh changed since since, with the value, confidence and national decile before and after, the refresh that recorded it, and both clocks (the data's period and our recording instant). Kept when the value moved by at least threshold_pct at or above min_confidence, the confidence fell, or the decile changed. Pages follow the refresh ledger: pass next_after back as after until it is null. Re-cuts of held places are listed on the first page. No entry is produced for a place the portfolio does not hold.

get/v1/portfolios/{id}/feed

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/portfolios/{id}/feed
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Query parameters

sincestring

ISO 8601 instant within the last 30 days (history is kept 30 days); default 30 days ago.

afterinteger

The last cursor already read; omit for the first page.

limitinteger
threshold_pctnumber
min_confidencenumber
causestring

List only entries with these causes, comma separated: source, method, source_and_method. Default every cause.

Response

Default Response

portfolio_idstring required
sincestring date-time required
threshold_pctnumber required
min_confidencenumber required
causesstring[] required
places_heldinteger required
areas_without_placeinteger required
next_afterinteger required
complete_throughstring date-time required
notesstring[] required

Changes