Utility

Point-in-time security identity and corporate-action carry

Which security an identifier meant on a date, and what a holding of it became by as_of through reviewed corporate actions: ticker changes and reuse, ADR conversions with their ratios, splits, spin-offs and distributions, cash mergers and bankruptcy cancellations. Identity comes from reviewed event windows first, then dated ticker aliases, then the security master's current ticker, then (for a date within seven days) today's holder; a candidate contradicted by a reviewed event window is excluded. An identifier that cannot be placed returns unavailable or ambiguous rather than a guess. Every applied event carries its SEC filing. Free while reviewed coverage is limited. No API key; rate limited to 60 requests per IP per minute.

get/identity/resolve

Request

  • Base URL: https://riskmodels.app/api
  • URL: https://riskmodels.app/api/identity/resolve
  • Auth: none required

Query parameters

identifierstring required

Ticker as written on the record, or a bw_sym_id.

as_ofstring date

Date to carry the holding to (default today); the identification date when acquired_on is absent.

acquired_onstring date

Date the position was acquired. Set it to carry the holding through corporate actions.

quantitystring

Units held on acquired_on, as an exact decimal string.

identifier_type'ticker' | 'bw_sym_id'

How to read identifier (default bw_sym_id when it starts with BW-, else ticker).

known_as_ofstring date

Reproduce the answer as it stood on this date, ignoring events learned later.

fractions'apply' | 'exact'

apply honours cash in lieu and rounding; exact returns the raw entitlement.

Response

Identity and carried holding.

schema_versionstring
status'resolved' | 'ambiguous' | 'unavailable' | 'unsupported'

unsupported: the identity resolved but the carry cannot be completed (for example a purchase between record date and distribution with no ex-date, or an election not given).

coverage'reviewed' | 'inferred' | 'unknown'

reviewed only when the identity came from reviewed events and every security in the answer appears in reviewed events.

eventsobject[]

Applied corporate-action events with dates, outputs and SEC source.

explanationstring

Example response

{
  "schema_version": "identity-resolve/1"
}

Changes

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