Data & Analytics

Read active eligibility publication changes

A bounded, cursor-paginated active-publication incremental feed for cache invalidation. Each row names the immutable publication id, ruleset hash, activation time, institution, prior publication when present, and created/confirmed/retained rule counts. This is not a historical audit trail: publications superseded between polls are outside its scope. It does not expose person facts or imply a change in any person's eligibility.

Authentication required: Pass your API key in the X-API-Key header.

get/v1/eligibility/changes

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/v1/eligibility/changes
  • Auth: API key in header X-API-Key

Query parameters

sincestring date-time required

Exclusive activation-time boundary.

cursorstring

Opaque URL-safe cursor returned by the prior page.

limitinteger

Maximum publication changes returned in this page.

Response

Ordered active-publication changes after the requested boundary.

sincestring date-time required

Echo of the exclusive activation-time boundary used for this traversal.

changesobject[] required

Active publication replacements ordered by activation time and immutable publication id.

returnedinteger required

Number of change rows in this response page.

has_moreboolean required

Whether another page exists after the final returned change.

next_cursorstring nullable

Opaque cursor for the next page, or null when this page is complete.

semanticsstring required

Active-publication replacement semantics; the feed is not a historical person verdict.

disclosurestring required

Required explanation of the feed's scope and safe use.

Changes

No recorded changes to this operation across all 1 revision of this API.