List voluntary corporate actions

List the voluntary corporate action offers the given account is
entitled to.

An offer is returned while the account has either an eligible position
in it or a non-terminal election or withdrawal against it. Offers where
both are absent are never returned.

A closed position therefore does not remove an offer you still have an
election on. That matters: the offer is where reply_by_deadline and
withdrawals_permitted live, and you still need both after your
position in the security has gone.

Sorted by reply_by_deadline ascending, then corporate_action_id.
Offers with no published reply_by_deadline sort last, after every
dated offer, and are excluded by the reply_by_deadline_from and
reply_by_deadline_to filters — an undated offer satisfies no range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

The account ID or account number.

Query Params
offer_status
array of objects

Filter to offers in any of the given states. Repeat the parameter to supply more than one. A value this service does not recognise matches nothing rather than being rejected.

offer_status
string

Filter to offers of this event type. A value this service does not recognise matches nothing rather than being rejected.

string
length between 9 and 9

Filter to offers on this CUSIP.

string
length between 1 and 32

Filter to offers on this symbol. Matches Clear Street's canonical symbol, and falls back to the announcement ticker for offers whose instrument could not be resolved.

int64
0 to 2900000000000

Lower bound, inclusive, on the account's resolved reply-by deadline.

int64
0 to 2900000000000

Upper bound, inclusive, on the account's resolved reply-by deadline.

int64
0 to 2900000000000

Inclusive lower bound on updated_at. Returns every record touched at or after this instant, including changes Clear Street operations made rather than you. This is the parameter to poll on: created_at never changes, so filtering on it will not surface a status transition.

A record may be returned again on a later poll; deduplicate on the record's own identifier together with updated_at.

int32
1 to 1000
Defaults to 25

Number of records to return per page.

string
length between 1 and 2048

Opaque cursor returned as next_page_token from a previous page. Omit to fetch the first page.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json