POST/shorts.v1alpha1.PoliticiansService/ListRegisterChanges

ListRegisterChanges

Parameters

Connect-Protocol-VersionheaderRequired

number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader

number

Define the timeout, in ms

Request Body

application/json

object

chamberstring

'house' | 'senate' (proto string)

itemNointeger <int32>

kindstring [REGISTER_CHANGE_KIND_UNSPECIFIED, REGISTER_CHANGE_KIND_ADDED, REGISTER_CHANGE_KIND_REMOVED]

UNSPECIFIED = both (proto shorts.v1alpha1.RegisterChangeKind)

limitinteger <int32>

default 100, max 500 (proto int32)

offsetinteger <int32>

(proto int32)

partyAbstring

AEC abbreviation (proto string)

politicianSlugstring

Discovery-layer filters. All optional and all ADDITIVE — the unfiltered feed is unchanged when they are left empty. canonical slug; consumers never derive one (proto string)

sincestring <date-time>

Interpreted at UTC DAY granularity: the handler truncates it to UTC midnight before it reaches either the cache key or the query, so two timestamps on the same day are one request and cannot be served each other's results. (proto google.protobuf.Timestamp)

stockCodestring

optional (proto string)

Responses

200Success

application/json

object

asAtstring <date-time>

The register's own clock: the newest lodgement we hold, never the moment we rebuilt our snapshot. (proto google.protobuf.Timestamp)

eventsarray

(proto shorts.v1alpha1.RegisterChangeEvent)

Array Items:

object

sourceLicencestring

(proto string)

totalinteger <int32>

(proto int32)

defaultError

application/json

object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:

object

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.PoliticiansService/ListRegisterChanges" \
  -H "Content-Type: application/json" \
  -d '{
  "chamber": "string",
  "itemNo": 0,
  "kind": "string",
  "limit": 0,
  "offset": 0,
  "partyAb": "string",
  "politicianSlug": "string",
  "since": "string",
  "stockCode": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.PoliticiansService/ListRegisterChanges" \
  -H "Content-Type: application/json" \
  -d '{
  "chamber": "string",
  "itemNo": 0,
  "kind": "string",
  "limit": 0,
  "offset": 0,
  "partyAb": "string",
  "politicianSlug": "string",
  "since": "string",
  "stockCode": "string"
}'